文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

清单

属性

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见 资源属性 0.6
description 请参见 资源属性 是 0.6
zoneUuid 父区域的uuid 0.6
totalCapacity 磁盘总容量，单位为字节 0.6
availableCapacity 可用磁盘空间，单位为字节 0.6
url 请参见 url 0.6
type 主存储类型
  • SharedMountPoint
  • XSky
  • Ceph
  • NFS
  • ZSES
  • VCenter
  • LocalStorage
 0.6
state 请参见 state
  • Enabled
  • Disabled
 0.6
status 请参见 status
  • Connecting
  • Connected
  • Disconnected
 0.6
attachedClusterUuids 主存储已经挂载了的集群uuid列表 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6

示例

{
    "inventories": {
            "attachedClusterUuids": [
                "967a353c2893409dab9312cf3033a98c"
            ],
            "availableCapacity": 152897413120,
            "availablePhysicalCapacity": 186166145024,
            "createDate": "Oct 30, 2017 3:05:29 PM",
            "description": "",
            "lastOpDate": "Oct 31, 2017 10:41:26 AM",
            "mountPath": "/Cloud_ps",
            "name": "LS-1",
            "state": "Enabled",
            "status": "Connected",
            "systemUsedCapacity": 9330311168,
            "totalCapacity": 205177397248,
            "totalPhysicalCapacity": 205177397248,
            "type": "LocalStorage",
            "url": "/Cloud_ps",
            "uuid": "037bd212f7a1488da4f94360ccfaf6ab",
            "zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
        }
}
名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.3.2
name 请参见 资源属性 2.3.2
description 请参见 资源属性 是 2.3.2
zoneUuid 区域UUID 2.3.2
url 未使用 2.3.2
totalCapacity 总空间 2.3.2
availableCapacity 可用空间 2.3.2
totalPhysicalCapacity 总物理空间 2.3.2
availablePhysicalCapacity 物理可用空间 2.3.2
systemUsedCapacity 系统使用空间 2.3.2
type 主存储类型
  • sharedblock
 2.3.2
state state 2.3.2
status 请参见 status 2.3.2
mountPath 未使用 2.3.2
attachedClusterUuids 挂载的集群 2.3.2
sharedBlocks 2.3.2
sharedBlockGroupType 2.3.2
createDate 请参见 资源属性 2.3.2
lastOpDate 请参见 资源属性 2.3.2
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 2.3.2
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.3.2
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.3.2
示例：
{
    "inventories": [
        {
            "attachedClusterUuids": [
                "4fe9c130224c4e59b0e8f3c5154c2cf6"
            ],
            "availableCapacity": 401458101248,
            "availablePhysicalCapacity": 400363094016,
            "createDate": "Jul 19, 2018 7:59:08 PM",
            "description": "",
            "lastOpDate": "Jul 19, 2018 8:01:37 PM",
            "mountPath": "SharedBlock",
            "name": "ps2-cluster3",
            "sharedBlockGroupType": "LvmVolumeGroupBasic",
            "sharedBlocks": [
                {
                    "createDate": "Jul 19, 2018 7:59:08 PM",
                    "diskUuid": "scsi-360014056cc00bd98c3740eeb9955af2c",
                    "lastOpDate": "Jul 19, 2018 7:59:08 PM",
                    "name": "disk-scsi-360014056cc00bd98c3740eeb9955af2c",
                    "sharedBlockGroupUuid": "17edb2c2f5b841069d043a28758434f6",
                    "state": "Enabled",
                    "status": "Connected",
                    "type": "LvmLogicalVolumeBasic",
                    "uuid": "37ce4c4747914c01919f5474d1c7edfe"
                },
],
            "state": "Enabled",
            "status": "Connected",
            "totalCapacity": 639883018240,
            "totalPhysicalCapacity": 639883018240,
            "type": "SharedBlock",
            "url": "sharedblock://ec6a1dbaf6d645a182e1f0e393eb0761",
            "uuid": "ec6a1dbaf6d645a182e1f0e393eb0761",
            "zoneUuid": "ddad0dc2c4bd4ffbb53147ea3dbf15c3"
        }
    ],
    "success": true
}
名字 描述 可选的 可选的参数值 起始支持版本
primaryStorageUuid 主存储UUID 2.3.2
hostUuid 物理机UUID 2.3.2
hostId 物理机ID 2.3.2
status 请参见 status
  • Connecting
  • Connected
  • Disconnected
 2.3.2
