微服务平台 TSF 批量导入API至api分组-微服务网关相关接口-API 中心-腾讯云

1. 接口描述

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

批量导入API至api分组(也支持新建API到分组)

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateGatewayApi。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
GroupId	是	String	API 分组ID 示例值：grp-djvzrdih
ApiList.N	是	Array of ApiInfo	Api信息示例值：[{"NamespaceId":"namespace-external","MicroserviceId":"ms-external","Path":"/echo_user","Method":"GET","PathMapping":"/echo_user","Host":"http://www.qq.com","Description":"This is desc","RpcExt":"{"shortServiceName":"personservice","interfaceName":"com.tencent.tsf.atom.example.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.N	否	Array of String	无示例值：["program-6a79x94v"]

3. 输出参数

参数名称	类型	描述
Result	Boolean	是否成功示例值：true
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量导入API至api分组

输入示例

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

{
    "GroupId": "grp-djvzrdih",
    "ApiList": [
        {
            "NamespaceId": "namespace-external",
            "MicroserviceId": "ms-external",
            "Path": "/echo_user",
            "Method": "GET",
            "PathMapping": "/echo_user",
            "Host": "http://www.qq.com",
            "Description": "This is desc"
        }
    ],
    "ProgramIdList": [
        "program-6a79x94v"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "e521be92-af1e-4d1c-bcd9-31bfe1ff0859",
        "Result": true
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.GatewayDbError	网关数据异常。
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
UnauthorizedOperation.LicenseUnauthorized	您所购买的服务不支持该操作。
UnsupportedOperation.GatewayTooManyRequestParameter	批量操作数量超过限制:%s。

批量导入API至api分组

本页目录：