All Products
Search
Document Center

Data Transmission Service:StopDedicatedCluster

Last Updated:Nov 02, 2023

Releases a Data Transmission Service (DTS) dedicated cluster.

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

StopDedicatedCluster

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

InstanceId

String

No

rm-bp1162kryivb8****

The instance ID.

Note

You must configure the InstanceId or DedicatedClusterId parameter.

DedicatedClusterId

String

No

dtscluster_h3fl1cs217sx952

The ID of the cluster.

Note

You must configure the InstanceId or DedicatedClusterId parameter.

DedicatedClusterName

String

No

dtscluster_test_001

The name of the cluster.

RegionId

String

No

cn-hangzhou

The ID of the region in which the instance resides.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

String

200

The HTTP status code.

RequestId

String

621BB4F8-3016-4FAA-8D5A-5D3163CC****

The request ID.

ErrCode

String

InternalError

The error code returned if the request failed.

Success

String

true

Indicates whether the request was successful.

ErrMessage

String

The Value of Input Parameter %s is not valid.q

The error message returned if the request failed.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=StopDedicatedCluster
&InstanceId=rm-bp1162kryivb8****
&DedicatedClusterId=dtscluster_h3fl1cs217sx952
&DedicatedClusterName=dtscluster_test_001
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

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

<StopDedicatedClusterResponse>
    <code>200</code>
    <data>
        <RequestId>26EC538C-9E2D-11D5-A55F-****</RequestId>
        <HttpStatusCode>200</HttpStatusCode>
        <Success>true</Success>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>26EC538C-9E2D-11D5-A55F-****</requestId>
    <successResponse>true</successResponse>
</StopDedicatedClusterResponse>

JSON format

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "26EC538C-9E2D-11D5-A55F-****",
    "HttpStatusCode" : 200,
    "Success" : true
  },
  "httpStatusCode" : "200",
  "requestId" : "26EC538C-9E2D-11D5-A55F-****",
  "successResponse" : true
}

Error codes

HTTP status code

Error code

Error message

Description

400

Throttling.User

Request was denied due to user flow control.

The number of requests reached the limit and the request was 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.