使用GetIdleInstanceCuller获取闲置实例自动关机策略-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:GetIdleInstanceCuller

get

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。如何获取实例 ID，请参见 ListInstances 。	dsw-730xxxxxxxxxx

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	成功标志，可能值： true false 枚举值： true : true false : false	true
Message	string	错误信息。	"XXX"
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	ValidationError
InstanceId	string	实例 ID。	dsw-730xxxxxxxxxx
CpuPercentThreshold	integer	CPU 使用率阈值，单位是百分比，取值 1~100，低于此值则认为实例当前处于闲置。	20
GpuPercentThreshold	integer	GPU 使用率阈值，单位是百分比，取值 1~100。如果实例为 GPU 类型，则此参数生效。CPU 和 GPU 同时低于阈值则认为指定实例处于闲置。	10
MaxIdleTimeInMinutes	integer	闲置等待时间阈值，单位是分钟。如果闲置时长超过此值，将自动停止 DSW 实例。	60
IdleTimeInMinutes	integer	实例当前闲置时长，单位是分钟。	30

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "ValidationError",
  "InstanceId": "dsw-730xxxxxxxxxx",
  "CpuPercentThreshold": 20,
  "GpuPercentThreshold": 10,
  "MaxIdleTimeInMinutes": 60,
  "IdleTimeInMinutes": 30
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。