创建API分组

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

创建API分组

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

接口更新时间:2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:CreateApiGroup
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupType 否 否 String 分组类型,默认ms。 ms: 微服务分组; external:外部Api分组
示例值:
NamespaceNameKeyPosition 否 否 String 命名空间参数位置,path,header或query,默认是path
示例值:
GroupContext 是 否 String 分组上下文
示例值:
AuthType 否 否 String 鉴权类型。secret: 密钥鉴权; none:无鉴权
示例值:
GatewayInstanceId 否 否 String 网关实体ID
示例值:
NamespaceNameKey 否 否 String 命名空间参数key值
示例值:
ServiceNameKey 否 否 String 微服务名参数key值
示例值:
ServiceNameKeyPosition 否 否 String 微服务名参数位置,path,header或query,默认是path
示例值:
GroupName 是 否 String 分组名称, 不能包含中文
示例值:
Description 否 否 String 备注
示例值:

3. 输出参数

参数名称 类型 描述
Result String API分组ID
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 创建API分组

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: CreateApiGroup
<Common Parameters>

{
  "GroupName": "grp_user",
  "GroupContext": "/grp_user",
  "AuthType": "none",
  "Description": "This is desc",
  "GroupType": "ms",
  "GatewayInstanceId": "gw-ins-szesmg28",
  "NamespaceNameKey": "TSF-NamespaceName",
  "ServiceNameKey": "TSF-ServiceName",
  "NamespaceNameKeyPosition": "path",
  "ServiceNameKeyPosition": "path"
}

输出示例

{
  "Response": {
    "RequestId": "156db4f2-9d4e-48bc-87eb-539a46919107",
    "Result": "grp-rzn41l1w"
  }
}