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

最近更新时间: 2026-09-17 00:03:59

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.cn。

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

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGatewayAllGroupApis
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayDeployGroupId	是	否	String	网关部署组ID 示例值：
SearchWord	否	否	String	搜索关键字，支持分组名称或API Path 示例值：

3. 输出参数

参数名称	类型	描述
Result	GatewayVo	网关分组和API列表信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

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

输入示例

https://tsf.api3.<no value>/?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"
                        }
                    ]
                }
            ]
        }
    }
}