全部產品
Search

搜尋本產品

    PolarDB：DescribeAccounts - 查詢資料庫帳號資訊

    文件中心

    PolarDB：DescribeAccounts - 查詢資料庫帳號資訊

    更新時間：Dec 15, 2025

    查詢PolarDB叢集的資料庫帳號資訊。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeAccounts

    get

    *dbcluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    pc-***************
    AccountName

    string

    否

    帳號名稱。

    test_acc
    NodeType

    string

    否

    節點類型，查詢 PolarDB Search-節點帳號時需要傳入

    • Search

    Search
    PageNumber

    integer

    否

    頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數。預設值為 1。

    1
    PageSize

    integer

    否

    每頁記錄數，取值範圍：

    • 30

    • 50

    • 100

    預設值為 30。

    30

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageRecordCount

    integer

    本頁記錄數。

    1
    RequestId

    string

    請求 ID。

    155462B9-205F-4FFC-BB43-4855FE******
    PageNumber

    integer

    頁碼。

    1
    Accounts

    array<object>

    帳號資訊詳情。

    array<object>

    AccountDescription

    string

    帳號備忘。

    test
    AccountStatus

    string

    帳號狀態。取值範圍：

    • Creating：建立中。

    • Available：可用。

    • Deleting：刪除中。

    Available
    AccountLockState

    string

    帳號鎖定狀態。取值範圍：

    • UnLock：未鎖定。

    • Lock：鎖定。

    UnLock
    AccountPasswordValidTime

    string

    密碼到期時間。

    undefined
    AccountType

    string

    賬戶類型。取值範圍：

    • Normal：普通帳號。

    • Super：高許可權帳號。

    • ReadOnly：全域唯讀帳號。

    Normal
    DatabasePrivileges

    array<object>

    目標帳號擁有的資料庫許可權詳情。

    object

    AccountPrivilege

    string

    帳號許可權。

    ReadOnly
    DBName

    string

    資料庫名稱。

    DBtest
    AccountName

    string

    帳號名。

    test_acc

    樣本

    正常返回樣本

    JSON格式

    {
  "PageRecordCount": 1,
  "RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber": 1,
  "Accounts": [
    {
      "AccountDescription": "test",
      "AccountStatus": "Available",
      "AccountLockState": "UnLock",
      "AccountPasswordValidTime": "undefined",
      "AccountType": "Normal",
      "DatabasePrivileges": [
        {
          "AccountPrivilege": "ReadOnly",
          "DBName": "DBtest"
        }
      ],
      "AccountName": "test_acc"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定的參數PageSize無效
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定的參數PageNumber無效
    400 Database.ConnectError db instance %s connect failed, please check instance status and database processlist 資料庫執行個體串連失敗，請檢查執行個體狀態和資料庫進程列表
    400 Account.QueryError Instance %s query account error 執行個體%s查詢帳戶錯誤
    400 Connect.Timeout Service can not connect to instance temporarily. 服務暫時無法串連到執行個體
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

    變更歷史

    更多資訊，參考變更詳情。