查询服务API列表

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

1. 接口描述

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

查询服务API列表

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

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

接口只验签名不鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.ServiceQueryFailed	服务查询失败。
ResourceNotFound.ServiceNotExist	无法获取服务，无法执行该操作。
MissingParameter.RequiredParameterMissing	%s缺失。
FailedOperation.ServiceInsertFailed	服务数据库入库失败。
InternalError.UnhandledException	[%s]模块未处理异常。。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。

5. 示例

示例1 查询服务API列表

查询微服务API列表

输入示例

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

{
  "MicroserviceId": "ms-y5w8n5e9",
  "SearchWord": "echo-feign-url",
  "Limit": 10,
  "Offset": 0
}

输出示例

{
  "Response": {
    "RequestId": "17a35767-819f-4683-bc3f-5430e6d4513f",
    "Result": {
      "Content": [
        {
          "Description": "",
          "Method": "GET",
          "MsgwApiType": null,
          "Path": "/echo-feign-url/{str}",
          "RpcType": "http",
          "Status": 1
        }
      ],
      "TotalCount": 1
    }
  }
}