createDate 请参见 资源属性 2.3.2
lastOpDate 请参见 资源属性 2.3.2
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 2.3.2
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.3.2
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.3.2
示例：
{
    "inventories": [
        {
            "createDate": "Jul 19, 2018 7:59:09 PM",
            "hostId": 85,
            "hostUuid": "18fb1cf9713a4a50baf95fbaf37bfba6",
            "lastOpDate": "Jul 19, 2018 7:59:09 PM",
            "primaryStorageUuid": "17edb2c2f5b841069d043a28758434f6",
            "status": "Connected"
        }
    ],
    "success": true
}
名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.3.2
name 请参见 资源属性 2.3.2
description 请参见 资源属性 是 2.3.2
sharedBlockGroupUuid 共享块设备组UUID 2.3.2
diskUuid 磁盘唯一标示（例如UUID, WWN, WWID） 2.3.2
type 主存储类型
  • sharedblock
 2.3.2
state state 2.3.2
status 请参见 status 2.3.2
createDate 请参见 资源属性 2.3.2
lastOpDate 请参见 资源属性 2.3.2
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 2.3.2
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.3.2
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.3.2
示例：
{
    "inventories": [
        {
            "createDate": "Jul 17, 2018 8:50:14 PM",
            "diskUuid": "lvm-pv-uuid-h6Zlks-feeq-Jonz-eXLw-tyso-NPXn-6B6jfs",
            "lastOpDate": "Jul 17, 2018 8:50:14 PM",
            "name": "disk-lvm-pv-uuid-h6Zlks-feeq-Jonz-eXLw-tyso-NPXn-6B6jfs",
            "sharedBlockGroupUuid": "ec6a1dbaf6d645a182e1f0e393eb0761",
            "state": "Enabled",
            "status": "Connected",
            "type": "LvmLogicalVolumeBasic",
            "uuid": "08dad40070054309b00d2174a1476675"
        }
],
    "success": true
}

容量（Capacity）

为了方便选择合适的主存储创建云盘，ZStack会监控主存储的容量。不同的主存储插件可能会汇报不同的磁盘容量：
  • 对于支持超分（over-provisioning）的主存储，汇报的存储容量会比实际的大；
  • 对于不支持超分的主存储，汇报的存储容量可能会小于或等于实际的大小。

NFS容量（NFS Capacity）

NFS不支持超分， 因此它的容量是用云盘的虚拟大小（volumes’ virtual sizes）根据以下公式计算出来的：
总容量 = NFS的总容量
可用容量  = 总容量 - sum(云盘的虚拟大小)

简单的说，云盘的虚拟大小就是当云盘被完全填满时的大小。例如，创建一个1G容量的云盘，在真正完全填满数据之前，可能会因为使用了thin-provisioning技术而实际只占用了10M的容量。

统一资源定位符（URL）

主存储需要使用URL字符串存储的信息来控制存储系统。虽然名字叫URL， 具体的字符串存储格式依据主存储的类型而定，并不完全等同于标准的URL规范，这样可以给插件更多的灵活性以存储一些不方便以URL格式存储的信息。

NFS主存储URL

对于NFS主存储， URL被编码为下面的格式：
nfs服务器的ip或域名:/目录的绝对路径
例如：
192.168.0.220:/storage/nfs/

可用状态（State）

主存储有两种可用状态：
  • Enabled：

    启用（Enabled）状态下，允许云盘被创建。

  • Disabled：

    禁用（Disabled）状态下，不允许云盘被创建。

连接状态（Status）

类似于物理机连接状态，主存储的连接状态反映了管理节点和主存储之间的命令通道的状态。命令通道是管理节点和主存储所代表的存储系统通信的途径；根据主存储类型的不同命令通道也可以不同，例如， 命令通道可以是ZStack管理节点和主存储之间的HTTP连接或者存储SDK（storage SDKs）提供的通信方法。

有三种连接状态：
  • Connecting：

    该状态时，一个ZStack管理节点正在尝试建立自己和主存储之间的命令通道，这时还不能在主存储上执行任何操作。

  • Connected：

    该状态时，ZStack管理节点和主存储之间的命令通道已经被成功建立，可以在主存储上执行操作。

  • Disconnected：

    在这种状态时，ZStack管理节点和主存储之间的命令通道丢失，这时不能在主存储上执行任何操作。

在ZStack管理节点启动过程中会开始和主存储建立命令通道，并且会在运行中周期性的向主存储发送ping命令（ping commands）以检查命令通道的健康状态；一旦某个主存储响应失败, 或者ping命令超时，主存储的连接状态就会变为Disconnected。

主存储的连接状态转换图如图 1所示：
图 1. 主存储连接转换图


可用状态（State）

可用状态和连接状态之间没有直接关系。可用状态代表了管理员针对主存储的意愿， 而连接状态代表了主存储的通信状况。

挂载集群（Attaching Cluster）

