查询API详情

最近更新时间:2024-12-27 11:24:12

我的收藏

1. 接口描述

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

查询API详情

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApiDetail。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
MicroserviceId String 微服务id
示例值:ms-y5w8n5e9
Path String 请求路径
示例值:/user-feign
Method String 请求方法
示例值:GET
PkgVersion String 包版本
示例值:20210625192924
ApplicationId String 应用ID
示例值:application-yn3zdj9v

3. 输出参数

参数名称 类型 描述
Result ApiDetailResponse API 详情
示例值:{"CanRun":true,"Definitions":[{"Name":"","Properties":[{"Description":"","Name":"","Type":""}]}],"Description":"feignMeshUser","MsgwApiType":"Normal","Request":[{"DefaultValue":null,"Description":"tagName","In":"query","Name":"tagName","Required":false,"Type":"string"},{"DefaultValue":null,"Description":"tagValue","In":"query","Name":"tagValue","Required":false,"Type":"string"}],"RequestContentType":null,"Response":[{"Description":"OK","Name":"_RESPONSE","Type":"string"}],"Status":1}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询API详情

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiDetail
<公共请求参数>

{
    "MicroserviceId": "ms-y5w8n5e9",
    "Path": "/user-feign",
    "Method": "GET",
    "PkgVersion": "20210625192924",
    "ApplicationId": "application-yn3zdj9v"
}

输出示例

{
    "Response": {
        "RequestId": "93c8e28a-196e-46a3-b903-b74ddcf7ce26",
        "Result": {
            "CanRun": true,
            "Definitions": [
                {
                    "Name": "",
                    "Properties": [
                        {
                            "Description": "",
                            "Name": "",
                            "Type": ""
                        }
                    ]
                }
            ],
            "Description": "feignMeshUser",
            "Request": [
                {
                    "DefaultValue": null,
                    "Description": "tagName",
                    "In": "query",
                    "Name": "tagName",
                    "Required": false,
                    "Type": "string"
                },
                {
                    "DefaultValue": null,
                    "Description": "tagValue",
                    "In": "query",
                    "Name": "tagValue",
                    "Required": false,
                    "Type": "string"
                }
            ],
            "RequestContentType": null,
            "Response": [
                {
                    "Description": "OK",
                    "Name": "_RESPONSE",
                    "Type": "string"
                }
            ],
            "Status": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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