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