应用使用者查询API详情

1. 接口描述

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

本接口（DescribeApiForApiApp）用于应用使用者查询部署于 API 网关的 API 接口的详细信息。​

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 DescribeApiForApiApp

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeApiForApiApp
&ServiceId=service-ody35h5e
&ApiId=api-3v4tzy3u
&ApiRegion=ap-guangzhou
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "EnableCORS": false,
            "ServiceDesc": "xx",
            "RequestParameters": [
                {
                    "Name": "xx",
                    "DefaultValue": "xx",
                    "Required": true,
                    "Position": "xx",
                    "Type": "xx",
                    "Desc": "xx"
                }
            ],
            "InternalDomain": "xx",
            "RequestConfig": {
                "Path": "xx",
                "Method": "xx"
            },
            "ServiceWebsocketRegisterFunctionQualifier": "xx",
            "MicroServices": [
                {
                    "MicroServiceName": "xx",
                    "ClusterId": "xx",
                    "NamespaceId": "xx"
                }
            ],
            "ServiceWebsocketRegisterFunctionNamespace": "xx",
            "CreatedTime": "2020-09-22T00:00:00+00:00",
            "ConstantParameters": [
                {
                    "Position": "xx",
                    "DefaultValue": "xx",
                    "Name": "xx",
                    "Desc": "xx"
                }
            ],
            "ServiceTsfLoadBalanceConf": {
                "SessionStickRequired": true,
                "IsLoadBalance": true,
                "SessionStickTimeout": 0,
                "Method": "xx"
            },
            "ServiceWebsocketTransportFunctionNamespace": "xx",
            "ServiceScfFunctionQualifier": "xx",
            "ServiceScfIsIntegratedResponse": true,
            "ServiceWebsocketTransportFunctionName": "xx",
            "ResponseSuccessExample": "xx",
            "ServiceConfig": {
                "Product": "xx",
                "UniqVpcId": "xx",
                "Url": "xx",
                "UpstreamId": "xx",
                "Path": "xx",
                "Method": "xx"
            },
            "Tags": [
                {
                    "Value": "xx",
                    "Key": "xx"
                }
            ],
            "ServiceParameters": [
                {
                    "RelevantRequestParameterPosition": "xx",
                    "Name": "xx",
                    "RelevantRequestParameterDesc": "xx",
                    "DefaultValue": "xx",
                    "RelevantRequestParameterName": "xx",
                    "Position": "xx"
                }
            ],
            "ServiceScfFunctionNamespace": "xx",
            "ServiceWebsocketRegisterFunctionName": "xx",
            "ServiceWebsocketTransportFunctionQualifier": "xx",
            "IsDebugAfterCharge": false,
            "ApiBusinessType": "xx",
            "ApiName": "xx",
            "Base64EncodedTriggerRules": [
                {
                    "Name": "xx",
                    "Value": [
                        "xx"
                    ]
                },
                {
                    "Name": "xx",
                    "Value": [
                        "xx"
                    ]
                }
            ],
            "ResponseFailExample": "xx",
            "ResponseType": "xx",
            "AuthType": "xx",
            "ServiceTimeout": 15,
            "ServiceName": "xx",
            "ApiDesc": "xx",
            "ServiceWebsocketCleanupFunctionQualifier": "xx",
            "OauthConfig": {
                "PublicKey": "xx",
                "LoginRedirectUrl": "xx",
                "TokenLocation": "xx"
            },
            "IsBase64Trigger": false,
            "ServiceScfFunctionName": "xx",
            "ServiceTsfHealthCheckConf": {
                "RequestVolumeThreshold": 0,
                "SleepWindowInMilliseconds": 0,
                "ErrorThresholdPercentage": 0,
                "IsHealthCheck": true
            },
            "ServiceMockReturnMessage": "xx",
            "ResponseErrorCodes": [
                {
                    "Msg": "xx",
                    "NeedConvert": true,
                    "Code": 0,
                    "ConvertedCode": 0,
                    "Desc": "xx"
                }
            ],
            "ServiceType": "xx",
            "AuthRelationApiId": "xx",
            "ModifiedTime": "2020-09-22T00:00:00+00:00",
            "MicroServicesInfo": [
                0
            ],
            "ApiId": "xx",
            "Environments": [
                "xx"
            ],
            "ApiType": "xx",
            "ServiceId": "xx",
            "ServiceWebsocketCleanupFunctionName": "xx",
            "Protocol": "xx",
            "IsBase64Encoded": false,
            "ServiceWebsocketCleanupFunctionNamespace": "xx"
        },
        "RequestId": "xx"
    }
}

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. 错误码

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