すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeRoleZoneInfo

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeRoleZoneInfo

    最終更新日:Jan 21, 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:DescribeRoleZoneInfo

    get

    *dbinstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bpxxxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    728B9A96-E262-4AE5-915E-3A51CCE2FDA9
    ZoneInfos

    object

    ZoneInfo

    array<object>

    ゾーン内のノードの情報。

    object

    InsName

    string

    ノードの ID。

    dds-bpxxxxxxxx
    NodeType

    string

    ノードのタイプ。有効な値：

    • normal

    • configServer

    • shard

    • mongos

    説明

    レプリカセットインスタンスの有効な値：normal。シャードクラスターインスタンスの有効な値：configServer、shard、および mongos。

    normal
    RoleType

    string

    ノードのロール。有効な値：

    • Primary：プライマリ

    • Secondary：セカンダリ

    • Hidden

    Primary
    ZoneId

    string

    ノードのゾーン ID。

    cn-hangzhou-e
    RoleId

    string

    ロール ID。

    83xxxxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "728B9A96-E262-4AE5-915E-3A51CCE2FDA9",
  "ZoneInfos": {
    "ZoneInfo": [
      {
        "InsName": "dds-bpxxxxxxxx",
        "NodeType": "normal",
        "RoleType": "Primary",
        "ZoneId": "cn-hangzhou-e",
        "RoleId": "83xxxxx"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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