Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to automatically generate API documents and SDKs. One document and one SDK will be generated for each environment under each service, respectively.
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
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: GenerateApiDocument. |
| 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. |
| ServiceId | Yes | String | Unique service ID of the document to be created. |
| GenEnvironment | Yes | String | Environment of the service for which to create an SDK. |
| GenLanguage | Yes | String | Programming language of the SDK to be created. Currently, only Python and JavaScript are supported. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | DocumentSDK | API document and SDK link. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=GenerateApiDocument
&ServiceId=service-ody35h5e
&GenEnvironment=release
&GenLanguage=Python
&<Common request parameters>{
"Response": {
"Result": {
"DocumentURL": "https://apigateway-document-sdk-xxxxx",
"SdkURL": "https://apigateway-document-sdk-xxxxx"
},
"RequestId": "01c56ec2-6a40-46bc-bdf6-8b273d4bec93"
}
}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.GenerateApiDocumentError | Failed to generate the API documentation. |
| FailedOperation.ServiceNotExist | The service does not exist. |
| InvalidParameterValue.InvalidGenLanguage | The GenLanguage parameter value is incorrect. |
| InvalidParameterValue.NotInOptions | The parameter value is incorrect, as it is not an available option. |
Was this page helpful?