DescribeGlobalSecurityIPGroupRelation - ApsaraDB for MongoDB

Queries the global IP whitelist templates associated with an ApsaraDB for MongoDB instance.

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
dds:DescribeGlobalSecurityIPGroupRelation	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The instance ID.	dds-2ze6069764423m0l

Response parameters

Parameter	Type	Description	Example
	object
DBClusterId	string	The instance ID.	dds-2ze6069764423m0l
RequestId	string	The unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.	F8CA8312-530A-413A-9129-F2BB32A8D404
GlobalSecurityIPGroupRel	array<object>	The global IP whitelist templates associated with the instance.
	object	The global IP whitelist template associated with the instance.
GlobalSecurityGroupId	string	The ID of the IP whitelist template.	g-gfurfpsh4ycbrm2avst7
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 whitelists.	27.16.214.10,111.60.117.181
RegionId	string	The region ID of the instance.	cn-hongkong
GlobalIgName	string	The name of the IP whitelist template.	dev_baoxian_k8s_bj

Examples

Sample success responses

JSONformat

{
  "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
400	RequiredParam.NotFound	Required input param is not found.

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