すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeShardingNetworkAddress

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeShardingNetworkAddress

    最終更新日:Apr 10, 2026

    MongoDB シャードクラスターインスタンスの接続情報を取得します。

    操作説明

    この API はシャードクラスターインスタンス専用です。

    今すぐお試しください

    この 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:DescribeShardingNetworkAddress

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bpxxxxxxxx
    NodeId

    string

    任意

    シャードクラスターインスタンス内の Mongos、シャード、または ConfigServer ノードの ID。

    説明

    DescribeDBInstanceAttribute 操作を呼び出して、Mongos、シャード、および ConfigServer ノードの ID を照会できます。

    d-bpxxxxxxxx
    NetworkType

    string

    任意

    ネットワークタイプ。有効な値：

    • VPC：VPC。

    • Classic：クラシックネットワーク。

    • Public：パブリックネットワーク。

    VPC

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    CompatibleConnections

    object

    CompatibleConnection

    array<object>

    DynamoDB プロトコルと互換性のあるインスタンスの接続詳細。

    object

    VswitchId

    string

    VPC 内の vSwitch の ID。

    説明

    このパラメーターは、ネットワークタイプが VPC の場合にのみ返されます。

    vsw-bpxxxxxxxx
    ExpiredTime

    string

    保持されているクラシックネットワークアドレスの残りの有効期間 (秒単位)。

    2591963
    NetworkType

    string

    ネットワークタイプ。有効な値：

    • VPC：VPC。

    • Classic：クラシックネットワーク。

    • Public：パブリックネットワーク。

    VPC
    Port

    string

    インスタンスへの接続に使用されるポート。

    3717
    NetworkAddress

    string

    インスタンスのエンドポイント。

    dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com
    VPCId

    string

    VPC ID。

    説明

    このパラメーターは、ネットワークタイプが VPC の場合にのみ返されます。

    vpc-bpxxxxxxxx
    IPAddress

    string

    インスタンスの IP アドレス。

    10.140.xxx.xx
    RequestId

    string

    リクエスト ID。

    18D8AAFD-6BEB-420F-8164-810CB0C0AA39
    NetworkAddresses

    object

    NetworkAddress

    array<object>

    MongoDB プロトコルを使用するインスタンスの接続詳細。

    object

    NodeType

    string

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

    • mongos：Mongos ノード。

    • shard：シャードノード。

    • configserver：ConfigServer ノード。

    mongos
    VswitchId

    string

    VPC 内の vSwitch の ID。

    説明

    このパラメーターは、ネットワークタイプが VPC の場合にのみ返されます。

    vsw-bpxxxxxxxx
    ExpiredTime

    string

    保持されているクラシックネットワークアドレスの残りの有効期間 (秒単位)。

    2591963
    NetworkType

    string

    ネットワークタイプ。有効な値：

    • VPC：VPC。

    • Classic：クラシックネットワーク。

    • Public：パブリックネットワーク。

    VPC
    Role

    string

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

    • Primary：プライマリノード。

    • Secondary：セカンダリノード。

    Primary
    Port

    string

    インスタンスへの接続に使用されるポート。

    3717
    VPCId

    string

    VPC ID。

    説明

    このパラメーターは、ネットワークタイプが VPC の場合にのみ返されます。

    vpc-bpxxxxxxxx
    NetworkAddress

    string

    ノードのエンドポイント。

    s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
    NodeId

    string

    Mongos またはシャードノードの ID。

    s-bpxxxxxxxx
    IPAddress

    string

    ノードの IP アドレス。

    10.140.xxx.xx
    ConnectionType

    string

    パブリックエンドポイントのタイプ。有効な値：

    • SRV

    • Normal

    SRV
    TxtRecord

    string

    TXT レコード。TXT レコードは、ドメインに関するテキストベースの情報を格納するために使用される DNS (Domain Name System) レコードの一種です。SRV レコードなどの他のテクノロジーと連携して、サービス構成の配信やサービスの検出に使用できます。

    mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
    ConnectionStringSuffix

    string

    接続文字列のサフィックス。

    .mongodb.rds.aliyuncs.com

    例

    成功レスポンス

    JSONJSON

    {
  "CompatibleConnections": {
    "CompatibleConnection": [
      {
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Port": "3717",
        "NetworkAddress": "dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com",
        "VPCId": "vpc-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx"
      }
    ]
  },
  "RequestId": "18D8AAFD-6BEB-420F-8164-810CB0C0AA39",
  "NetworkAddresses": {
    "NetworkAddress": [
      {
        "NodeType": "mongos",
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Role": "Primary",
        "Port": "3717",
        "VPCId": "vpc-bpxxxxxxxx",
        "NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NodeId": "s-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx",
        "ConnectionType": "SRV",
        "TxtRecord": "mongo.example.com. IN TXT \"config=replicaSet=myReplicaSet\""
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com"
}

    エラーコード

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

    変更履歴

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