機能の概要
このAPIは、テナントのアローリストグループ情報を変更するために使用されます。アローリストの詳細な使用方法については、テナントのアローリストグループの設定をご参照ください。
注意
現在、このAPIのアローリストは開放されています。利用を希望する場合は、テクニカルサポートにお問い合わせください。
呼び出しの説明
インターフェース制約
呼び出し元は、マルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
リクエストパラメータ
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| securityIps | string | はい | IPセキュリティアローリスト。JSON形式の配列で、配列内の各オブジェクトはIP文字列またはIPアドレス帯域です。最大40個を設定できます。 | "["192.190.xx.xx"]" |
| securityIpGroupName | string | Yes | IPアドレスのセキュリティホワイトリストグループ名です。小文字の英字で始まり、小文字の英字または数字で終わります。小文字の英字、数字、アンダースコアのみ含めることができ、長さは2～32文字です。 | paytest |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | テナントのホワイトリスト情報。 | |
| instanceId | string | OceanBase CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | テナントID。 | t4louaeei**** |
| securityIps | string | ホワイトリストのリストです。カンマ区切りの文字列で、各要素はIPアドレスまたはIPアドレスの範囲です。 | "["192.190.xx.xx"]" |
| securityIpGroupName | string | セキュリティホワイトリストのグループ名。 | paytest |
例
リクエスト例
curl -v --location \
--digest -u '<Your AK:SK>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--data '{"securityIps":"[\"192.190.xx.xx\"]", "securityIpGroupName": "paytest"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得することができます。
- instanceIdが属するプロジェクトのIDが指定されたプロジェクトIDと一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {
"instanceId": "ob****cs97mx9c",
"securityIpGroupName": "zhi****111",
"securityIps": "[\"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****1010",
"success": true
}