Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to create 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: CreateAPIDoc. |
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. |
ApiDocName | Yes | String | API document name |
ServiceId | Yes | String | Service name |
Environment | Yes | String | Environment name |
ApiIds.N | Yes | Array of String | List of APIs for which to generate documents |
Parameter Name | Type | Description |
---|---|---|
Result | APIDoc | Basic information of API document |
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: CreateAPIDoc
<Common request parameters>
{
"ApiDocName": "test",
"ServiceId": "service-2nuhovb7",
"Environment": "release",
"ApiIds": [
"api-2dvasde2",
"api-zewq23"
]
}
{
"Response": {
"Result": {
"ApiDocId": "apidoc-a7ragqam",
"ApiDocName": "test",
"ApiDocStatus": "PROCESSING"
},
"RequestId": "ef2f184f-8044-43f1-b807-6761f259c35f"
}
}
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. |
FailedOperation.AccessKeyExist | The custom key already exists. |
FailedOperation.ApiBindEnvironmen | This API has been bound with a usage plan. |
FailedOperation.ApiBindEnvironment | The APIs have already been bound to a usage plan. Please unbind them and try again. |
FailedOperation.ApiError | API error. |
FailedOperation.CodingError | API document operation failed. |
FailedOperation.ServiceError | Service error. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameter.FormatError | Incorrect parameter format. |
InvalidParameterValue.LimitExceeded | The number of parameters has reached the limit (100). |
LimitExceeded | The quota limit is exceeded. |
LimitExceeded.APIDocLimitExceeded | The number of API documents exceeds the limit. |
MissingParameter | Missing parameter. |
RequestLimitExceeded | The number of requests exceeds the frequency limit. |
ResourceInUse | The resource is in use. |
ResourceInsufficient | Insufficient resource. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.InvalidAccessKeyId | The key does not exist. |
ResourceNotFound.InvalidApi | Incorrect ApiId . |
ResourceNotFound.InvalidService | The corresponding service is invisible. |
UnauthorizedOperation | The operation is unauthorized. |
Was this page helpful?