Queries global IP whitelist templates.

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 DescribeGlobalSecurityIPGroup

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

ResourceGroupId String No rg-************

The ID of the resource group.

RegionId String Yes cn-hangzhou

The region ID of the cluster.

GlobalSecurityGroupId String No g-zsldxfiwjmti0kcm****

The ID of the IP whitelist template.

Response parameters

Parameter Type Example Description
RequestId String 9B7BFB11-C077-4FE3-B051-F69CEB******

The ID of the request.

GlobalSecurityIPGroup Array of GlobalSecurityIPGroup

The information of the global IP whitelist template.

GlobalSecurityGroupId String g-zsldxfiwjmti0kcm****

The ID of the IP whitelist template.

GlobalIgName String test_123

The name of the IP whitelist template. The name of the IP whitelist template must meet the following requirements:

  • The name can contain lowercase letters, digits, and underscores (_).
  • The name must start with a letter and end with a letter or digit.
  • The name must be 2 to 120 characters in length.
GIpList String 192.168.0.1

The IP address in the whitelist template.

Note Multiple IP addresses are separated with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.
RegionId String cn-hangzhou

The region ID of the cluster.

DBInstances Array of String ["pc-2zetn0f1b8zwb****","pc-****"]

The IDs of the clusters associated with the IP whitelist template.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeGlobalSecurityIPGroup
&ResourceGroupId=rg-************
&RegionId=cn-hangzhou
&GlobalSecurityGroupId=g-zsldxfiwjmti0kcm****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeGlobalSecurityIPGroupResponse>
    <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>
    <GlobalSecurityIPGroup>
        <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>
        <GlobalIgName>test_123</GlobalIgName>
        <GIpList>192.168.0.1</GIpList>
        <RegionId>cn-hangzhou</RegionId>
        <DBInstances>["pc-2zetn0f1b8zwb****","pc-****"]</DBInstances>
    </GlobalSecurityIPGroup>
</DescribeGlobalSecurityIPGroupResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "GlobalSecurityIPGroup" : [ {
    "GlobalSecurityGroupId" : "g-zsldxfiwjmti0kcm****",
    "GlobalIgName" : "test_123",
    "GIpList" : "192.168.0.1",
    "RegionId" : "cn-hangzhou",
    "DBInstances" : [ "[\"pc-2zetn0f1b8zwb****\",\"pc-****\"]" ]
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 RequiredParam.NotFound Required input param is not found. The error message returned because the specified parameter does not exist.
400 InvalidAction Specified action is not valid. The error message returned because the specified action is invalid.
404 InvalidUser.NotFound Specified user does not exist. The error message returned because the specified user does not exist.

For a list of error codes, see Service error codes.