本記事では、APIを使用して指定したユニットのリソース構成を削除する方法について説明します。
呼び出しの概要
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/unit/config/:name
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)です。 |
| status | int | HTTPステータスコード仕様に準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます:
|
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/unit/config/s1
戻り値例
{
"successful": true,
"timestamp": "2024-10-14T16:14:51.852430189+08:00",
"duration": 14,
"status": 200,
"traceId": "f44c8455e0a8b1a1"
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。