本記事では、APIを使用してごみ箱内のすべてのテナント情報を取得する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証が必要です。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
GET /api/v1/recyclebin/tenants
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのTrace IDです。 |
| data | []DbaRecyclebin | ごみ箱内のすべてのテナント情報です。詳細は、後述のDbaRecyclebinのデータ構造を参照してください。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます：
|
DbaRecyclebinのデータ構造：
パラメータ |
型 |
説明 |
|---|---|---|
| object_name | string | ゴミ箱内のテナント名。 |
| original_tenant_name | string | テナントの元の名前。 |
| can_undrop | string | テナントをundropできるかどうか（YES/NO）。 |
| can_purge | string | テナントをクリーンアップできるかどうか（YES/NO）。 |
例
リクエスト例
GET 10.10.10.1:2886/api/v1/recyclebin/tenants
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T16:12:44.394940604+08:00",
"duration": 40,
"status": 200,
"traceId": "5b7f4130ec2be90f",
"data": {
"contents": [
{
"object_name": "__recycle_$_123456_1728893438913560",
"original_tenant_name": "t1",
"can_undrop": "YES",
"can_purge": "YES"
}
]
}
}
関連ドキュメント
コマンドラインでAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、ごみ箱内のすべてのテナント情報を取得するを参照してください。
obshell-sdk-goを使用したAPIメソッドの呼び出しについては、ごみ箱内のすべてのテナント情報を取得するを参照してください。