DescribeGlobalSecurityIPGroup - PolarDB - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeGlobalSecurityIPGroup	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group.	rg-************
RegionId	string	Yes	The region ID of the IP whitelist template.	cn-hangzhou
GlobalSecurityGroupId	string	No	The ID of the IP whitelist template.	g-zsldxfiwjmti0kcm****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	9B7BFB11-C077-4FE3-B051-F69CEB******
GlobalSecurityIPGroup	object []	The details of the global IP whitelist template.
GlobalSecurityGroupId	string	The ID of the global IP whitelist template.	g-zsldxfiwjmti0kcm****
GlobalIgName	string	The name of the global IP whitelist template. The name 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 a digit. The name must be 2 to 120 characters in length.	test_123
GIpList	string	The IP address in the global IP whitelist template. Note Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.	192.168.0.1
RegionId	string	The ID of the region.	cn-hangzhou
DBInstances	array	The details of the clusters that are associated with the global IP address whitelist template.
	string	The IDs of the clusters that are associated with the global IP whitelist template.	["pc-2zetn0f1b8zwb**","pc-**"]

Examples

Sample success responses

JSONformat

{
  "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 specified parameter does not exist.
400	InvalidAction	Specified action is not valid.	The specified action is invalid.
404	InvalidUser.NotFound	Specified user does not exist.	The specified account does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-05-11

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404