创建API分组

最近更新时间:2024-03-12 02:00:10

我的收藏

1. 接口描述

接口请求域名: tsf.tencentcloudapi.com 。

创建API分组

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateApiGroup。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
GroupName String 分组名称, 不能包含中文
示例值:zuul_test_group
GroupContext String 分组上下文
示例值:%2Fuser
AuthType String 鉴权类型。secret: 密钥鉴权; none:无鉴权
示例值:none
Description String 备注
示例值:test
GroupType String 分组类型,默认ms。 ms: 微服务分组; external:外部Api分组
示例值:ms
GatewayInstanceId String 网关实体ID
示例值:gw-ins-fsdfs000
NamespaceNameKey String 命名空间参数key值
示例值:TSF-NamespaceName
ServiceNameKey String 微服务名参数key值
示例值:TSF-ServiceName
NamespaceNameKeyPosition String 命名空间参数位置,path,header或query,默认是path
示例值:path
ServiceNameKeyPosition String 微服务名参数位置,path,header或query,默认是path
示例值:path

3. 输出参数

参数名称 类型 描述
Result String API分组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:grp-12345678
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建API分组

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApiGroup
<公共请求参数>

{
    "GroupName": "zuul_test_group",
    "GroupContext": "%2Fuser",
    "AuthType": "none",
    "Description": "test",
    "NamespaceNameKey": "TSF-NamespaceName",
    "ServiceNameKey": "TSF-ServiceName",
    "NamespaceNameKeyPosition": "path",
    "ServiceNameKeyPosition": "path"
}

输出示例

{
    "Response": {
        "RequestId": "5d996e05507e42d5970cd2e25ed5267a",
        "Result": "grp-12345678"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.GatewayDbError 网关数据异常。
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。
MissingParameter.GatewayParameterRequired 缺少请求参数:%s。
UnauthorizedOperation.LicenseUnauthorized 您所购买的服务不支持该操作。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。