機能説明
ホスト情報を一括削除します。
呼び出し説明
インターフェース制約
呼び出し元はHOST_MANAGER権限を持っている必要があります。
リクエストパス
POST /api/v2/compute/hosts/batchDelete
リクエストパラメータ
body:
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| hostIdList | LongArray | はい | [1001,1002] | ホストIDのリスト。 |
戻り値
基本データ構造
パラメータ |
型 |
説明 |
|---|---|---|
| data | Object | リクエストされたデータ。 |
| ├─ contents | Array | TaskInstanceの配列です。詳細はTaskInstanceデータ構造を参照してください。 |
| successful | Boolean | リクエストが成功したかどうか。 |
| timestamp | Datetime | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | Integer | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | Integer | HTTP Status仕様に準拠したコード。 |
| traceId | String | リクエストのTrace IDで、問題のトラブルシューティングに使用されます。 |
| server | String | リクエストに応答したアプリケーションサービスのアドレス。 |
TaskInstanceデータ構造
パラメータ |
型 |
説明 |
|---|---|---|
| id | Long | ソフトウェアパッケージID。 |
| name | String | ソフトウェアパッケージ名。 |
| clusterId | Long | クラスタID。 |
| tenantId | Long | テナントID。 |
| hostId | Long | ホストID。 |
| type | String | タスクの種類。次の値が利用可能です: |
| status | Integer | タスクの実行状態。次の値が利用可能です: |
| creator | String | タスク作成者のユーザー名。 |
| operation | String | タスク操作。以下の操作があります: |
| executor | String | タスク実行ノードのアドレス。 |
| createTime | String | タスクの作成日時。 |
| startTime | String | タスクの開始時刻。 |
| finishTime | String | タスクの終了時刻。 |
| prohibitRollback | Boolean | ロールバックを禁止するかどうか。 |
| subtasks | ObjectArray | SubtaskInstanceの配列。サブタスクの集計情報については、SubtaskInstanceデータ構造を参照してください。 |
SubtaskInstanceデータ構造
パラメータ |
型 |
説明 |
|---|---|---|
| id | Long | サブタスクインスタンスID。 |
| name | String | サブタスク名。 |
| seriesId | Long | サブタスクシリーズID。 |
| description | String | サブタスクの説明情報。 |
| timeout | Integer | サブタスクのタイムアウト時間。単位は秒。 |
| status | String | サブタスクの状態。以下の状態があります: |
| operation | String | サブタスク操作。以下の操作があります: |
| executor | String | サブタスク実行ノード情報。 |
| runTime | Integer | サブタスクの実行回数。 |
| createTime | String | サブタスクの作成日時。 |
| startTime | String | サブタスクの開始時刻。 |
| finishTime | String | サブタスクの終了時刻。 |
| nodeType | String | ノードタイプ。例:JAVA_TASK。 |
| paralleIdx | Integer | 並列サブタスクのインデックス値。-1は非並列サブタスクを示します。 |
| upstreams | LongArray | 上流サブタスクIDのリスト。 |
| downstream | LongArray | 下流サブタスクIDのリスト。 |
| prohibitRollback | Boolean | サブタスクでロールバックを禁止するかどうか。 |
例
リクエスト例
POST /api/v2/compute/hosts/batchDelete -H 'Accept: application/json' -H 'Content-Type: application/json' --data-raw '{"hostIdList":[4000002]}'
レスポンス例
{
"data": {
"contents": [
{
"creator": "admin",
"executor": "xx.xx.xx.xx",
"hostId": 4000002,
"id": 35006655,
"name": "Prepare host",
"operation": "EXECUTE",
"startTime": "2021-08-25T19:48:49.604+08:00",
"status": "RUNNING",
"subtasks": [
{
"description": "Update host status",
"downstreams": [],
"id": 13006993,
"name": "Update host status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
13006994
]
},
{
"description": "Uninstall legacy ocp agent",
"downstreams": [
13006994
],
"id": 13006990,
"name": "Uninstall legacy ocp agent",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"timeout": 600,
"upstreams": [
13006991
]
},
{
"description": "Pre check for create host",
"downstreams": [
13006991
],
"id": 13006992,
"name": "Pre check for create host",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "READY",
"timeout": 1800,
"upstreams": []
},
{
"description": "Install ocp agent",
"downstreams": [
13006993
],
"id": 13006994,
"name": "Install ocp agent",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"timeout": 5400,
"upstreams": [
13006990
]
},
{
"description": "Uninstall legacy obagent",
"downstreams": [
13006990
],
"id": 13006991,
"name": "Uninstall legacy obagent",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"timeout": 2100,
"upstreams": [
13006992
]
}
],
"type": "MANUAL"
}
]
},
"duration": 1118,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-08-25T19:48:49.639+08:00",
"traceId": "93c00223847c4e0a"
}