本記事では、APIを使用して未使用の指定したリソースプールを削除する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/resource-pool/:name
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | int | HTTP Status仕様に準拠したコード。 |
| traceId | string | リクエストのTrace ID。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます:
|
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/resource-pool/p1
返却例
{
"successful": true,
"timestamp": "2024-10-14T15:46:12.947201503+08:00",
"duration": 13,
"status": 200,
"traceId": "b3792e6360025da5"
}
関連ドキュメント
コマンドラインからAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、リソースプールの削除を参照してください。
obshell-sdk-goを使用したAPIメソッドの呼び出しについては、リソースプールの削除を参照してください。