機能説明
このAPIは、データ移行/同期プロジェクトを起動するために使用されます。CommonProjectController.startProjectに対応しています。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/oms/project/start
リクエストパラメータ
Header
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | proj-xxxxxxxx |
| X-Ob-Org-Id | String | はい | 組織ID | org-xxxxxxxx |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | いいえ | リクエストID | d04eabba-acef-4f4b-96f1-c657******** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| id | String | はい | プロジェクトID | np_7befdmp08juo |
| startupMode | String | いいえ | 起動モード：IMMEDIATE（即時起動、デフォルト）/ AFTER_BUY（購入後起動） |
IMMEDIATE |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| code | String | エラーコード | "200" |
| message | String | 説明 | successful |
| requestId | String | リクエストID | dc302d76-66b5-48d8-ab53-a035******** |
| cost | String | 所要時間 | 150 |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/start' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'X-Ob-Org-Id: <Organization ID>' \
--data '{"id":"np_7befdmp08juo","startupMode":"IMMEDIATE"}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"cost": "150"
}