All Products
Search
Document Center

DataWorks:StopInstance

Last Updated:Jul 31, 2026

Stops an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

integer

Yes

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

1234

ProjectEnv

string

Yes

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

Valid values:

  • PROD :

    Production environment.

  • DEV :

    Development environment.

PROD

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Data

boolean

The result details returned after the stop instance operation is called.

true

ErrorMessage

string

The error message.

The connection does not exist.

RequestId

string

The request ID. Used to locate logs and troubleshoot issues.

E6F0DBDD-5AD****

ErrorCode

string

The error code.

Invalid.Tenant.ConnectionNotExists

Success

boolean

Indicates whether the call was successful.

true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.