DescribeIpWhitelist - ApsaraDB for HBase - Alibaba Cloud Documentation Center

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	DescribeIpWhitelist	The operation that you want to perform. Set the value to DescribeIpWhitelist.
ClusterId	String	Yes	hb-bp16f1441y6p2kv**	The ID of the cluster that you want to query.

Response parameters


Parameter	Type	Example	Description
Groups	Array		The list of whitelist groups.
Group			The list of whitelist groups.
GroupName	String	group_01	The name of the whitelist group.
IpList	List	127.0.0.1,192.168.0.1	The list of IP addresses in the whitelist.
Ip			The list of IP addresses in the whitelist.
IpVersion	Integer	6	The IP version. The version can be IPv4 or IPv6.
RequestId	String	98B9E411-33C5-4499-9A93-4FE3FFDBC53C	The ID of the request. It is the unique ID that is dynamically generated for the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeIpWhitelist
 &ClusterId=hb-bp16f1441y6p2kv**
&<Common request parameters>

Sample success responses

XML format

<Groups>
    <Group>
        <IP>127.0.0.1</IP>
        <IP>192.168.0.1</IP>
        <IpVersion>4</IpVersion>
    </Group>
    <Group>
        <IP>127.0.0.1</IP>
        <IP>192.168.0.1</IP>
        <IpVersion>4</IpVersion>
    </Group>
</Groups>
<RequestId>98B9E411-33C5-4499-9A93-4FE3FFDBC53C</RequestId>

JSON format

{
	"Groups":{
		"Group":[
			{
				"IP":[
					"127.0.0.1",
					"192.168.0.1"
				],
				"IpVersion":4
			},
			{
				"IP":[
					"127.0.0.1",
					"192.168.0.1"
				],
				"IpVersion":4
			}
		]
	},
	"RequestId":"98B9E411-33C5-4499-9A93-4FE3FFDBC53C"
}

Error codes

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