tencent cloud

文档反馈

RollbackDataEngineImage

最后更新时间:2024-08-08 15:32:15

1. API Description

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

This API is used to roll back the versions of the engine image.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: RollbackDataEngineImage.
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
FromRecordId No String FromRecordId parameters returned by the API for checking the availability of rolling back
ToRecordId No String ToRecordId parameters returned by the API for checking the availability of rolling back

3. Output Parameters

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.

4. Example

Example1 Upgrading Engine Image Version

Input Example

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

{
    "DataEngineId": "DataEngine-xx",
    "FromRecordId": "xxxxxx",
    "ToRecordId": "xxxxxx"
}

Output Example

{
    "Response": {
        "RequestId": "abv"
    }
}

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 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.DataEngineImageOperateNotMatch The specified cluster image operation does not match. Currently, only InitImage/UpgradeImage/SwitchImage/RollbackImage/ModifyResource is supported.
InvalidParameter.DataEnginePayModeTypeNotMatch The specified cluster payment type does not match. Currently, it only supports 0: postpaid and 1: prepaid.
InvalidParameter.DataEngineTypeNotMatch The specified cluster type does not match. Currently, only spark/presto is supported.
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.DataEngineNotUnique The specified engine already exists.
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.ImageVersionNotUnique The specified cluster image version already exists.