查询API分组下的Api列表信息

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

1. 接口描述

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

查询API分组下的Api列表信息

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGatewayApis
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId	是	否	String	分组ID 示例值：
SearchWord	否	否	String	搜索关键字，支持 API path 示例值：
Offset	是	否	Int64	翻页偏移量示例值：
Limit	是	否	Int64	每页的记录数示例值：
GatewayDeployGroupId	否	否	String	部署组ID 示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageApiDetailInfo	翻页结构示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.GatewayDbError	网关数据异常。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

示例1 查询API分组下的Api列表信息

输入示例

https://tsf.api3.<no value>/?Action=DescribeGatewayApis
&GroupId=grp-5yk7oor1
&GatewayDeployGroupId=group-e42d597
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "5d996e5507e42d5970cd2e25ed5267a",
        "Result": {
             "TotalCount": 30,
             "Content": [
                 {
                    "UpdatedTime": "2021-03-17 10:44:27", 
                    "PathMapping": "/pd/v1/echo", 
                    "MicroserviceName": "服务名称", 
                    "Description": "描述", 
                    "MicroserviceId": "服务ID", 
                    "NamespaceName": "命名空间名称", 
                    "ApiId": "api-d5970cd2", 
                    "UsableStatus": "enabled", 
                    "ApiType": "ms", 
                    "ReleaseStatus": "released", 
                    "GroupName": "分组名称", 
                    "Host": "xx", 
                    "Method": "POST", 
                    "RateLimitStatus": "disabled", 
                    "Timeout": 0, 
                    "NamespaceId": "命名空间ID", 
                    "CreatedTime": "2021-03-17 10:44:27", 
                    "Path": "/provider-demo/v1/echo", 
                    "ReleasedTime": "2021-03-17 10:44:27", 
                    "MockStatus": "disabled", 
                    "GroupId": "grp-ib3xchsw"
                 }
             ]
        }
    }
}