All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeGlobalSecurityIPGroup

Last Updated:Sep 03, 2024

Queries the global IP whitelist template of 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeGlobalSecurityIPGrouplist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the most recent region list.

cn-hangzhou
GlobalSecurityGroupIdstringNo

The ID of the IP whitelist template.

g-hedmu8kg9nsabw6u42rv

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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
GlobalSecurityIPGrouparray<object>

The global IP whitelist templates.

object

The global IP whitelist template.

GlobalSecurityGroupIdstring

The ID of the IP whitelist template.

g-sdgwqyp4f5j1x3qk7yvm
GlobalIgNamestring

The name of the IP whitelist template.

dev_baoxian_k8s_bj
GIpListstring

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
RegionIdstring

The region ID of the instance.

cn-hangzhou
DBInstancesarray

The instances associated with the global whitelist template.

string

The instance ID.

[dds-asdxxxx,dds-afrexxxxxx]

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400RequiredParam.NotFoundRequired input param is not found.
400InvalidActionSpecified action is not valid.
404InvalidUser.NotFoundSpecified user does not exist.

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

Change history

Change timeSummary of changesOperation
No change history