ModifyDynamicConfig - Data Transmission Service - Alibaba Cloud Documentation Center

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 for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyDynamicConfig	The operation that you want to perform. Set the value to ModifyDynamicConfig.
DtsJobId	String	Yes	ta7w132u12h****	The ID of the data migration or synchronization task. Note You can call the DescribeDtsJobs operation to query the task ID.
JobCode	String	Yes	07	The task code. Valid values: 03: a full data synchronization or a full data migration task. 04: an incremental data migration task. 07: an incremental data synchronization task.
RegionId	String	No	cn-hangzhou	The region ID of the Data Transmission Service (DTS) instance. For more information, see Supported regions.
ConfigList	String	Yes	{ "dts.datamove.source.rps.max": 5000, "dts.datamove.source.bps.max": 10485760 }	The throttling configuration. Valid objects: dts.datamove.blaster.qps.max: the number of queries that are made to the source database per second. dts.datamove.source.rps.max: the number of rows that are synchronized or migrated per second. dts.datamove.source.bps.max: the amount of data that is synchronized or migrated per second. Unit: bytes. Note If you set the JobCode parameter to 03, you need to specify true for the EnableLimit parameter. Otherwise, the three parameters cannot take effect. If you set the JobCode parameter to 04 or 07, you only need to specify dts.datamove.source.rps.max and dts.datamove.source.bps.max. A value of -1 indicates that no rate limit is imposed.
EnableLimit	Boolean	No	true	Specifies whether to enable throttling for data synchronization or migration. Valid values: true and false. Note This parameter is required only when the JobCode parameter is set to 03.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	8D81829D-1BBD-5CE8-BE75-1CAD5750****	The request ID.
ErrCode	String	InternalError	The error code returned if the request failed.
Success	Boolean	true	Indicates whether the request was successful.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the request failed.
Code	String	200	The response code. This parameter will be removed in the future.
DynamicMessage	String	DtsJobId	The dynamic part in the error message. This parameter is used to replace the %s variable in the value of ErrMessage. 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=ModifyDynamicConfig
&DtsJobId=ta7w132u12h****
&JobCode=07
&RegionId=cn-hangzhou
&ConfigList={"dts.datamove.source.rps.max":5000,"dts.datamove.source.bps.max":10485760}
&Common request parameters

Sample success responses

JSON format

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "8D81829D-1BBD-5CE8-BE75-1CAD5750****",
    "HttpStatusCode" : 200,
    "Success" : true
  },
  "httpStatusCode" : "200",
  "requestId" : "8D81829D-1BBD-5CE8-BE75-1CAD5750****",
  "successResponse" : true
}

Error codes

HttpCode	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	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 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 signature expired. Use a new signature.

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