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.
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: DescribeAPIDocs. |
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. |
Limit | No | Integer | Number of results to be returned. Default value: 20. Maximum value: 100. |
Offset | No | Integer | Offset. Default value: 0. |
Parameter Name | Type | Description |
---|---|---|
Result | APIDocs | API document list information |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAPIDocs
<Common request parameters>
{
"Limit": 20
}
{
"Response": {
"Result": {
"TotalCount": 1,
"APIDocSet": [
{
"ApiDocId": "apidoc-a7ragqam",
"ApiDocName": "test",
"ApiDocStatus": "PROCESSING"
}
]
},
"RequestId": "5ee3cf2e-758b-4cb5-801e-9c28d5b67763"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InvalidFilterNotSupportedName | The parameter value is incorrect. |
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. |
Was this page helpful?