機能の概要
このAPIは、OceanBaseクラスタインスタンスを一時停止するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/instances/{instanceId}/stopCluster
リクエストパラメータ
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 AccessKey ID:AccessKey Secret>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/stopCluster?requestId={requestId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
リクエスト成功のレスポンス例：
{
"success" : true,
"requestId": "xxxxxx"
}
リクエスト失敗のレスポンス例：
{
"errorCode":"IllegalOperation.Resource",
"errorMessage":"The current resource state does not allow this operation.",
"requestId":"xxxxxxx",
"success":false
}