All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeSecurityIps

Last Updated:Mar 15, 2024

Queries the IP address whitelists 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:DescribeSecurityIpsREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

dds-bpxxxxxxxx
ShowHDMIpsbooleanNo

Whether to display DAS whitelist information.

Enumeration Value:
  • true: true.
  • false: false.
true

Response parameters

ParameterTypeDescriptionExample
object
SecurityIpsstring

The IP addresses in the default whitelist.

47.xxx.xxx.xx,100.xxx.xxx.0/24
RequestIdstring

The ID of the request.

FC724D23-2962-479E-ABB1-606C935AE7FD
SecurityIpGroupsobject []

An array that consists of the information of IP whitelists.

SecurityIpGroupNamestring

The name of the IP whitelist.

default
SecurityIpGroupAttributestring

The attribute of the IP address whitelist.

hidden
SecurityIpListstring

The name of the IP whitelist.

47.xxx.xxx.xx,100.xxx.xxx.0/24

Examples

Sample success responses

JSONformat

{
  "SecurityIps": "47.xxx.xxx.xx,100.xxx.xxx.0/24",
  "RequestId": "FC724D23-2962-479E-ABB1-606C935AE7FD",
  "SecurityIpGroups": {
    "SecurityIpGroup": [
      {
        "SecurityIpGroupName": "default",
        "SecurityIpGroupAttribute": " hidden",
        "SecurityIpList": "47.xxx.xxx.xx,100.xxx.xxx.0/24"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400InvalidDBInstance.MalformedToo many instance ids or instance id format is invalid.

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

Change history

Change timeSummary of changesOperation
2023-12-26API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ShowHDMIps
2023-12-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400