All Products
Search
Document Center

WUYING Workspace:StopDesktops

Last Updated:Apr 08, 2024

Stop cloud computers that are in the Running state. After the operation is successfully called, the cloud computers enter the Stopped state.

Operation description

The cloud computers that you want to stop must be in the Running state.

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
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
StoppedModestringNo

The billing mode after you stop the cloud computer.

Default value: StopCharging. Valid values:

  • StopCharging: After the cloud computer is stopped, the system automatically reclaims computing resources. You are no longer charged for computing resources. However, you are still charged for storage resources.

  • KeepCharging: After the cloud computer is stopped, the system does not reclaim resources to prevent insufficient resources and startup failures. You are still charged for the resources.

StopCharging
DesktopIdarrayYes

The IDs of the cloud computers. You can specify 1 to 20 IDs.

stringYes

The ID of a cloud computer.

ecd-7w78ozhjcwa3u****

Response parameters

ParameterTypeDescriptionExample
object

Schema of response.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history