All Products
Search
Document Center

DataWorks:StopInstance

Last Updated:Sep 03, 2024

Terminates an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdlongYes

The instance ID. You can call the ListInstances operation to obtain the ID.

1234
ProjectEnvstringYes

The environment of the workspace. Valid values: PROD and DEV.

PROD

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
Databoolean

The result returned.

true
ErrorMessagestring

The error message.

The connection does not exist.
RequestIdstring

The request ID.

E6F0DBDD-5AD****
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history