Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to query the details of an API document.
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: DescribeAPIDocDetail. |
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. |
ApiDocId | Yes | String | API document ID |
Parameter Name | Type | Description |
---|---|---|
Result | APIDocInfo | API document details |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAPIDocDetail
<Common request parameters>
{
"ApiDocId": "apidoc-a7ragqam"
}
{
"Response": {
"Result": {
"ApiDocId": "apidoc-a7ragqam",
"ApiDocName": "clare",
"ApiCount": 2,
"ViewCount": 0,
"ReleaseCount": 1,
"ApiDocUri": "https://apidoc-a7ragqam-apigw.doc.coding.io",
"SharePassword": "123456",
"ApiDocStatus": "COMPLETED",
"UpdatedTime": "2021-01-25 05:46:25",
"ServiceId": "service-esdf2dsf",
"ServiceName": "myservice",
"ApiIds": [
"api-23sczadf"
],
"ApiNames": [
"test"
],
"Environment": "release"
},
"RequestId": "fbee8d42-f977-420f-b6c0-39c9c5fc4f51"
}
}
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 |
---|---|
FailedOperation.CodingError | API document operation failed. |
InvalidParameter.FormatError | Incorrect parameter format. |
ResourceNotFound.InvalidApiDoc | The API document does not exist. |
UnsupportedOperation.InvalidAction | API error. |
Was this page helpful?