DescribeAPIDocDetail

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-20 14:23:51

Download PDF

1. API Description

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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeAPIDocDetail.
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.
ApiDocId	Yes	String	API document ID

3. Output Parameters

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.

4. Example

Example1 DescribeAPIDocDetail

Input Example

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

{
    "ApiDocId": "apidoc-a7ragqam"
}

Output Example

{
  "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"
  }
}

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

Tencent Cloud CLI 3.0

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.CodingError	API document operation failed.
InvalidParameter.FormatError	Incorrect parameter format.
ResourceNotFound.InvalidApiDoc	The API document does not exist.
UnsupportedOperation.InvalidAction	API error.

Recent Pages