機能の概要
このAPIは、テナントの読み取り専用レプリカのゾーンリストを変更するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplica
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | インスタンスID | obxxx |
| tenantId | String | はい | テナントID | obxxx |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID（追跡用） | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| readonlyZone | String | はい | ロジックzoneId | ap-beijing-3-ro-z0 |
| readOnlyReplicaType | String | はい | 読み取り専用レプリカタイプ：
|
ROW_STORE |
| operation | String | はい | 操作タイプ
|
CREATE |
| customUnitConfig | Object | いいえ | カスタムUnit設定 | - |
戻り値
プロパティ名 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | データ | |
| operation | String | 操作タイプ | CREATE |
| readonlyZone | String | ロジックゾーンID | ap-beijing-3-ro-z0 |
| success | Boolean | 成否 | true |
| tenantId | String | テナントID | txxx |
例
リクエスト例
curl --digest -u '<あなたの AK:SK>' \
-X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplica?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{
"readonlyZone": "ap-beijing-3-ro-z1",
"readOnlyReplicaType": "ROW_STORE",
"operation": "CREATE"
}'
レスポンス例
JSON形式
{
"data":{
"instanceId":"obxxx",
"operation":"CREATE",
"readonlyZone":"ap-beijing-3-ro-z1",
"success":true,
"tenantId":"txxx"
},
"requestId":"c69b9b89-a553-4e95-9bc7-6cbc04b309fc",
"success":true
}