tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyMigrateRuntimeAttribute

Last updated: 2024-12-04 15:34:57

1. API Description

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

This API is used to modify task runtime attributes. This interface is different from the configuration class interface and does not perform state machine evaluation.

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: ModifyMigrateRuntimeAttribute.
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 Migration task id, for example: dts-2rgv0f09
OtherOptions.N Yes Array of KeyValuePairOption Attributes that need to be modified. This structure is designed as a generic structure to separate customized attributes for multiple businesses.
For instance, for Redis:
{
"Key": "DstWriteMode", // Target database write mode
"Value": "normal" // clearData (clear target instance data), overwrite (perform task in overwrite manner), normal (follow normal procedure, no additional actions, this is the default value)
},
{
"Key": "IsDstReadOnly", // Whether to set target database as read-only during migration
"Value": "true" // true (set as read-only), false (do not set as read-only)
}

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 Modifying the writing mode for the Redis target database

This example shows you how to modify the writing mode for the Redis target database by filling in relevant parameters. Multiple parameters can be adjusted simultaneously.

Input Example

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

{
    "JobId": "dts-2rgv0f09",
    "OtherOptions": [
        {
            "Key": "DstWriteMode",
            "Value": "clearData"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

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.FailedOperationError The operation failed.
InternalError An internal error occurred.
InternalError.ExecHttpRequestError HTTP request error.
InternalError.InternalErrorError An internal error occurred.
InvalidParameter.InvalidParameterError The parameter is invalid.
OperationDenied.OperationDeniedError The operation was denied.
ResourceNotFound The resource does not exist.
ResourceNotFound.ResourceNotFoundError The resource was not found.
UnknownParameter.UnknownParameterError The parameter is unknown.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy