Changes the name of a Data Transmission Service (DTS) task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDtsJobName

The operation that you want to perform. Set the value to ModifyDtsJobName.

DtsJobId String Yes l3m1213ye7l****

The ID of the data migration, data synchronization, or change tracking task.

DtsJobName String Yes RDS_TO_RDS_MIGRATION

The new name of the DTS task.

Note We recommend that you specify a descriptive name for easy identification. You do not need to use a unique name.
RegionId String No cn-beijing

The ID of the region in which the DTS instance resides. For more information, see List of supported regions.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code.

RequestId String 8C498360-7892-433C-847A-BA71A850****

The ID of the request.

ErrCode String InternalError

The error code returned if the call failed.

Success Boolean true

Indicates whether the request was successful.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the request failed.

Code String 200

The error code. This parameter will be removed in the future.

DynamicMessage String DtsJobId

The dynamic part in the error message. The value of this parameter is used to replace the %s variable in the value of the ErrMessage parameter.

Note For example, if the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJobName
&DtsJobId=l3m1213ye7l****
&DtsJobName=RDS_TO_RDS_MIGRATION
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDtsJobNameResponse>
    <RequestId>8C498360-7892-433C-847A-BA71A850****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
</ModifyDtsJobNameResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8C498360-7892-433C-847A-BA71A850****",
  "HttpStatusCode" : 200,
  "Success" : true
}

Error codes

HTTP status code Error code Error message Description
400 Throttling.User Request was denied due to user flow control. The error message returned because the number of requests exceeds the limit and the request is rejected. Try again later.
500 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The error message returned because the signature expired. Use a new signature.

For a list of error codes, see Service error codes.