機能の概要
このAPIは、指定されたクラスタの許可リストグループ一覧を取得するために使用します。許可リストの詳細な使用方法については、許可リストグループの設定を参照してください。
呼び出しの説明
インターフェース制約
呼び出し前にAccessKey IDとAccessKey Secretを取得する必要があります。取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/securityIpGroups
リクエストパラメータ
Path
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudデータベースインスタンスID。 | obcluster-***** |
Query
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。リクエストの追跡に使用されます。 | d04eabba-acef-4f4b-96f1-c657876ca6f1 |
戻り値
フィールド |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか。HTTPステータスコードが200の場合でも、このフィールドに基づいて処理が成功したかどうかを判断する必要があります。 |
| errorCode | string | 処理エラーコード。成功した場合は空になるか、省略される場合があります。 |
| errorMessage | string | 処理エラーメッセージ。成功した場合は空になるか、省略される場合があります。 |
| data | object | クエリ結果。処理が失敗した場合は空になることがあります。 |
| data.dataList | object[] | クラスタの許可リストグループ一覧。 |
| data.dataList[].securityIpGroupName | string | 許可リストグループ名。空の場合があります。 |
| data.dataList[].securityIps | string | カンマ区切りのIPアドレスまたはCIDRブロック文字列。空の場合があります。 |
| data.total | integer (int64) | 今回のクエリで返された許可リストグループの総数。 |
| data.hasMore | boolean | まだデータがあるかどうか。このフィールドはnullになるか、省略される場合があります。 |
| cost | integer (int64) | リクエストの処理時間。空の場合があります。 |
| server | string | サーバーアドレス。空の場合があります。 |
| requestId | string | リクエストの追跡に使用されるリクエストID。空の場合があります。 |
| totalCount | integer (int64) | レスポンスの最外層の総数情報。空の場合があります。このAPIのリスト項目数はdata.totalを参照してください。 |
| extra | object | 拡張情報です。空の場合があります。 |
例
リクエスト例
curl --digest -u '<AccessKey ID>:<AccessKey Secret>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/securityIpGroups?requestId={requestId}'
レスポンス例
許可リストグループあり
{
"success": true,
"requestId": "00000000-0000-4000-8000-000000000001",
"data": {
"dataList": [
{
"securityIpGroupName": "office",
"securityIps": "192.0.2.10,198.51.100.0/24"
}
],
"total": 1
}
}
許可リストグループなし
許可リストグループが見つからなかった場合、dataListは空配列、totalは0になります。
{
"data": {
"dataList": [],
"total": 0
},
"requestId": "12ab8421-ca70-4294-b328-ca60b8bd4fb9",
"success": true
}