批量导入API至api分组
最近更新时间: 2026-10-11 00:12:04
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
批量导入API至api分组(也支持新建API到分组)
默认接口请求频率限制:10000次/秒。
接口更新时间:2026-03-12 21:00:16。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateGatewayApi |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GroupId | 是 | 否 | String | API 分组ID 示例值: grp-djvzrdih |
| ApiList | 是 | 否 | Array of ApiInfo | Api信息 示例值:查看 |
| ProgramIdList | 否 | 否 | Array of String | 无 示例值: [ "program-6a79x94v" ] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 是否成功 示例值: true |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation.LicenseUnauthorized | 您所购买的服务不支持该操作。 |
| InvalidParameterValue.GatewayParameterInvalid | 无效请求参数:%s。 |
| MissingParameter.GatewayParameterRequired | 缺少请求参数:%s。 |
| InternalError.GatewayDbError | 网关数据异常。 |
| UnsupportedOperation.GatewayTooManyRequestParameter | 批量操作数量超过限制:%s。 |
5. 示例
示例1 批量导入API至api分组
输入示例
POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: CreateGatewayApi
<Common Parameters>
{
"GroupId": "grp-djvzrdih",
"ApiList": [
{
"NamespaceId": "namespace-external",
"MicroserviceId": "ms-external",
"Path": "/echo_user",
"Method": "GET",
"PathMapping": "/echo_user",
"Host": "http://www.mycloud.com",
"Description": "This is desc",
"RpcExt": "{\"shortServiceName\":\"personservice\",\"interfaceName\":\"com.tsf.tsf.atom.alibaba.dubbo.PersonService\",\"methodName\":\"complexCondition\",\"parameterTypes\":\"byte,short,int,long,float,double,boolean,char,java.lang.Integer,java.util.List<java.lang.Integer>,java.util.List<java.lang.Object>,java.util.List,java.util.Collection<java.lang.Integer>,java.lang.Integer[],java.lang.Object\",\"group\":null,\"version\":\"1.0\",\"loadbalance\":null,\"retries\":null,\"timeout\":null,\"protocol\":\"dubbo\",\"url\":null}",
"RpcType": "http",
"Md5": "1fd35524030bebc48e0f51a3a7fe6737"
}
],
"ProgramIdList": [
"program-6a79x94v"
]
}
输出示例
{
"Response": {
"RequestId": "e521be92-af1e-4d1c-bcd9-31bfe1ff0859",
"Result": true
}
}