查询服务API列表

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

1. 接口描述

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

查询服务API列表

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

接口更新时间：2025-08-28 19:26:48。

接口既验签名又鉴权。

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

输入示例

https://tsf.api3.<no value>/?Action=DescribeMsApiList
&Offset=0
&Limit=20
&MicroserviceId=ms-opy5kjy4
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "056cc966-4963-4506-ac4c-c4e7209a41e3",
    "Result": {
      "TotalCount": 4,
      "Content": [
        {
          "Path": "/echo-async-rest/{str}",
          "Method": "GET",
          "Description": "(\u65e0)"
        },
        {
          "Path": "/echo-rest/{str}",
          "Method": "GET",
          "Description": "(\u65e0)"
        },
        {
          "Path": "/user-feign",
          "Method": "GET",
          "Description": "(\u65e0)"
        },
        {
          "Path": "/echo-feign/{str}",
          "Method": "GET",
          "Description": "(\u65e0)"
        }
      ]
    }
  }
}