全部产品
Search
文档中心

云数据库 MongoDB:DescribeSecurityIps - 查询MongoDB实例的IP白名单

更新时间:Mar 15, 2024

查询MongoDB实例的IP白名单。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:DescribeSecurityIpsRead
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

dds-bpxxxxxxxx
ShowHDMIpsboolean

是否展示 DAS 白名单信息。

枚举值:
  • true展示DAS白名单信息
  • false不展示DAS白名单信息
true

返回参数

名称类型描述示例值
object
SecurityIpsstring

默认分组中包含的 IP 白名单。

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

请求 ID。

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

IP 白名单分组列表。

SecurityIpGroupNamestring

分组名。

default
SecurityIpGroupAttributestring

IP 白名单分组属性,默认为空。

hidden
SecurityIpListstring

分组中包含的 IP 白名单列表。

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

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidDBInstance.MalformedToo many instance ids or instance id format is invalid.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ShowHDMIps
2023-12-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400