DescribeAPIDocs

Last updated: 2021-12-03 10:28:22

1. API Description

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

This API is used to query the list of API documents.

A maximum of 20 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 parameter. The value used for this API: DescribeAPIDocs.
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.
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
Offset No Integer Offset. Default value: 0.

3. Output Parameters

Parameter Name Type Description
Result APIDocs API document list information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DescribeAPIDocs

Input Example

POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAPIDocs
<Common request parameters>

{
    "Limit": 20
}

Output Example

{
  "Response": {
    "Result": {
      "TotalCount": 1,
      "APIDocSet": [
        {
          "ApiDocId": "apidoc-a7ragqam",
          "ApiDocName": "test",
          "ApiDocStatus": "PROCESSING"
        }
      ]
    },
    "RequestId": "5ee3cf2e-758b-4cb5-801e-9c28d5b67763"
  }
}

5. Developer Resources

SDK

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
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue.InvalidRegion Incorrect region.
LimitExceeded The quota limit is exceeded.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnsupportedOperation.InvalidAction API error.