指定された実行中のインスタンスの自動シャットダウンポリシー情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
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 |
|
| Expression |
string |
IdleDuration > 1440 min AND CpuUtilization <= 1% |
|
| Context |
object |
||
SourceType
deprecated
|
string |
该字段已废弃。 |
Workspace |
Expression
deprecated
|
string |
该字段已废弃。 |
IdleDuration > 1440 min AND CpuUtilization <= 1% |
Context
deprecated
|
object |
该字段已废弃。 |
Context フィールドの説明
Context の内容はポリシータイプによって異なります。以下のセクションでは各シナリオについて説明します。
シナリオ 1: SourceType = Workspace、アイドル時間ベースのシャットダウンポリシー
| キー | タイプ | 例 | 説明 |
| 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
}
}
```.
#### シナリオ 2: SourceType = Workspace、実行時間ベースのシャットダウンポリシー
| キー | タイプ | 例 | 説明 |
| --- | --- | --- | --- |
| RunningDuration | Integer | 90 | インスタンスが実行中であった時間(分単位)。 |
| RemainingTimeInMillis | Long | 1800000 | 実行時間の上限に達するまでの残りミリ秒数。値が -1 の場合、上限を超過したか、該当しないことを示します。 |
**例:**
```json
{
"SourceType": "Workspace",
"Expression": "RunningDuration > 120 min",
"Context": {
"RunningDuration": 90,
"RemainingTimeInMillis": 1800000
}
}
```.
例
成功レスポンス
JSONJSON
{
"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
}
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。