DescribeGlobalSecurityIPGroup - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the global IP whitelist template of an ApsaraDB for MongoDB instance.

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

dds:DescribeGlobalSecurityIPGroup

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the most recent region list.	cn-hangzhou
GlobalSecurityGroupId	string	No	The ID of the IP whitelist template.	g-hedmu8kg9nsabw6u42rv

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.	72651AF9-7897-41A7-8B67-6C15C7F26A0A
GlobalSecurityIPGroup	array<object>	The global IP whitelist templates.
	object	The global IP whitelist template.
GlobalSecurityGroupId	string	The ID of the IP whitelist template.	g-sdgwqyp4f5j1x3qk7yvm
GlobalIgName	string	The name of the IP whitelist template.	dev_baoxian_k8s_bj
GIpList	string	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.	117.12.202.19
RegionId	string	The region ID of the instance.	cn-hangzhou
DBInstances	array	The instances associated with the global whitelist template.
	string	The instance ID.	[dds-asdxxxx,dds-afrexxxxxx]

Examples

Success response

JSON format

{
  "RequestId": "72651AF9-7897-41A7-8B67-6C15C7F26A0A",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-sdgwqyp4f5j1x3qk7yvm",
      "GlobalIgName": "dev_baoxian_k8s_bj",
      "GIpList": "117.12.202.19",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "[dds-asdxxxx,dds-afrexxxxxx]"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	RequiredParam.NotFound	Required input param is not found.
400	InvalidAction	Specified action is not valid.	Service exception.
404	InvalidUser.NotFound	Specified user does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.