微服务平台 TSF 查询网关所有分组下Api列表-API 文档-文档中心-腾讯云

1. 接口描述

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

查询网关所有分组下Api列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeGatewayAllGroupApis。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
GatewayDeployGroupId	是	String	网关部署组ID
SearchWord	否	String	搜索关键字，支持分组名称或API Path

3. 输出参数

参数名称	类型	描述
Result	GatewayVo	网关分组和API列表信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询网关下分组和API

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeGatewayAllGroupApis
&GatewayDeployGroupId=group-zbyxk4aa
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "0a1c8ed2-7a69-4a12-87f0-a6ca4b6419f8",
        "Result": {
            "GatewayDeployGroupId": "group-zbyxk4aa",
            "GatewayDeployGroupName": "sean-test",
            "GroupNum": 1,
            "Groups": [
                {
                    "GroupId": "grp-aocm2u1n",
                    "GroupName": "test",
                    "GroupApiCount": 3,
                    "GroupApis": [
                        {
                            "ApiId": "api-3bpjclfs",
                            "Path": "/v1/user/{userId}",
                            "Method": "POST",
                            "MicroserviceName": "provider-demo",
                            "NamespaceName": "test-ns2"
                        },
                        {
                            "ApiId": "api-5lf5r4i3",
                            "Path": "/v1/user/create/user",
                            "Method": "POST",
                            "MicroserviceName": "provider-demo",
                            "NamespaceName": "test-ns"
                        },
                        {
                            "ApiId": "api-3e1583de",
                            "Path": "/echo/{param}",
                            "Method": "GET",
                            "MicroserviceName": "provider-demo",
                            "NamespaceName": "test-ns"
                        }
                    ]
                }
            ]
        }
    }
}

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. 错误码

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

错误码	描述
FailedOperation.GatewayRemoteCallError	远端访问错误: %s。
InvalidParameterValue.DeployGroupNotExists	部署组不存在。
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。