文档

DescribeClusterAccessWhiteList - 查询白名单

更新时间:

查看指定AnalyticDB MySQL湖仓版(3.0)集群的IP白名单。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

amv-bp11q28kvl688****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

370D09FD-442A-5225-AAD3-7362CAE39177
Itemsobject []

AnalyticDB MySQL 湖仓版(3.0)集群的 IP 白名单分组列表。

DBClusterIPArrayAttributestring

白名单分组属性。

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

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

127.0.xx.xx
DBClusterIPArrayNamestring

IP 白名单分组名称。

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

test

示例

正常返回示例

JSON格式

{
  "RequestId": "370D09FD-442A-5225-AAD3-7362CAE39177",
  "Items": {
    "IPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "SecurityIPList": "127.0.xx.xx",
        "DBClusterIPArrayName": "test"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.DBClusterId参数不正确,请确认参数是否符合规范。

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

变更历史

变更时间变更内容概要操作
2023-03-31OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
  • 本页导读 (1)
文档反馈