文档

DescribeDBClusterAccessWhiteList - 查看集群的IP白名单

更新时间:

查看指定云数据库ClickHouse集群的IP白名单。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

cc-bp108z124a8o7****

返回参数

名称类型描述示例值
object
DBClusterAccessWhiteListarray<object>

白名单分组列表。

object
DBClusterIPArrayAttributestring

白名单分组属性。

default
SecurityIPListstring

白名单分组下的 IP 列表。

192.168.xx.xx,192.168.xx.xx
DBClusterIPArrayNamestring

白名单分组名称。

default
RequestIdstring

请求 ID。

905F13A4-5097-4897-A84D-527EC75FFF4F

示例

正常返回示例

JSON格式

{
  "DBClusterAccessWhiteList": {
    "IPArray": [
      {
        "DBClusterIPArrayAttribute": "default",
        "SecurityIPList": "192.168.xx.xx,192.168.xx.xx",
        "DBClusterIPArrayName": "default"
      }
    ]
  },
  "RequestId": "905F13A4-5097-4897-A84D-527EC75FFF4F"
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史