本記事では、APIを使用してリサイクルバインド内の指定されたテナントを復元する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/recyclebin/tenant/:name
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| new_name | string | いいえ | t2 | 復元後のテナントの新しい名前。設定しない場合、復元されるテナント名は元のテナント名となります。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| error | ApiError | リクエストで発生したError。以下の情報を含みます：
|
例
リクエスト例
POST 10.10.10.1:2886/api/v1/recyclebin/tenant/t1
{
"new_name": "t2"
}
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T16:00:09.813011861+08:00",
"duration": 130,
"status": 200,
"traceId": "fa1fbe181d870bde"
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用してAPIメソッドを呼び出す方法については、リサイクルバインド内のテナントの復元を参照してください。
obshell-sdk-goによるAPIメソッドのリクエスト方法については、ごみ箱からテナントの復元を参照してください。