QueryAutoShutdownPolicies - 查询自动关机策略-人工智能平台 PAI(PAI)-阿里云帮助中心

获取指定运行中实例的自动关机策略信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

PUT /api/v2/batch/autoshutdownpolicies/query HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求参数。
InstanceIds	array	否	DSW 实例 ID 列表。最多支持同个工作空间下的 100 个实例 ID。非分享页面访问时必填。
	string	否	运行中的实例 ID。	dsw-msq7tjk9kox7v****3
Token	string	否	分享令牌信息。	*******
InstanceId	string	否	分享页的实例 ID	dsw-730xxxxxxxxxx

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AutoShutdownPolicies	array<object>	自动关机策略列表。
	array<object>
InstanceId	string	DSW 实例 ID。	dsw-05cefd0be2e5a278
Conditions	array<object>	该实例当前生效的自动关机策略条件列表。
	array<object>
SourceType	string	策略来源。例如：`Workspace`, `User`, `System`。	Workspace
Expression	string	该实例当前生效的自动关机策略条件表达式。	IdleDuration > 1440 min AND CpuUtilization <= 1%
Context	object	自动关机策略检查使用的上下文。Context 的内容因策略类型而异，以下按场景分别说明。
SourceType `deprecated`	string	该字段已废弃。	Workspace
Expression `deprecated`	string	该字段已废弃。	IdleDuration > 1440 min AND CpuUtilization <= 1%
Context `deprecated`	object	该字段已废弃。

Context 字段说明

Context 的内容因策略类型而异，以下按场景分别说明。

场景一：SourceType = Workspace，指定空闲时长的关机策略

Key	类型	示例值	描述
IdleDuration	Integer	580	实例当前已空闲时长，单位：分钟。-1 表示未知或不可用。
IdleShutdownRemainingSeconds	Long	1200	距离空闲自动关机还剩余的秒数。仅当剩余秒数 > 0 时返回。
DelayShutdownCountdownSeconds	Long	300	延迟关机倒计时剩余秒数。仅当延迟关机功能生效且倒计时 > 0 时返回。
EnableSkip	Boolean	true	用户是否可以跳过/关闭延迟关机倒计时弹窗。仅当延迟关机倒计时生效时返回。

示例：

{
  "SourceType": "Workspace",
  "Expression": "IdleDuration > 600 min",
  "Context": {
    "IdleDuration": 580,
    "IdleShutdownRemainingSeconds": 1200,
    "DelayShutdownCountdownSeconds": 300,
    "EnableSkip": true
  }
}

场景二：SourceType = Workspace，指定运行时长的关机策略

Key	类型	示例值	描述
RunningDuration	Integer	90	实例当前已运行时长，单位：分钟。
RemainingTimeInMillis	Long	1800000	距离运行时长上限还剩余的毫秒数。-1 表示已超出上限或不适用。

示例：

{
  "SourceType": "Workspace",
  "Expression": "RunningDuration > 120 min",
  "Context": {
    "RunningDuration": 90,
    "RemainingTimeInMillis": 1800000
  }
}

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AutoShutdownPolicies": [
    {
      "InstanceId": "dsw-05cefd0be2e5a278",
      "Conditions": [
        {
          "SourceType": "Workspace",
          "Expression": "IdleDuration > 1440 min AND CpuUtilization <= 1%",
          "Context": {
            "test": "test",
            "test2": 1
          }
        }
      ],
      "SourceType": "Workspace",
      "Expression": "IdleDuration > 1440 min AND CpuUtilization <= 1%",
      "Context": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

错误码

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

变更历史

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