Documentation|Tencent Cloud

Recent Pages

DescribeApi

Last updated: 2020-07-17 09:42:20

1. API Description

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

This API is used to query the details of an API deployed in API Gateway.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeApi.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-08.
Region	Yes	String	Common parameter. 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

https://apigateway.tencentcloudapi.com/?Action=DescribeApi
&ServiceId=service-ody35h5e
&ApiId=api-3v4tzy3u
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "ServiceId": "service-ody35h5e",
      "ServiceName": "mytest",
      "ServiceDesc": "mytesttest",
      "ApiId": "api-3v4tzy3u",
      "ApiDesc": "get a user info",
      "CreatedTime": "2019-12-23T09:15:16Z",
      "ModifiedTime": "2020-02-22T02:05:29Z",
      "ApiName": "test1",
      "ApiType": "NORMAL",
      "Protocol": "HTTP",
      "AuthType": "NONE",
      "ApiBuniessType": "NORMAL",
      "AuthRelationApiId": "api-e92i2jds",
      "OauthConfig": null,
      "IsDebugAfterCharge": false,
      "RequestConfig": {
        "Path": "/users/{name}",
        "Method": "GET"
      },
      "ResponseType": "",
      "ResponseSuccessExample": "",
      "ResponseFailExample": "",
      "ResponseErrorCodes": [],
      "RequestParameters": [],
      "ServiceTimeout": 15,
      "ServiceType": "MOCK",
      "ServiceConfig": null,
      "ServiceParameters": null,
      "ConstantParameters": null,
      "ServiceMockReturnMessage": "Hello Serverless Framework.",
      "ServiceScfFunctionName": null,
      "ServiceScfFunctionNamespace": null,
      "ServiceScfFunctionQualifier": null,
      "ServiceScfIsIntegratedResponse": null,
      "ServiceWebsocketRegisterFunctionName": null,
      "ServiceWebsocketRegisterFunctionNamespace": null,
      "ServiceWebsocketRegisterFunctionQualifier": null,
      "ServiceWebsocketCleanupFunctionName": null,
      "ServiceWebsocketCleanupFunctionNamespace": null,
      "ServiceWebsocketCleanupFunctionQualifier": null,
      "InternalDomain": null,
      "ServiceWebsocketTransportFunctionName": null,
      "ServiceWebsocketTransportFunctionNamespace": null,
      "ServiceWebsocketTransportFunctionQualifier": null,
      "MicroServices": null,
      "MicroServicesInfo": null,
      "ServiceTsfLoadBalanceConf": null,
      "ServiceTsfHealthCheckConf": null,
      "AuthRequired": false,
      "EnableCORS": false,
      "Tags": []
    },
    "RequestId": "b1fb681f-fc43-41cc-a8bc-c3400270c2f9"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.