Queries the relationship between a cluster and a global IP whitelist template.


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 DescribeGlobalSecurityIPGroupRelation

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

RegionId String Yes cn-hangzhou

The region ID of the cluster.

DBClusterId String Yes pc-*****************

The ID of the cluster.

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

The ID of the resource group.

Response parameters

Parameter Type Example Description
DBClusterId String pc-*****************

The ID of the cluster.

RequestId String 9B7BFB11-C077-4FE3-B051-F69CEB******

The ID of the request.

GlobalSecurityIPGroupRel Array of GlobalSecurityIPGroupRel

The information of the global IP whitelist template.

GlobalSecurityGroupId String g-zsldxfiwjmti0kcm****

The ID of the IP whitelist template.

GIpList String

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.

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.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "DBClusterId" : "pc-*****************",
  "RequestId" : "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "GlobalSecurityIPGroupRel" : [ {
    "GlobalSecurityGroupId" : "g-zsldxfiwjmti0kcm****",
    "GIpList" : "",
    "RegionId" : "cn-hangzhou",
    "GlobalIgName" : "test_123"
  } ]

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.

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