listShards（データベースコマンド）

定義

listShards

listShardsコマンドは、シャーディングされたクラスター内の構成されたシャードのリストを返します。 listShardsは mongosインスタンスでのみ使用でき、 adminデータベースに対して発行する必要があります。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

このコマンドの構文は、次のとおりです。

db.runCommand(
  {
    listShards: 1
  }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

出力フィールド

listShards は、次の内容を含むドキュメントを返します。

• それぞれが 1 つのシャードを説明するドキュメントの配列を含むshardsフィールド。 各ドキュメントには、次のフィールドを含めることができます。

  フィールド	説明
  _id	シャードの名前。
  host	シャードのホスト名。シャードがレプリカセットの場合、host はレプリカセット内の各mongodインスタンスのホスト名を一覧表示します。
  draining	trueの場合、 は、このシャードに対して または コマンドが呼び出され、ドレインstartShardDraining removeShardプロセス中であることを示します。
  tags	シャードが属するゾーンのリスト。
  state	シャードをクラスターに追加するために必要なすべての手順と構成が完了していることを確認するために、addShard（データベースコマンド）シーケンス中に使用される内部フィールド。

• 操作のokステータス フィールド、 operationTimeフィールド、 $clusterTimeフィールド。 これらのフィールドの詳細については、「応答 」を参照してください。

例

次の操作は、listShards mongosadminデータベースに対して を実行します。

db.adminCommand({ listShards: 1 })

次のドキュメントは、 listShardsコマンドからの出力の例えです。

{
  "shards": [
    {
      "_id": "shard01",
      "host": "shard01/host1:27018,host2:27018,host3:27018",
      "state": 1
    },
    {
      "_id": "shard02",
      "host": "shard02/host4:27018,host5:27018,host6:27018",
      "tags": [ "NYC" ],
      "state": 1
    },
    {
      "_id": "shard03",
      "host": "shard03/host7:27018,host8:27018,host9:27018",
      "state": 1
    }
  ],
  "ok": 1,
  "$clusterTime" : {
     "clusterTime" : Timestamp(1510716515, 1),
     "signature" : {
        "hash" : BinData(0,"B2ViX7XLzFLS5Fl9XEuFXbwKIM4="),
        "keyId" : Long("6488045157173166092")
     }
  },
  "operationTime" : Timestamp(1510716515, 1)
}