DescribeDBClusterAccessWhiteList - 查询集群的IP白名单

更新时间:
复制 MD 格式

调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeDBClusterAccessWhiteList

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

无 无

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

是

集群 ID。

am-uf6wjk5xxxxxxxxxx

RegionId

string

否

地域 ID。

说明

您可以调用 DescribeRegions 接口查看指定 AnalyticDB MySQL 数仓版支持的地域 ID。

cn-qingdao

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF

Items

object

IPArray

array<object>

IP 白名单分组列表。

object

DBClusterIPArrayAttribute

string

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

说明

控制台不显示带有 hidden 属性的分组,带有该标签的分组通常是用于访问 DTS、DRDS 服务的。

hidden

SecurityIPList

string

IP 白名单分组下的 IP 列表,最多 1000 个,以英文逗号(,)隔开。

127.0.0.1

DBClusterIPArrayName

string

IP 白名单分组名称。

  • IP 白名单分组名称以小写字母开头、以数字或小写字母结尾,可包含小写字母、数字及’_’,长度为 2~32。

  • 单个集群最多支持 50 个白名单分组。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "IPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "SecurityIPList": "127.0.0.1",
        "DBClusterIPArrayName": "test"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

更多信息,参考变更详情。