機能の概要
このAPIは、OceanBaseクラスタインスタンスを起動するために使用されます。
注意
クラスタインスタンス起動APIの呼び出しが成功すると、インスタンスの課金が再開されます。料金の詳細については、インスタンスの課金に関するドキュメントをご参照ください。
呼び出しの説明
API制約
呼び出し元は、マルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/startCluster
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| なし |
実行結果
プロパティ |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | リクエストの成功・失敗を示します。 | true/false |
| requestId | String | trace | dc302d76-66b5-48d8-ab53-a035********（64ビット） |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/startCluster?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
実行結果例
リクエスト成功時のレスポンス例：
{
"success": true,
"requestId": "dc302d76-66b5-48d8-ab53-a035********"
}
リクエスト失敗時のレスポンス例：
{
"errorCode": "IllegalOperation.Resource",
"errorMessage": "The current resource state does not allow this operation.",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"success": false
}