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

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

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

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

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

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

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列表信息

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeGatewayApis
<Common Parameters>

{
  "GroupId": "grp-nb08ur29",
  "SearchWord": "/swagger",
  "Offset": 0,
  "Limit": 5,
  "GatewayDeployGroupId": "group-yd3b588a",
  "ReleaseStatus": "released"
}

输出示例

{
  "Response": {
    "RequestId": "223e1309-700b-47be-bbc6-cddcc510ece4",
    "Result": {
      "Content": [
        {
          "ApiId": "api-1eqe6556",
          "ApiMatchType": "normal",
          "ApiType": "ms",
          "CreatedTime": "2024-12-23 01:29:41",
          "Description": null,
          "GatewayDeployGroupId": null,
          "GroupId": "grp-nb08ur29",
          "GroupName": null,
          "Host": null,
          "Md5": "c35e5178b28d1844054982d61481912e",
          "Method": "GET",
          "MicroserviceId": "ms-ba2jlxvk",
          "MicroserviceName": "provider-demo",
          "MockStatus": "disabled",
          "NamespaceId": "namespace-qab7bq9v",
          "NamespaceName": "shedfree_default",
          "Path": "/swagger/getMessageBoxAddress",
          "PathMapping": null,
          "RateLimitStatus": null,
          "ReleaseStatus": "released",
          "ReleasedTime": null,
          "RpcExt": null,
          "RpcType": "http",
          "Timeout": null,
          "UpdatedTime": "2024-12-23 01:30:03",
          "UsableStatus": "enabled"
        }
      ],
      "TotalCount": 7
    }
  }
}