挂载集群是将主存储和兄弟集群（sibling clusters）关联，从而提供了一种灵活的方式维护主机和存储系统在实际数据中心里的关系。例如： 假设有一个集群（集群A）挂载了一个NFS主存储 （NFS1）， 如图 2所示：
图 2. 单集群挂载NFS主存储


一段时间后，集群A内存耗尽但主存储还有足够的磁盘空间，这时创建一个集群B，然后将NFS1挂载在集群B上。如图 3所示：
图 3. 多集群挂载NFS主存储


又运行一段时间之后， 集群A的硬件可能开始变得过时，这时停用集群A；添加一个新的更加强大的集群（集群C）挂载到NFS1上，然后将所有集群A中的主机设置为维护模式（maintenance mode），这样所有之前运行在集群A中的云主机都会被迁移到集群B或集群C；最后， 将NFS1从集群A卸载，然后删除集群A。现在，数据中心看起来如图 4所示：
图 4. 迁移后的数据中心


最后如果NFS1容量不够用了，可添加另外一个主存储（NFS2），并加载到集群B和集群C上，如图 5所示：
图 5. 多集群挂载多NFS主存储


Ceph主存储清单 (ceph primary storage inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 4.5.0
zoneUuid 区域UUID 4.5.0
name 资源名称 4.5.0
url 4.5.0
description 资源的详细描述 4.5.0
totalCapacity 4.5.0
availableCapacity 4.5.0
totalPhysicalCapacity 4.5.0
availablePhysicalCapacity 4.5.0
systemUsedCapacity 4.5.0
type 4.5.0
state 4.5.0
status 4.5.0
mountPath 4.5.0
attachedClusterUuids 4.5.0
createDate 请参见 资源属性 4.5.0
lastOpDate 请参见 资源属性 4.5.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 4.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 4.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 4.5.0

示例

{
    "inventories": [
        {
            "attachedClusterUuids": [
                "545f0cbcc81c443f8430b11b0ab502a3"
            ],
            "availableCapacity": 268544683008,
            "availablePhysicalCapacity": 312302694400,
            "createDate": "Oct 5, 2022 6:40:15 PM",
            "description": "Test Ceph PS",
            "fsid": "4abee524-df2c-454c-a7f2-8720583fa2fd",
            "lastOpDate": "Oct 5, 2022 10:25:16 PM",
            "mons": [
                {
                    "createDate": "Oct 5, 2022 6:40:15 PM",
                    "hostname": "172.24.242.143",
                    "lastOpDate": "Oct 5, 2022 10:25:14 PM",
                    "monAddr": "172.24.242.143",
                    "monPort": 6789,
                    "monUuid": "bad3797c823c4cc8a8f8dfaa68a2523f",
                    "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
                    "sshPassword": "password",
                    "sshPort": 22,
                    "sshUsername": "root",
                    "status": "Connected"
                }
            ],
            "mountPath": "Ceph",
            "name": "ceph-ps",
            "pools": [
                {
                    "availableCapacity": 273523715072,
                    "createDate": "Oct 5, 2022 6:40:15 PM",
                    "diskUtilization": 1.0,
                    "lastOpDate": "Oct 8, 2022 5:02:11 PM",
                    "poolName": "pri-v-r-f91bfce045274bf682589a8012763af3",
                    "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
                    "replicatedSize": 1,
                    "securityPolicy": "Copy",
                    "totalCapacity": 316598108160,
                    "type": "Root",
                    "usedCapacity": 4295413760,
                    "uuid": "5f758a0f66864f76ba214ae5fd88205b"
                },
                {
                    "availableCapacity": 273523715072,
                    "createDate": "Oct 5, 2022 6:40:15 PM",
                    "diskUtilization": 1.0,
                    "lastOpDate": "Oct 8, 2022 5:02:11 PM",
                    "poolName": "pri-v-d-f91bfce045274bf682589a8012763af3",
                    "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
                    "replicatedSize": 1,
                    "securityPolicy": "Copy",
                    "totalCapacity": 316598108160,
                    "type": "Data",
                    "usedCapacity": 4295413760,
                    "uuid": "17ad6580d6b4455da8002f16df6e1586"
                },
                {
                    "availableCapacity": 273523715072,
                    "createDate": "Oct 5, 2022 6:40:15 PM",
                    "diskUtilization": 1.0,
                    "lastOpDate": "Oct 8, 2022 5:02:11 PM",
                    "poolName": "pri-c-f91bfce045274bf682589a8012763af3",
                    "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
                    "replicatedSize": 1,
                    "securityPolicy": "Copy",
                    "totalCapacity": 316598108160,
                    "type": "ImageCache",
                    "usedCapacity": 4295413760,
                    "uuid": "3f32fbf71bc742028e98b36614bc785b"
                }
            ],
            "state": "Enabled",
            "status": "Connected",
            "totalCapacity": 316598108160,
            "totalPhysicalCapacity": 316598108160,
            "type": "Ceph",
            "url": "not used",
            "uuid": "f91bfce045274bf682589a8012763af3",
            "zoneUuid": "d6b216954e854cb995b3b04258fe7e10"
        }
    ],
    "success": true
}

Ceph主存储池清单 (CephPrimaryStoragePool Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 4.5.0
primaryStorageUuid 主存储UUID 4.5.0
poolName 4.5.0
aliasName 4.5.0
description 资源的详细描述 4.5.0
type 4.5.0
availableCapacity 4.5.0
usedCapacity 4.5.0
replicatedSize 4.5.0
createDate 请参见 资源属性 4.5.0
lastOpDate 请参见 资源属性 4.5.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 4.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 4.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 4.5.0

示例

{
    "inventories": [
        {
            "availableCapacity": 273523715072,
            "createDate": "Oct 5, 2022 6:40:15 PM",
            "diskUtilization": 1.0,
            "lastOpDate": "Oct 8, 2022 5:10:11 PM",
            "poolName": "pri-v-d-f91bfce045274bf682589a8012763af3",
            "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
            "replicatedSize": 1,
            "securityPolicy": "Copy",
            "totalCapacity": 316598108160,
            "type": "Data",
            "usedCapacity": 4295720960,
            "uuid": "17ad6580d6b4455da8002f16df6e1586"
        },
        {
            "availableCapacity": 273523715072,
            "createDate": "Oct 5, 2022 6:40:15 PM",
            "diskUtilization": 1.0,
            "lastOpDate": "Oct 8, 2022 5:10:11 PM",
            "poolName": "pri-c-f91bfce045274bf682589a8012763af3",
            "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
            "replicatedSize": 1,
            "securityPolicy": "Copy",
            "totalCapacity": 316598108160,
            "type": "ImageCache",
            "usedCapacity": 4295720960,
            "uuid": "3f32fbf71bc742028e98b36614bc785b"
        },
        {
            "availableCapacity": 273523715072,
            "createDate": "Oct 5, 2022 6:40:15 PM",
            "diskUtilization": 1.0,
            "lastOpDate": "Oct 8, 2022 5:10:11 PM",
            "poolName": "pri-v-r-f91bfce045274bf682589a8012763af3",
            "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
            "replicatedSize": 1,
            "securityPolicy": "Copy",
            "totalCapacity": 316598108160,
            "type": "Root",
            "usedCapacity": 4295720960,
            "uuid": "5f758a0f66864f76ba214ae5fd88205b"
        }
    ],
    "success": true
}

Ceph主存储OSD组清单 (CephOsdGroup Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
primaryStorageUuid 主存储UUID 4.5.0
osds 4.5.0
availableCapacity 4.5.0
availablePhysicalCapacity 4.5.0
totalPhysicalCapacity 4.5.0
uuid 资源的UUID，唯一标示该资源 4.5.0
createDate 请参见 资源属性 4.5.0
lastOpDate 请参见 资源属性 4.5.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 4.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 4.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 4.5.0

示例

{
    "inventories": [
        {
            "availableCapacity": 273523715072,
            "availablePhysicalCapacity": 312301424640,
            "createDate": "Oct 5, 2022 6:40:56 PM",
            "lastOpDate": "Oct 8, 2022 5:22:11 PM",
            "osds": "osd.0",
            "primaryStorageUuid": "f91bfce045274bf682589a8012763af3",
            "totalPhysicalCapacity": 316598108160,
            "uuid": "2f165cecadff4bca936bc04bf3ff3788"
        }
    ],
    "success": true
}

Block主存储清单 (Block Primary Storage Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
vendorName 存储厂商名称 4.6.0
metadata 存储元数据 4.6.0
uuid 资源的UUID，唯一标示该资源 4.6.0
name 主存储名称 4.6.0
url 未使用 4.6.0
description 资源的详细描述 4.6.0
totalCapacity 总空间 4.6.0
availableCapacity 可用空间 4.6.0
totalPhysicalCapacity 总物理空间 4.6.0
availablePhysicalCapacity 物理可用空间 4.6.0
systemUsedCapacity 系统使用空间 4.6.0
type 主存储类型 4.6.0
state 启用状态 4.6.0
status 连接状态 4.6.0
mountPath 未使用 4.6.0
createDate 请参见 资源属性 4.6.0
lastOpDate 请参见 资源属性 4.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 4.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 4.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 4.6.0
上一篇概览下一篇操作（Operations）
CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心