Domain name for API request: dlc.tencentcloudapi.com.
This API is used to switch the versions of the engine image.
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: SwitchDataEngineImage. |
Version | Yes | String | Common Params. The value used for this API: 2021-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
DataEngineId | Yes | String | Engine ID |
NewImageVersionId | Yes | String | New image version ID |
Parameter Name | Type | Description |
---|---|---|
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: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SwitchDataEngineImage
<Common request parameters>
{
"DataEngineId": "DataEngine-xx",
"NewImageVersionId": "xxxxxx"
}
{
"Response": {
"RequestId": "abc"
}
}
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 | The operation failed. |
FailedOperation.NoPermissionToUseTheDataEngine | The user does not have permission to specify the engine. |
InternalError | An internal error occurred. |
InternalError.InternalSystemException | The business system is abnormal. Please try again or submit a ticket to contact us. |
InvalidParameter.DataEngineExecTypeNotMatch | The parameter ExecType passing to the specified cluster is invalid. Currently, only SQL or BATCH is supported. |
InvalidParameter.DataEnginePayModeTypeNotMatch | The specified cluster payment type does not match. Currently, it only supports 0: postpaid and 1: prepaid. |
InvalidParameter.ImageClusterParametersFormatNotJson | The specified cluster image Cluster parameter format is not JSON. |
InvalidParameter.ImageEngineTypeNotMatch | The specified engine type does not match. Currently, only SparkSQL, PrestoSQL, and SparkBatch are supported. |
InvalidParameter.ImageIsPublicNotMatch | The specified isPublic does not match. Currently, it only supports 1: public and 2: private. |
InvalidParameter.ImageParameterNotFound | The specified cluster image parameter does not exist. |
InvalidParameter.ImageSessionParametersFormatNotJson | The specified cluster image Session parameter format is not JSON. |
InvalidParameter.ImageStateNotMatch | The specified state does not match. Currently, it only supports 1: initializing, 2: online, 3: offline. |
InvalidParameter.ImageUserRecordsTypeNotMatch | The specified cluster image UserRecords does not match. Currently, it only supports: 1: parentVersion; 2: childVersion; 3: pySpark. |
InvalidParameter.ParameterNotFoundOrBeNone | The parameter is not found or empty. |
ResourceNotFound.DataEngineConfigInstanceNotFound | The specified cluster configuration instance does not exist. |
ResourceNotFound.DataEngineConfigInstanceNotUnique | The specified cluster configuration instance already exists. |
ResourceNotFound.DataEngineNotActivity | The specified cluster is not running. |
ResourceNotFound.DataEngineNotFound | The specified engine does not exist. |
ResourceNotFound.DataEngineNotMultiVersion | The specified cluster is not a multi-version type and does not support this operation. |
ResourceNotFound.ImageSessionConfigNotFound | The specified cluster image Session configuration does not exist. |
ResourceNotFound.ImageSessionConfigNotUnique | The specified cluster image Session configuration already exists. |
ResourceNotFound.ImageVersionNotActivity | The specified cluster image is not activated. |
ResourceNotFound.ImageVersionNotFound | The specified cluster image version does not exist. |
本页内容是否解决了您的问题?