tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

StartMigrateJob

最后更新时间：2024-12-04 15:34:51

    1. API Description

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

    This API (StartMigrationJob) is used to start a migration task. 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: StartMigrateJob.
    Version Yes String Common Params. The value used for this API: 2021-12-06.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    JobId Yes String Data migration task ID

    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 Starting a data migration task

    Input Example

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

{
    "JobId": "dts-j7bt5sid"
}

    Output Example

    {
    "Response": {
        "RequestId": "bab78b9b-ce8a-4645-bfb2-5b03397d6ea0"
    }
}

    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.
    FailedOperation.StartJobFailed Failed to start the task.
    FailedOperation.StatusInConflict This operation cannot be performed due to a status conflict.
    InternalError.AddTaskError Failed to create the async task.
    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.InternalInnerCommonError An error occurred while accessing the internal component.
    InternalError.LockError Locks are in conflict.
    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.InvalidParameterValueError The parameter is invalid.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
    MissingParameter.MissingParameterError The parameter is lost.
    OperationDenied.BizOperationDeniedError The operation was denied as the condition was not met.
    OperationDenied.JobOperationDeniedError The task operation failed.
    OperationDenied.OperationDeniedError The operation was denied.
    RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
    ResourceInUse.ResourceInUseError The resource is being used.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    ResourceNotFound.JobNotExist The migration task does not exist.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    ResourceUnavailable.ResourceUnavailableError The resource is unavailable.
    ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
    UnauthorizedOperation.NotEnoughPrivileges Authentication failed as there were no required permissions.
    UnknownParameter.UnknownParameterError The parameter is unknown.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款