ModifyAPIDoc

Last updated: 2021-05-10 15:47:08

1. API Description

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

This API is used to modify an API document.

A maximum of 20 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: ModifyAPIDoc.
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
ApiDocName No String API document name
ServiceId No String Service name
Environment No String Environment name
ApiIds.N No Array of String List of APIs for which to generate documents

3. Output Parameters

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

4. Example

Example1 ModifyAPIDoc

Input Example

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

{
    "ApiDocName": "test",
    "ApiDocId": "doc-v8tsladd",
    "ServiceId": "service-2nuhovb7",
    "Environment": "release",
    "ApiIds": [
        "api-2dvasde2",
        "api-zewq23"
    ]
}

Output Example

{
  "Response": {
    "Result": {
      "ApiDocId": "apidoc-a7ragqam",
      "ApiDocName": "test",
      "ApiDocStatus": "PROCESSING"
    },
    "RequestId": "ad4b3a69-50ac-4de3-a2dc-08167a9a2d45"
  }
}

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
FailedOperation.ApiError API error.
FailedOperation.ServiceError Service error.
InvalidParameter.FormatError Incorrect parameter format.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidApiDoc The API document does not exist.
ResourceNotFound.InvalidService The corresponding service is invisible.