DescribeAccounts查詢資料庫帳號資訊-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB執行個體的資料庫帳號資訊。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeAccounts

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-bp1fd530f271****
AccountName	string	否	帳號名。	root

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts	object
Account	array<object>	帳號資訊列表。
	object
CharacterType	string	帳號的角色類型，取值說明： db: shard 角色。 cs：config server 角色。 mongos：mongos 角色。 logic：分區叢集執行個體。 normal：複本集執行個體。	mongos
AccountStatus	string	帳號的狀態，取值說明： Unavailable：不可用。 Available：可用。	Available
AccountDescription	string	帳號備忘資訊。說明調用 ModifyAccountDescription 介面設定帳號備忘資訊後才會返回該參數。	管理員
DBInstanceId	string	帳號所屬的執行個體 ID。	dds-bp1fd530f271****
AccountName	string	帳號名。	root

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B562A65B-39AB-4EE8-8635-5A222054FB35",
  "Accounts": {
    "Account": [
      {
        "CharacterType": "mongos",
        "AccountStatus": "Available",
        "AccountDescription": "管理員",
        "DBInstanceId": "dds-bp1fd530f271****",
        "AccountName": "root"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	ResponseEmptyError	The Response is empty, maybe server request timeout.

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

變更歷史

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