文档菜单
文档首页
/
MongoDB 手册
/
参考
/
数据库命令
/
分片

listShards

在本页

  • 定义
  • 兼容性
  • 语法
  • 示例
  • 输出

定义

listShards

命令listShards 命令返回一个分片集群中配置的分片列表。 listShards 只在mongos 实例上可用，并且必须针对 admin 数据库执行。

兼容性

此命令在以下环境中部署的部署中可用

  • MongoDB Atlas：MongoDB在云中的部署的全托管服务

重要

此命令不支持在无服务器实例中。有关更多信息，请参阅 不受支持的命令。

语法

该命令具有以下语法

db.runCommand(
  {
    listShards: 1
  }
)

示例

以下操作在 listShards 命令中运行 mongos admin 数据库

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" : NumberLong("6488045157173166092")
     }
  },
  "operationTime" : Timestamp(1510716515, 1)
}

输出

listShards 返回一个文档，该文档包含

  • 一个 shards 字段，该字段包含一个文档数组，每个文档描述一个分片。每个文档可能包含以下字段

    字段
    描述
    _id
    分片名称。
    host
    分片的计算机名。如果分片是副本集，则 host 列出副本集中每个 mongod 实例的计算机名。
    draining
    如果为真，则表示已调用 removeShard 命令来删除此分片，并且它正在被清理。
    tags
    该分片所属的 区域 列表。
    state
    在执行 addShard 序列过程中使用的内部字段，以确保将分片添加到集群所需的所有步骤和配置都已完成。

  • 操作状态字段 ok，操作时间字段 operationTime 以及操作相关字段 $clusterTime。关于这些字段的详细信息，请参阅 响应。

返回

isdbgrid

下一步

mergeAllChunksOnShard