すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeAccounts

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeAccounts

    最終更新日:Jan 26, 2026

    ApsaraDB for MongoDB インスタンスのデータベースアカウントを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:DescribeAccounts

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bp1fd530f271****
    AccountName

    string

    任意

    アカウント名。値を root に設定します。

    root

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B562A65B-39AB-4EE8-8635-5A222054FB35
    Accounts

    object

    Account

    array<object>

    アカウントの詳細。

    object

    CharacterType

    string

    アカウントのロール。有効値：

    • db：シャードノード

    • cs：ConfigServer ノード

    • mongos：Mongos ノード

    • logic：シャードクラスターインスタンス

    • normal：レプリカセットインスタンス

    mongos
    AccountStatus

    string

    アカウントのステータス。有効値：

    • Unavailable

    • Available

    Available
    AccountDescription

    string

    アカウントの説明。

    管理员
    DBInstanceId

    string

    アカウントが属するインスタンスの ID。

    dds-bp1fd530f271****
    AccountName

    string

    アカウント名。

    root

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 ResponseEmptyError The Response is empty, maybe server request timeout.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。