CreateIdleInstanceCuller-阿里云帮助中心

Creates an automatic stop policy for a specific Data Science Workshop (DSW) instance. When the conditions are met, the instance is automatically stopped. You can create only one automatic stop policy for an idle DSW instance. If the specific instance has an automatic stop policy, call DeleteIdleInstanceCuller to delete it first.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paidsw:CreateIdleInstanceCuller

create

*All Resource

*

None

Request syntax

POST /api/v2/instances/{InstanceId}/idleinstanceculler HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call ListInstances to obtain the instance ID.	dsw-730xxxxxxxxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
CpuPercentThreshold	integer	No	The CPU utilization threshold. Unit: percentage. Valid values: 1 to 100. If the CPU utilization of the instance is lower than this threshold, the instance is considered idle.	20
GpuPercentThreshold	integer	No	The GPU utilization threshold. Unit: percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is of the GPU instance type. If both CPU and GPU utilization is lower than the thresholds, the instance is considered idle.	10
MaxIdleTimeInMinutes	integer	No	The maximum time duration for which the instance is idle. Unit: minutes. If the time duration for which the instance is idle exceeds this value, the system automatically stops the instance.	60

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. Valid values: true false Valid values: true : true false : false	true
Message	string	The error message.	"XXX"
Code	string	The status code. Valid values: InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors. ValidationError: a parameter validation error.	null
InstanceId	string	The instance ID.	dsw-730xxxxxxxxxx

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "InstanceId": "dsw-730xxxxxxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.