You can call this operation to query a list of whitelists.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeIpWhitelistGroups

The operation that you want to perform. Set the value to DescribeIpWhitelistGroups.

ClusterId String Yes cds-j6c1zij80****9939

The ID of the cluster.

Response parameters

Parameter Type Example Description
Groups Array

The list of whitelists.

Group
GroupName String group_one

The name of the whitelist.

IpList List 127.0.0.1,192.***.0.1

The list of IP addresses in the whitelist. Multiple IP addresses are separated with commas (,).

IpVersion Integer 6

The IP version. Valid values: 4 and 6.

RequestId String 391A6933-0D4A-42EB-BCE7-03DA59D69ED4

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeIpWhitelistGroups
&ClusterId=cds-j6c1zij80****9939
&<Common request parameters>

Sample success responses

XML format

<DescribeIpWhitelistGroupsResponse>
  <Groups>
        <Group>
              <GroupName>default</GroupName>
              <IpVersion>4</IpVersion>
              <IpList>
                    <IP>42.***.74.126</IP>
                    <IP>127.0.0.2</IP>
              </IpList>
        </Group>
        <Group>
              <GroupName>default_jy</GroupName>
              <IpVersion>4</IpVersion>
              <IpList>
                    <IP>42.***.74.126</IP>
                    <IP>127.0.0.1</IP>
              </IpList>
        </Group>
  </Groups>
  <RequestId>391A6933-0D4A-42EB-BCE7-03DA59D69ED4</RequestId>
</DescribeIpWhitelistGroupsResponse>

JSON format

{
  "Groups": {
    "Group": [
      {
        "GroupName": "default",
        "IpVersion": 4,
        "IpList": {
          "IP": [
            "42.***.74.126",
            "127.0.0.2"
          ]
        }
      },
      {
        "GroupName": "default_jy",
        "IpVersion": 4,
        "IpList": {
          "IP": [
            "42.***.74.126",
            "127.0.0.1"
          ]
        }
      }
    ]
  },
  "RequestId": "391A6933-0D4A-42EB-BCE7-03DA59D69ED4"
}

Error codes

For a list of error codes, visit the API Error Center.