機能の概要
このAPIは、OceanBaseのクラスタ名を変更するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/instanceName
リクエストパラメータ
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースインスタンスID。 | ob317v4uif**** |
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceName | string | はい | OceanBaseクラスタ名。 | APIテスト |
戻り値
名前 |
型 |
説明 |
|---|---|---|
| data | object | クラスタ情報。 |
| instanceName | string | OB CloudクラウドデータベースインスタンスID。 |
例
リクエスト例
curl --digest -u '<あなたのAK:SK>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/instanceName?requestId={requestId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
-H 'Content-Type: application/json' \
--data '{"instanceName":"nameAAA"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"data": {
"instanceName": "テストAPI"
},
"requestId": "6541ad2c-****-****-816f-ea61e825f497",
"success": true
}