查询API详情

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

1. 接口描述

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

查询API详情

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeApiDetail
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
MicroserviceId	是	否	String	微服务id 示例值：
Path	是	否	String	请求路径示例值：
Method	是	否	String	请求方法示例值：
PkgVersion	是	否	String	包版本示例值：
ApplicationId	是	否	String	应用ID 示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.ApiMetaParseFailed	API元数据解析失败。
FailedOperation.ServiceQueryFailed	服务查询失败。
ResourceNotFound.ServiceNotExist	无法获取服务，无法执行该操作。
MissingParameter.RequiredParameterMissing	%s缺失。
FailedOperation.ServiceInsertFailed	服务数据库入库失败。

5. 示例

示例1 查询API详情

输入示例

https://tsf.api3.<no value>/?Action=DescribeApiDetail
&MicroserviceId=ms-2vzprpyp
&Path=/facade/supplier/test
&Method=POST
&ApplicationId=application-gvkw2ejv
&PkgVersion=jenkins-prod-supplier-1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "b8427f00-c974-47b1-9827-978cdb043b9d",
    "Result": {
      "Request": [
        {
          "Name": "supplierId",
          "Type": "string",
          "Description": "supplierId",
          "Required": true,
          "In": "query"
        }
      ],
      "Response": [
        {
          "Name": "Res\u00abSupplier\u00bb",
          "Type": "#/Definitions/Res\u00abSupplier\u00bb",
          "Description": "OK"
        }
      ],
      "Definitions": [
        {
          "Name": "Supplier",
          "Properties": [
            {
              "Name": "abbrName",
              "Type": "string"
            },
            {
              "Name": "coordinatesSystem",
              "Type": "integer(int32)"
            },
            {
              "Name": "createTime",
              "Type": "string(date-time)"
            },
            {
              "Name": "id",
              "Type": "string"
            },
            {
              "Name": "invoiceLineNum",
              "Type": "integer(int32)"
            },
            {
              "Name": "invoiceMaxFee",
              "Type": "integer(int64)"
            },
            {
              "Name": "invoiceMinFee",
              "Type": "integer(int64)"
            },
            {
              "Name": "invoiceType",
              "Type": "integer(int32)"
            },
            {
              "Name": "isActive",
              "Type": "integer(int32)"
            },
            {
              "Name": "isTripEnable",
              "Type": "integer(int32)"
            },
            {
              "Name": "logo",
              "Type": "string"
            },
            {
              "Name": "name",
              "Type": "string"
            },
            {
              "Name": "priceRuleUrl",
              "Type": "string"
            },
            {
              "Name": "servicePhone",
              "Type": "string"
            },
            {
              "Name": "signKey",
              "Type": "string"
            },
            {
              "Name": "updateTime",
              "Type": "string(date-time)"
            }
          ]
        },
        {
          "Name": "Res\u00abSupplier\u00bb",
          "Properties": [
            {
              "Name": "code",
              "Type": "integer(int32)"
            },
            {
              "Name": "data",
              "Type": "#/Definitions/Supplier"
            },
            {
              "Name": "errmsg",
              "Type": "string"
            },
            {
              "Name": "success",
              "Type": "boolean"
            }
          ]
        }
      ]
    }
  }
}