全部產品
Search
文件中心

:DescribeDBClusterAccessWhitelist - 查看叢集的IP白名單

更新時間:Dec 11, 2025

查看允許訪問資料庫叢集的IP白名單和安全性群組。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBClusterAccessWhitelist

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

pc-***************

返回參數

名稱

類型

描述

樣本值

object

DBClusterSecurityGroups

object

DBClusterSecurityGroup

array<object>

叢集關聯的 ECS 安全性群組列表。

object

SecurityGroupId

string

ECS 安全性群組 ID。

sg-bp**************

SecurityGroupName

string

ECS 安全性群組名稱。

vpc-********************

Items

object

DBClusterIPArray

array<object>

叢集的 IP 白名單分組列表。

object

DBClusterIPArrayAttribute

string

IP 白名單分組屬性。

hidden

DBClusterIPArrayName

string

IP 白名單分組名稱。

default

SecurityIps

string

IP 白名單分組下的 IP 列表,最多 1000 個,多個 IP 間用英文逗號(,)隔開,支援如下兩種格式:

  • IP 位址形式,例如:10.xx.xx.24。

  • CIDR 形式,例如:10.xx.xx.24/24(無類域間路由,24 表示了地址中首碼的長度,範圍為 1~32)。

11.***.***.***,11.***.***.***

RequestId

string

請求 ID。

559E91A2-CDA3-4E9F-808B-29D738******

樣本

正常返回樣本

JSON格式

{
  "DBClusterSecurityGroups": {
    "DBClusterSecurityGroup": [
      {
        "SecurityGroupId": "sg-bp**************",
        "SecurityGroupName": "vpc-********************"
      }
    ]
  },
  "Items": {
    "DBClusterIPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "DBClusterIPArrayName": "default",
        "SecurityIps": "11.***.***.***,11.***.***.***"
      }
    ]
  },
  "RequestId": "559E91A2-CDA3-4E9F-808B-29D738******"
}

異常返回樣本

JSON格式

{
    "Items":{
        "DBClusterIPArray":[
            {
                "DBClusterIPArrayAttribute":"",
                "DBClusterIPArrayName":"default",
                "SecurityIPList":"127.0.0.1"
            },
            {
                "DBClusterIPArrayAttribute":"hidden",
                "DBClusterIPArrayName":"maxscale",
                "SecurityIPList":"11.xx.xx.xx,11.xx.xx.201"
            }
        ]
    },
    "RequestId":"8D0429EC-8E2C-4675-8102-28AC6FE92751"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM.
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情