tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ResumeMigrateJob

最后更新时间：2023-10-17 11:03:13

    1. API Description

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

    This API is used to retry an abnormal or failed Redis data migration task. Note that this operation will skip the check stage and directly start the task, just like by calling StartMigrationJob. After calling this API, you can call the DescribeMigrationJobs API to query the latest task status.

    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: ResumeMigrateJob.
    Version Yes String Common Params. The value used for this API: 2021-12-06.
    Region No String Common Params. This parameter is not required for this API.
    JobId Yes String Data migration task ID
    ResumeOption Yes String Task resumption mode. Valid values: clearData (Clearing the target instance data); overwrite (Executing the task in overwrite mode); normal (Following the normal process without additional operations). clearData and overwrite are only valid for Redis links and normal for non-Redis links.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Retrying a failed data migration task

    This example shows you how to retry a failed data migration task in overwrite mode.

    Input Example

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

{
    "JobId": "dts-j7bt5sid",
    "ResumeOption": "normal"
}

    Output Example

    {
    "Response": {
        "RequestId": "22f6b9ca-e94d-4a4d-b48f-a5133e791374"
    }
}

    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
    AuthFailure.AuthFailureError Authentication failed.
    DryRunOperation.DryRunOperationError DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful.
    FailedOperation.FailedOperationError The operation failed.
    FailedOperation.NotAllowOperation This operation is prohibited.
    InternalError.DatabaseError Failed to access the database on the DTS platform.
    InternalError.DuplicateJob Migration tasks are in conflict.
    InternalError.InternalErrorError An internal error occurred.
    InternalError.ProtocolError A communication protocol error occurred.
    InternalError.UnknownError An unknown internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidParameterError The parameter is invalid.
    InvalidParameterValue.InvalidParameterValue The parameter value is incorrect.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    OperationDenied.OperationDeniedError The operation was denied.
    RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    ResourceNotFound.JobNotExist The migration task does not exist.
    ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
    UnauthorizedOperation.NotEnoughPrivileges Authentication failed as there were no required permissions.
    UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
    UnknownParameter.UnknownParameterError The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款