DescribeGlobalSecurityIPGroup API Reference - PolarDB - Alibaba Cloud - PolarDB

Queries the list of global IP allowlist templates.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeGlobalSecurityIPGroup

get

*All Resource

*

None

Request parameters

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

Response elements

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

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.