DescribeGlobalSecurityIPGroupRelation - ApsaraDB for MongoDB

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:DescribeGlobalSecurityIPGroupRelation

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the available regions.	cn-hangzhou
DBClusterId	string	Yes	The instance ID.	dds-2ze6069764423m0l

Response elements

Element	Type	Description	Example
	object
DBClusterId	string	The instance ID.	dds-2ze6069764423m0l
RequestId	string	The ID of the request. If you encounter a problem, provide this ID to our support staff for troubleshooting.	F8CA8312-530A-413A-9129-F2BB32A8D404
GlobalSecurityIPGroupRel	array<object>	The mapping of the global IP address whitelist template.
	object	The mapping of the global IP address whitelist template.
GlobalSecurityGroupId	string	The ID of the IP address whitelist template.	g-gfurfpsh4ycbrm2avst7
GIpList	string	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas. A maximum of 1,000 IP addresses or CIDR blocks can be added across all IP address whitelists.	27.16.214.10,111.60.117.181
RegionId	string	The region ID.	cn-hongkong
GlobalIgName	string	The name of the IP address whitelist template.	dev_baoxian_k8s_bj

Examples

Success response

JSON format

{
  "DBClusterId": "dds-2ze6069764423m0l",
  "RequestId": "F8CA8312-530A-413A-9129-F2BB32A8D404",
  "GlobalSecurityIPGroupRel": [
    {
      "GlobalSecurityGroupId": "g-gfurfpsh4ycbrm2avst7",
      "GIpList": "27.16.214.10,111.60.117.181",
      "RegionId": "cn-hongkong",
      "GlobalIgName": "dev_baoxian_k8s_bj"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	RequiredParam.NotFound	Required input param is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.