tencent cloud



Last updated: 2022-10-12 15:59:03

1. API Description

Domain name for API request: apigateway.tencentcloudapi.com.

This API (DescribeApi) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeApi.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique service ID of API.
ApiId Yes String Unique API ID.

3. Output Parameters

Parameter Name Type Description
Result ApiInfo API details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying API details

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "Result": {
            "EnableCORS": false,
            "ServiceDesc": "xx",
            "RequestParameters": [
                    "Name": "xx",
                    "DefaultValue": "xx",
                    "Required": true,
                    "Position": "xx",
                    "Type": "xx",
                    "Desc": "xx"
            "InternalDomain": "xx",
            "ServiceWebsocketRegisterFunctionName": "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",
                "CosConfig": {
                    "Action": "xx",
                    "PathMatchMode": "xx",
                    "BucketName": "xx",
                    "Authorization": true
                "UpstreamId": "xx",
                "Path": "xx",
                "Method": "xx"
            "Tags": [
                    "Value": "xx",
                    "Key": "xx"
            "ServiceParameters": [
                    "RelevantRequestParameterPosition": "xx",
                    "Name": "xx",
                    "RelevantRequestParameterDesc": "xx",
                    "DefaultValue": "xx",
                    "RelevantRequestParameterType": "xx",
                    "RelevantRequestParameterName": "xx",
                    "Position": "xx"
            "ServiceScfFunctionNamespace": "xx",
            "RequestConfig": {
                "Path": "xx",
                "Method": "xx"
            "ServiceWebsocketTransportFunctionQualifier": "xx",
            "IsDebugAfterCharge": false,
            "ApiBusinessType": "xx",
            "ApiName": "xx",
            "Base64EncodedTriggerRules": [
                    "Name": "xx",
                    "Value": [
                    "Name": "xx",
                    "Value": [
            "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": [
            "ApiId": "xx",
            "Environments": [
            "ApiType": "xx",
            "ServiceId": "xx",
            "ServiceWebsocketCleanupFunctionName": "xx",
            "Protocol": "xx",
            "IsBase64Encoded": false,
            "ServiceWebsocketCleanupFunctionNamespace": "xx"
        "RequestId": "xx"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.ApiError API error.
FailedOperation.EbError Failed to bind/unbind EventBridge.
FailedOperation.ServiceNotExist The service does not exist.
InternalError Internal error.
InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidRegion Incorrect region.
InvalidParameterValue.InvalidUpstream The backend channel does not exist or is invalid.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidService The corresponding service is invisible.
UnsupportedOperation.InvalidAction API error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support