查询API详情

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

查询API详情

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询API详情

输入示例

https://tsf.tencentcloudapi.com/?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«Supplier»",
                    "Type": "#/Definitions/Res«Supplier»",
                    "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«Supplier»",
                    "Properties": [
                        {
                            "Name": "code",
                            "Type": "integer(int32)"
                        },
                        {
                            "Name": "data",
                            "Type": "#/Definitions/Supplier"
                        },
                        {
                            "Name": "errmsg",
                            "Type": "string"
                        },
                        {
                            "Name": "success",
                            "Type": "boolean"
                        }
                    ]
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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