云盘

概览

云盘为云主机提供存储，根据用途分类，云盘包括根云盘和数据云盘。

云盘类型		描述
根云盘		云主机的系统云盘，用于支撑云主机的系统运行。
数据云盘	普通云盘	云主机的数据云盘，用于云主机扩展的存储使用。普通云盘类似PC中的硬盘，需要挂载至云主机使用，无法单独使用。
	共享云盘	云主机的数据云盘，用于云主机扩展的存储使用。可将同一块共享云盘挂载给多台云主机使用，类似于将一块物理硬盘挂载给多台物理服务器，每一台服务器均可以对该硬盘进行数据读取和写入。
	未实例化云盘	创建数据云盘时，若未指定主存储和云主机，创建出的数据云盘将被展示在未实例化栏中。为未实例化云盘加载实例后，即可作为可用资源被云主机使用。

注意事项

一台云主机最多可加载24块数据云盘。
根云盘作为云主机的附属，不能卸载。
数据云盘可在相同类型Hypervisor的不同云主机之间加载和卸载。不同Hypervisor上的数据云盘不可加载到不同类型的云主机上。例如，KVM云主机的云盘不能被VMware云主机加载。
普通云盘同一时间只能加载到一台云主机使用。Ceph类型的主存储和Shared Block类型的主存储支持共享云盘，共享云盘可被多台云主机识别并同时访问。
直接将共享云盘挂载给多台云主机无法实现文件共享功能，如需在多台云主机之间共享文件，需搭建共享文件系统。
云盘占用空间采用虚拟容量来计算。创建云盘时扣除的是云盘的虚拟容量大小，而本身只占用少量实际容量。随着写入文件额增加，实际容量会逐步增加。
多个主存储环境下，可以指定主存储创建云盘。如果未指定主存储：
- 针对本地主存储，云盘默认会从容量大的主存储创建。
- 针对NFS主存储，云盘默认会随机选择一个主存储创建。
- 针对本地主存储+NFS/SharedMountPoint类型主存储，默认会选择与当前根云盘不在同一个主存储的存储来创建。
数据云盘可设置QoS进行磁盘带宽限速，需注意限速不可过低，过低的QoS可能导致I/O性能过低。
采用Virtio类型的存储扩展盘，需确保加载该云盘的云主机已安装Virtio驱动。主流Linux、CentOS 6/7系列已集成Virtio驱动，无需额外安装。Windows系列需手动安装Virtio驱动，可前往云主机详情页安装性能优化工具。

应用场景

Oracle RAC
Oracle Real Application Clusters (Oracle RAC) 最初旨在提供改进的数据库服务，经过多年的发展，如今它已立足于全面的高可用性 (HA) 体系基础上，该HA体系可用作数据库云系统的基础，也可以作为共享基础架构确保为数据中心中的所有应用程序提供高度的可用性、可伸缩性、灵活性和敏捷性。Oracle RAC采用共享磁盘架构，因此卷管理和用于存储数据库数据的文件系统必须支持集群识别。Oracle自动存储管理 (ASM) 是为Oracle数据库推荐的（集群）卷管理器。
由于ASM可以自动管理共享磁盘，因而用户可采用共享云盘为RAC节点提供存储，交由RAC进行数据管理而无需额外部署共享文件系统。

清单

属性

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
primaryStorageUuid	云盘所在的主存储的uuid，请参见 primary storage			0.6
vmInstanceUuid	云盘所挂载的虚拟机的uuid，如果没有挂载虚拟机为NULL；请参见 attach VM	是		0.6
diskOfferingUuid	云盘规格（disk offering）的uuid，如果云盘是从云盘规格创建出来的	是		0.6
rootImageUuid	镜像（image）的uuid，如果云盘是从一个镜像创建出来的	是		0.6
installPath	云盘在主存储上的安装路径			0.6
type	云盘的类型		Root Data	0.6
format	请参见 format		qcow2	0.6
size	云盘的虚拟大小，单位是字节			0.6
actualSize				0.6
isShareable				0.6
volumeQoS				4.6.21
lastDetachDate				4.6.21
lastVmInstanceUuid				4.6.21
deviceId	请参见 device id	是		0.6
state	请参见 state		Enabled Disabled	0.6
status	请参见 status		Creating Ready NotInstantiated	0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

{
    "inventories": [
        {
            "actualSize": 454033408,
            "createDate": "Nov 14, 2017 1:21:32 PM",
            "description": "Root volume for VM[uuid:7096021b405e41a2afa22d0f6d7ab6f8]",
            "deviceId": 0,
            "format": "qcow2",
            "installPath": "/Cloud_ps_nxs/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-c33a897
db91e461a9cbc011b0aa441c9/c33a897db91e461a9cbc011b0aa441c9.qcow2",
            "isShareable": false,
            "lastOpDate": "Nov 14, 2017 1:21:33 PM",
            "name": "ROOT-for-pub",
            "primaryStorageUuid": "cae8726c90784ba0946f852952731268",
            "rootImageUuid": "e29e00c1d18a486b8802a8f53c6a6e4f",
            "size": 4195352576,
            "state": "Enabled",
            "status": "Ready",
            "type": "Root",
            "uuid": "c33a897db91e461a9cbc011b0aa441c9",
            "vmInstanceUuid": "7096021b405e41a2afa22d0f6d7ab6f8"
        }
    ],
    "success": true
}

云盘快照清单(VolumeSnapshot Inventory)

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
format	请参见 format			0.6
groupUuid				0.6
latest				0.6
parentUuid				0.6
primaryStorageInstallPath				0.6
primaryStorageUuid	云盘所在的主存储的uuid，请参见 primary storage			0.6
size	云盘的虚拟大小，单位是字节			0.6
state	请参见 state			0.6
status	请参见 status			0.6
treeUuid	快照树UUID			0.6
type	云盘的虚拟化类型			0.6
volumeType	云盘类型		Root Data	0.6
volumeUuid	云盘UUID			0.6
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是		0.6
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是		0.6

示例

{
    "inventories": [
        {
            "backupStorageRefs": [],
            "createDate": "Sep 12, 2019 5:26:00 PM",
            "description": "",
            "format": "qcow2",
            "groupUuid": "d6939afab0824cab8e9a57a25686a7d4",
            "lastOpDate": "Sep 12, 2019 5:26:18 PM",
            "latest": false,
            "name": "Snapshot-2-云盘-1",
            "parentUuid": "d403f271636a488fbd25afd74ca589f8",
            "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/snapshots/d403f271636a488fbd25afd74ca589f8.qcow2",
            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
            "size": 200704,
            "state": "Enabled",
            "status": "Ready",
            "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
            "type": "Hypervisor",
            "uuid": "2b47066db7c641019495204a39d00abb",
            "volumeType": "Data",
            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
        },
        {
            "backupStorageRefs": [],
            "createDate": "Sep 12, 2019 5:26:18 PM",
            "description": "",
            "format": "qcow2",
            "groupUuid": "63854129e8aa42258aa83d0d9d45032c",
            "lastOpDate": "Sep 12, 2019 5:26:28 PM",
            "latest": false,
            "name": "Snapshot-4-云盘-1",
            "parentUuid": "2b47066db7c641019495204a39d00abb",
            "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/snapshots/2b47066db7c641019495204a39d00abb.qcow2",
            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
            "size": 200704,
            "state": "Enabled",
            "status": "Ready",
            "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
            "type": "Hypervisor",
            "uuid": "75c17cf55b2a4a70877e274d5c5ec77b",
            "volumeType": "Data",
            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
        },
        {
            "backupStorageRefs": [],
            "createDate": "Sep 12, 2019 5:25:39 PM",
            "description": "",
            "format": "qcow2",
            "groupUuid": "e5bad705d61a424aa703578f86ce8522",
            "lastOpDate": "Sep 12, 2019 5:26:00 PM",
            "latest": false,
            "name": "Snapshot-1-ROOT-for-VM-1",
            "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/b2026ce722584b0383b247640e2961e2.qcow2",
            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
            "size": 16781312,
            "state": "Enabled",
            "status": "Ready",
            "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
            "type": "Hypervisor",
            "uuid": "ce2fe3b2faba4b32b1c2fadbd462cc6d",
            "volumeType": "Root",
            "volumeUuid": "b2026ce722584b0383b247640e2961e2"
        },
        {
            "backupStorageRefs": [],
            "createDate": "Sep 12, 2019 5:25:39 PM",
            "description": "",
            "format": "qcow2",
            "groupUuid": "e5bad705d61a424aa703578f86ce8522",
            "lastOpDate": "Sep 12, 2019 5:26:00 PM",
            "latest": false,
            "name": "Snapshot-1-云盘-1",
            "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/1b746a6adb584ee89c65ab51c3634416.qcow2",
            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
            "size": 6295552,
            "state": "Enabled",
            "status": "Ready",
            "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
            "type": "Hypervisor",
            "uuid": "d403f271636a488fbd25afd74ca589f8",
            "volumeType": "Data",
            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
        }
    ],
    "success": true
}

快照树清单(VolumeSnapshotTree Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		0.6
current			0.6
tree			0.6
volumeUuid	云盘UUID		0.6
status	请参见 state		0.6
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	0.6
createDate	请参见资源属性		0.6
lastOpDate	请参见资源属性		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	0.6

示例

{
    "inventories": [
        {
            "createDate": "Sep 12, 2019 5:25:39 PM",
            "current": true,
            "lastOpDate": "Sep 12, 2019 5:26:28 PM",
            "status": "Completed",
            "tree": {
                "children": [
                    {
                        "children": [
                            {
                                "children": [
                                    {
                                        "children": [],
                                        "inventory": {
                                            "backupStorageRefs": [],
                                            "createDate": "Sep 12, 2019 5:26:28 PM",
                                            "description": "",
                                            "format": "qcow2",
                                            "groupUuid": "ce6bbd10e379472886e4d74448e43066",
                                            "lastOpDate": "Sep 12, 2019 5:26:28 PM",
                                            "latest": true,
                                            "name": "Snapshot-5-云盘-1",
                                            "parentUuid": "75c17cf55b2a4a70877e274d5c5ec77b",
                                            "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/snapshots/75c17cf55b2a4a70877e274d5c5ec77b.qcow2",
                                            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                                            "size": 200704,
                                            "state": "Enabled",
                                            "status": "Ready",
                                            "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
                                            "type": "Hypervisor",
                                            "uuid": "88864416e95846f68b5e881cdca1eedf",
                                            "volumeType": "Data",
                                            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
                                        },
                                        "parentUuid": "75c17cf55b2a4a70877e274d5c5ec77b"
                                    }
                                ],
                                "inventory": {
                                    "backupStorageRefs": [],
                                    "createDate": "Sep 12, 2019 5:26:18 PM",
                                    "description": "",
                                    "format": "qcow2",
                                    "groupUuid": "63854129e8aa42258aa83d0d9d45032c",
                                    "lastOpDate": "Sep 12, 2019 5:26:28 PM",
                                    "latest": false,
                                    "name": "Snapshot-4-云盘-1",
                                    "parentUuid": "2b47066db7c641019495204a39d00abb",
                                    "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/snapshots/2b47066db7c641019495204a39d00abb.qcow2",
                                    "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                                    "size": 200704,
                                    "state": "Enabled",
                                    "status": "Ready",
                                    "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
                                    "type": "Hypervisor",
                                    "uuid": "75c17cf55b2a4a70877e274d5c5ec77b",
                                    "volumeType": "Data",
                                    "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
                                },
                                "parentUuid": "2b47066db7c641019495204a39d00abb"
                            }
                        ],
                        "inventory": {
                            "backupStorageRefs": [],
                            "createDate": "Sep 12, 2019 5:26:00 PM",
                            "description": "",
                            "format": "qcow2",
                            "groupUuid": "d6939afab0824cab8e9a57a25686a7d4",
                            "lastOpDate": "Sep 12, 2019 5:26:18 PM",
                            "latest": false,
                            "name": "Snapshot-2-云盘-1",
                            "parentUuid": "d403f271636a488fbd25afd74ca589f8",
                            "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/snapshots/d403f271636a488fbd25afd74ca589f8.qcow2",
                            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                            "size": 200704,
                            "state": "Enabled",
                            "status": "Ready",
                            "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
                            "type": "Hypervisor",
                            "uuid": "2b47066db7c641019495204a39d00abb",
                            "volumeType": "Data",
                            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
                        },
                        "parentUuid": "d403f271636a488fbd25afd74ca589f8"
                    }
                ],
                "inventory": {
                    "backupStorageRefs": [],
                    "createDate": "Sep 12, 2019 5:25:39 PM",
                    "description": "",
                    "format": "qcow2",
                    "groupUuid": "e5bad705d61a424aa703578f86ce8522",
                    "lastOpDate": "Sep 12, 2019 5:26:00 PM",
                    "latest": false,
                    "name": "Snapshot-1-云盘-1",
                    "primaryStorageInstallPath": "/Cloud_ps/dataVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-1b746a6adb584ee89c65ab51c3634416/1b746a6adb584ee89c65ab51c3634416.qcow2",
                    "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                    "size": 6295552,
                    "state": "Enabled",
                    "status": "Ready",
                    "treeUuid": "864f7a38d38842968ebd7d40121ee25e",
                    "type": "Hypervisor",
                    "uuid": "d403f271636a488fbd25afd74ca589f8",
                    "volumeType": "Data",
                    "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
                }
            },
            "uuid": "864f7a38d38842968ebd7d40121ee25e",
            "volumeUuid": "1b746a6adb584ee89c65ab51c3634416"
        },
        {
            "createDate": "Sep 12, 2019 5:25:39 PM",
            "current": true,
            "lastOpDate": "Sep 12, 2019 5:26:28 PM",
            "status": "Completed",
            "tree": {
                "children": [
                    {
                        "children": [
                            {
                                "children": [
                                    {
                                        "children": [
                                            {
                                                "children": [],
                                                "inventory": {
                                                    "backupStorageRefs": [],
                                                    "createDate": "Sep 12, 2019 5:26:28 PM",
                                                    "description": "",
                                                    "format": "qcow2",
                                                    "groupUuid": "ce6bbd10e379472886e4d74448e43066",
                                                    "lastOpDate": "Sep 12, 2019 5:26:28 PM",
                                                    "latest": true,
                                                    "name": "Snapshot-5-ROOT-for-VM-1",
                                                    "parentUuid": "6daba46d758445d4af7812738ba93e7d",
                                                    "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/snapshots/6daba46d758445d4af7812738ba93e7d.qcow2",
                                                    "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                                                    "size": 200704,
                                                    "state": "Enabled",
                                                    "status": "Ready",
                                                    "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
                                                    "type": "Hypervisor",
                                                    "uuid": "9eac8e8d51fc450d91e713bc4fdd20a2",
                                                    "volumeType": "Root",
                                                    "volumeUuid": "b2026ce722584b0383b247640e2961e2"
                                                },
                                                "parentUuid": "6daba46d758445d4af7812738ba93e7d"
                                            }
                                        ],
                                        "inventory": {
                                            "backupStorageRefs": [],
                                            "createDate": "Sep 12, 2019 5:26:18 PM",
                                            "description": "",
                                            "format": "qcow2",
                                            "groupUuid": "63854129e8aa42258aa83d0d9d45032c",
                                            "lastOpDate": "Sep 12, 2019 5:26:28 PM",
                                            "latest": false,
                                            "name": "Snapshot-4-ROOT-for-VM-1",
                                            "parentUuid": "d0ea588f6c5d4e539a54ff4f64112e86",
                                            "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/snapshots/d0ea588f6c5d4e539a54ff4f64112e86.qcow2",
                                            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                                            "size": 200704,
                                            "state": "Enabled",
                                            "status": "Ready",
                                            "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
                                            "type": "Hypervisor",
                                            "uuid": "6daba46d758445d4af7812738ba93e7d",
                                            "volumeType": "Root",
                                            "volumeUuid": "b2026ce722584b0383b247640e2961e2"
                                        },
                                        "parentUuid": "d0ea588f6c5d4e539a54ff4f64112e86"
                                    }
                                ],
                                "inventory": {
                                    "backupStorageRefs": [],
                                    "createDate": "Sep 12, 2019 5:26:07 PM",
                                    "description": "",
                                    "format": "qcow2",
                                    "lastOpDate": "Sep 12, 2019 5:26:18 PM",
                                    "latest": false,
                                    "name": "Snapshot-3",
                                    "parentUuid": "400cabe156424e7282bb4606c40907dc",
                                    "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/snapshots/400cabe156424e7282bb4606c40907dc.qcow2",
                                    "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                                    "size": 200704,
                                    "state": "Enabled",
                                    "status": "Ready",
                                    "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
                                    "type": "Hypervisor",
                                    "uuid": "d0ea588f6c5d4e539a54ff4f64112e86",
                                    "volumeType": "Root",
                                    "volumeUuid": "b2026ce722584b0383b247640e2961e2"
                                },
                                "parentUuid": "400cabe156424e7282bb4606c40907dc"
                            }
                        ],
                        "inventory": {
                            "backupStorageRefs": [],
                            "createDate": "Sep 12, 2019 5:26:00 PM",
                            "description": "",
                            "format": "qcow2",
                            "groupUuid": "d6939afab0824cab8e9a57a25686a7d4",
                            "lastOpDate": "Sep 12, 2019 5:26:07 PM",
                            "latest": false,
                            "name": "Snapshot-2-ROOT-for-VM-1",
                            "parentUuid": "ce2fe3b2faba4b32b1c2fadbd462cc6d",
                            "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/snapshots/ce2fe3b2faba4b32b1c2fadbd462cc6d.qcow2",
                            "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                            "size": 200704,
                            "state": "Enabled",
                            "status": "Ready",
                            "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
                            "type": "Hypervisor",
                            "uuid": "400cabe156424e7282bb4606c40907dc",
                            "volumeType": "Root",
                            "volumeUuid": "b2026ce722584b0383b247640e2961e2"
                        },
                        "parentUuid": "ce2fe3b2faba4b32b1c2fadbd462cc6d"
                    }
                ],
                "inventory": {
                    "backupStorageRefs": [],
                    "createDate": "Sep 12, 2019 5:25:39 PM",
                    "description": "",
                    "format": "qcow2",
                    "groupUuid": "e5bad705d61a424aa703578f86ce8522",
                    "lastOpDate": "Sep 12, 2019 5:26:00 PM",
                    "latest": false,
                    "name": "Snapshot-1-ROOT-for-VM-1",
                    "primaryStorageInstallPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b2026ce722584b0383b247640e2961e2/b2026ce722584b0383b247640e2961e2.qcow2",
                    "primaryStorageUuid": "b1296dc880984edeb6ec05d2c9d7e243",
                    "size": 16781312,
                    "state": "Enabled",
                    "status": "Ready",
                    "treeUuid": "dd4dee32f5bc49b5a0c74a645d15d949",
                    "type": "Hypervisor",
                    "uuid": "ce2fe3b2faba4b32b1c2fadbd462cc6d",
                    "volumeType": "Root",
                    "volumeUuid": "b2026ce722584b0383b247640e2961e2"
                }
            },
            "uuid": "dd4dee32f5bc49b5a0c74a645d15d949",
            "volumeUuid": "b2026ce722584b0383b247640e2961e2"
        }
    ],
    "success": true
}

挂载的虚拟机（Attached VM）

数据云盘可以被挂载到正在运行的（Running）或者已经停止的（Stopped）云主机上，但在同一时间一个云盘只能挂载到一个云主机上；挂载后云盘的uuid会出现在vmInstanceUuid中。数据云盘可以从一个云主机上卸载，然后挂载到另一个云主机上，但是这两个云主机需要是相同类型的虚拟机管理程序管理的。根云盘作为云主机的附属，不能卸载。

格式（Format）

云盘格式揭示了云盘和虚拟机管理程序之间的关系，指示了该云盘可以挂载到哪种虚拟机管理程序管理的云主机上。

设备ID（Device ID）

设备号表明了云盘挂载到云主机的顺序。根云盘有固定的设备ID 0，因为第一个被挂载的云盘总是根云盘；数据云盘则取决于挂载到云主机的顺序，可能有1， 2，3 …… N这样的设备ID。设备ID可以用来识别云盘在客户操作系统（guest operating system）中的盘符（disk letter）；例如，在Linux系统中， 0通常代表/dev/xvda， 1通常代表/dev/xvdb，依次类推。

可用状态（State）

云盘有两种可用状态：

Enabled：
启用（Enabled）状态下，允许云盘被挂载到云主机上。
Disabled：
禁用（Disabled）状态下，不允许云盘被挂载到云主机上；然而，数据云盘总是可以被卸载，即使已经是禁用状态的数据云盘也可以被卸载。

连接状态（Status）

连接状态体现了云盘的生命周期：

NotInstantiated：
数据云盘特有的状态。在这个连接状态中，数据云盘只存在于数据库的表记录中。NotInstantiated状态的数据云盘可以挂载到任何类型虚拟机管理程序管理的云主机上；当挂载到云主机上后，数据云盘的hypervisorType域会存储云主机对应的虚拟机管理程序类型，在主存储上被实例化为虚拟机管理程序类型的实际二进制文件，同时连接状态会改为就绪（Ready）；在这之后，这些数据云盘就只能被重新挂载到相同类型虚拟机管理程序管理的云主机上了。
Ready：
在这种状态时，云盘已经在主存储上实例化；已就绪可以使用。
Creating：
在这种状态时，正在从镜像或云盘快照创建云盘；未就绪不能使用。

连接状态转换图如图 1所示：

xsky类型块存储卷(XskyBlockVolume)

名字	描述	起始支持版本
xskyStatus		4.7.11
xskyBlockVolumeId		4.7.11
attachedJudgers		4.7.11
lastDetachDate		4.7.11
lastVmInstanceUuid		4.7.11
vmInstanceUuid	云主机UUID	4.7.11
diskOfferingUuid	云盘规格UUID	4.7.11
rootImageUuid		4.7.11
installPath		4.7.11
type		4.7.11
format		4.7.11
actualSize		4.7.11
deviceId		4.7.11
state		4.7.11
status		4.7.11
isShareable		4.7.11
volumeQos		4.7.11
iscsiPath		4.7.11
vendor		4.7.11
uuid	请参见资源属性	4.7.11
name	请参见资源属性	4.7.11
description	请参见资源属性	4.7.11
size	容量	4.7.11
primaryStorageUuid	主存储UUID	4.7.11
accessPathId	访问路径id	4.7.11
accessPathIqn	访问路径iqn	4.7.11
burstTotalBw	突发带宽	4.7.11
burstTotalIops	突发IOPS	4.7.11
maxTotalBw	最大带宽	4.7.11
maxTotalIops	最大IOPS	4.7.11
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	4.7.11
userTag	用户标签，请参见创建用户标签(CreateUserTag)	4.7.11
systemTag	系统标签，请参见创建系统标签(CreateSystemTag)	4.7.11
tagUuid	标签UUID	4.7.11
createDate	请参见资源属性	4.7.11
lastOpDate	请参见资源属性	4.7.11

expon类型块存储卷(ExponBlockVolume)

名字	描述	起始支持版本
actualSize	真实容量	5.1.0
deviceId	设备ID	5.1.0
diskOfferingUuid	云盘规格UUID	5.1.0
exponStatus	expon状态	5.1.0
format	块存储卷格式	5.1.0
rootImageUuid	根镜像UUID	5.1.0
installPath	安装路径	5.1.0
type	类型	5.1.0
state	启用状态	5.1.0
status	就绪状态	5.1.0
isShareable	是否共享	5.1.0
volumeQos	块存储卷QoS	5.1.0
iscsiPath	ISCSI路径	5.1.0
uuid	块存储卷UUID，请参见资源属性	5.1.0
name	块存储卷名称，请参见资源属性	5.1.0
description	块存储卷描述，请参见资源属性	5.1.0
size	容量	5.1.0
lastVmInstanceUuid	上一次加载的实例UUID	5.1.0
protocol	协议	5.1.0
vendor	厂商	5.1.0
primaryStorageUuid	主存储UUID	5.1.0
lastAttachDate	最后加载时间	5.1.0
lastDetachDate	最后卸载时间	5.1.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	5.1.0
userTag	用户标签，请参见创建用户标签(CreateUserTag)	5.1.0
systemTag	系统标签，请参见创建系统标签(CreateSystemTag)	5.1.0
tagUuid	标签UUID	5.1.0
createDate	请参见资源属性	5.1.0
lastOpDate	请参见资源属性	5.1.0

示例

{
    "inventories": [
        {
            "actualSize": 1406140416,
            "createDate": "Apr 22, 2024 5:01:23 PM",
            "deviceId": 1,
            "exponStatus": "normal",
            "format": "raw",
            "installPath": "expon://pool/55e7b5f5a19e42d6996108a09c0ce22e",
            "isShareable": true,
            "iscsiPath": "iscsi://3260/",
            "lastAttachDate": "Apr 24, 2024 5:49:11 PM",
            "lastDetachDate": "Apr 22, 2024 5:04:15 PM",
            "lastOpDate": "Apr 24, 2024 5:49:11 PM",
            "lastVmInstanceUuid": "ce585c3170c646779c4827e06895d3e2",
            "name": "aaa444dd",
            "primaryStorageUuid": "173d49a118384c00a7d7ebf9815e54e2",
            "protocol": "iSCSI",
            "size": 4294967296,
            "state": "Enabled",
            "status": "Ready",
            "type": "Data",
            "uuid": "150c1b4cce834d0485df7f686a18b34f",
            "vendor": "expon"
        },
        {
            "actualSize": 0,
            "createDate": "Apr 15, 2024 10:04:55 AM",
            "exponStatus": "normal",
            "format": "raw",
            "installPath": "expon://pool/1af65a9e30ef45489a0c545f1aa48c8e",
            "isShareable": true,
            "iscsiPath": "iscsi://3260/",
            "lastAttachDate": "Apr 17, 2024 1:06:07 PM",
            "lastDetachDate": "Apr 17, 2024 1:14:24 PM",
            "lastOpDate": "Apr 17, 2024 1:54:21 PM",
            "lastVmInstanceUuid": "c1d98d17677248dd958ece943401b603",
            "name": "sfa",
            "primaryStorageUuid": "173d49a118384c00a7d7ebf9815e54e2",
            "protocol": "iSCSI",
            "size": 4294967296,
            "state": "Enabled",
            "status": "Ready",
            "type": "Data",
            "uuid": "1c29001448e64a98a5c8efd264a62f2b",
            "vendor": "expon"
        }
    ],
    "success": true
}

操作（Operations）

创建云盘（CreateDataVolume）

管理员可以使用CreateDataVolume创建云盘。例如：

CreateDataVolume name=testvolume diskOfferingUuid=73432f99feef483b97f984ff1830220e

参数（Parameters）

名字	描述	可选的	起始支持版本
name	云盘名称		0.6
description	云盘描述	是	0.6
diskOfferingUuid	云盘规格uuid	是	0.6
primaryStorageUuid	主存储uuid	是	0.6
resourceUuid	资源uuid。若指定，镜像会使用该字段值作为uuid	是	0.6
tagUuids	标签UUID列表	是	3.4.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

Note:

ZStack Cloud创建数据云盘时支持指定云盘置备方式，SystemTags增加volumeProvisioningStrategy选项，使用 dataVolumeSystemTags参数来传递 SystemTag。
- 选项格式为：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
- 例如：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

删除云盘（DeleteDataVolume）

管理员可以使用DeleteDataVolume删除云盘。例如：

DeleteDataVolume uuid=2929b9e85c32478ea602824189c0d01a

参数（Parameters）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	云盘uuid			0.6
deleteMode	请参见删除资源(Delete Resources)	是	Permissive Enforcing	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是		0.6
timeout		是

彻底删除云盘（ExpungeDataVolume）

管理员可以使用ExpungeDataVolume彻底删除云盘。例如：

ExpungeDataVolume uuid=2929b9e85c32478ea602824189c0d01a

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

恢复云盘（RecoverDataVolume）

管理员可以使用RecoverDataVolume恢复云盘。例如：

RecoverDataVolume uuid=8994e6524c4945a0bf76d169297742df

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

开启或关闭云盘（ChangeVolumeState）

管理员可以使用ChangeVolumeState开启或关闭云盘。例如：

ChangeVolumeState uuid=8994e6524c4945a0bf76d169297742df stateEvent=enable

参数（Parameters）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	云盘uuid			0.6
stateEvent	开启或关闭		enable disable	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是		0.6
timeout		是

从镜像创建云盘（CreateDataVolumeFromVolumeTemplate）

管理员可以使用CreateDataVolumeFromVolumeTemplate从镜像创建云盘。例如：

CreateDataVolumeFromVolumeTemplate name=new-volume imageUuid=bbe7c4538bfb420c84d417c8af0cfcc2 \
primaryStorageUuid=49304a747e2046618befdba8f64a5e47

参数（Parameters）

名字	描述	可选的	起始支持版本
imageUuid	镜像uuid		0.6
name	云盘名称		0.6
description	云盘的详细描述	是	0.6
primaryStorageUuid	主存储uuid		0.6
hostUuid	物理主机uuid	是	0.6
resourceUuid	资源uuid	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

Note:

ZStack Cloud从镜像创建云盘时支持创建共享云盘，SystemTags增加shareable 选项，使用 shareable 参数来传递 SystemTag。创建时包含此SystemTag表示创建共享云盘，不包含表示创建普通云盘。

从快照创建云盘（CreateDataVolumeFromVolumeSnapshot）

管理员可以使用CreateDataVolumeFromVolumeSnapshot从快照创建云盘。例如：

CreateDataVolumeFromVolumeSnapshot volumeSnapshotUuid=0e4b6901bc964e7d9ec369eefdc8ba55 \
name=newsnapshotvolume primaryStorageUuid=49304a747e2046618befdba8f64a5e47

参数（Parameters）

名字	描述	可选的	起始支持版本
volumeSnapshotUuid	云盘快照uuid		0.6
name	云盘名称		0.6
description	云盘的详细描述	是	0.6
primaryStorageUuid	主存储uuid		0.6
resourceUuid	资源uuid	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

查询云盘（QueryVolume）

管理员可以使用QueryVolume查询云盘。例如：

QueryVolume type=Data vmInstanceUuid=71f5376ef53a46a9abddd59c942cf45f

QueryVolume diskOffering.name=small primaryStorage.uuid=8db7eb2ccdab4c4eb4784e46895bb016

原生域查询（Primitive Fields of Query）

请参见 volume inventory

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field)	清单（Inventory）	描述	起始支持版本
vmInstance	vm inventory	云盘所挂载的云主机	0.6
snapshot	volume snapshot inventory	从该云盘创建出来的所有云盘快照	0.6
diskOffering	disk offering inventory	从该云盘创建出来的所有云盘规格	0.6
primaryStorage	primary storage inventory	该云盘所在的主存储	0.6
image	image inventory	从该云盘创建出来的镜像	0.6

获取云盘格式（GetVolumeFormat）

管理员可以使用GetVolumeFormat获取云盘格式。返回示例：

{
    "formats": [
        {
            "format": "iso",
            "supportingHypervisorTypes": []
        },
        {
            "format": "raw",
            "masterHypervisorType": "KVM",
            "supportingHypervisorTypes": [
                "KVM"
            ]
        },
        {
            "format": "vmtx",
            "masterHypervisorType": "ESX",
            "supportingHypervisorTypes": [
                "ESX"
            ]
        },
        {
            "format": "qcow2",
            "masterHypervisorType": "KVM",
            "supportingHypervisorTypes": [
                "KVM"
            ]
        }
    ]

}

参数（Parameters）

名字	描述	可选的	起始支持版本
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

获取云盘支持的类型的能力（GetVolumeCapabilities）

管理员可以使用GetVolumeCapabilities获取云盘支持的类型的能力。例如：

GetVolumeCapabilities uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

同步云盘大小（SyncVolumeSize）

管理员可以使用SyncVolumeSize同步云盘大小。例如：

SyncVolumeSize uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

批量刷新云盘容量（BatchSyncVolumeSize）

管理员可以使用SyncVolumeSize批量刷新云盘容量。例如：

BatchSyncVolumeSize clusterUuid=5hs8kc3m867kg4x46k8l04dv461vps9e

参数（Parameters）

名字	描述	可选的	起始支持版本
clusterUuid	集群UUID		4.5.3
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	4.5.3
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	4.5.3
timeout		是

扩展根云盘（ResizeRootVolume）

管理员可以使用ResizeRootVolume扩展根云盘。例如：

ResizeRootVolume uuid=78d879252ab84a3e96832535331bc9cc size=4294967296

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		2.2
size	扩展后大小		2.2
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	2.2
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	2.2
timeout		是

扩展数据云盘（ResizeDataVolume）

管理员可以使用ResizeDataVolume扩展数据云盘。例如：

ResizeDataVolume uuid=6978048d1400484ca33a2ea84af061f5 size=1073741824

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		2.2
size	扩展后大小		2.2
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	2.2
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	2.2
timeout		是

修改云盘属性（UpdateVolume）

管理员可以使用UpdateVolume修改云盘属性。例如：

UpdateVolume  uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9 name=newvolume

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
name	云盘名称	是	0.6
description	云盘的详细描述	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

设置云盘限速（SetVolumeQoS）

管理员可以使用SetVolumeQoS设置云盘限速。例如：

SetVolumeQos uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9 volumeBandwidth=10000

参数（Parameters）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	云盘uuid			0.6
volumeBandwidth	云盘限速带宽			0.6
mode		是	total read write	3.1.0
readBandwidth		是		4.4.0
writeBandwidth		是		4.4.0
totalBandwidth		是		4.4.0
readIOPS		是		4.4.0
writeIOPS		是		4.4.0
totalIOPS		是		4.4.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是		0.6
timeout		是

Note:

ZStack Cloud支持设置云盘读QoS带宽，SystemTags增加volumeReadBandwidth选项。
- 选项格式为：volumeReadBandwidth::xxx，其中 xxx 是读QoS
- 例如：volumeReadBandwidth::20971520
ZStack Cloud支持设置云盘写QoS带宽，SystemTags增加volumeWriteBandwidth选项。
- 选项格式为：volumeWriteBandwidth::xxx，其中 xxx 是写QoS
- 例如：vvolumeWriteBandwidth::20971520

获取云盘限速（GetVolumeQoS）

管理员可以使用GetVolumeQoS获取云盘限速。例如：

GetVolumeQos uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
forceSync (可选)	是否到物理机上去同步数据	是	3.10.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

Note:

ZStack Cloud支持获取云盘读QoS带宽，SystemTags增加volumeReadBandwidth选项。
- 选项格式为：volumeReadBandwidth::xxx，其中 xxx 是读QoS
- 例如：volumeReadBandwidth::20971520
ZStack Cloud支持获取云盘写QoS带宽，SystemTags增加volumeWriteBandwidth选项。
- 选项格式为：volumeWriteBandwidth::xxx，其中 xxx 是写QoS
- 例如：vvolumeWriteBandwidth::20971520

取消云盘网卡限速（DeleteVolumeQoS）

管理员可以使用DeleteVolumeQoS取消云盘网卡限速。例如：

DeleteVolumeQos uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	云盘uuid			0.6
mode		是	total read write all overwrite	4.4.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是		0.6
timeout		是

Note:

ZStack Cloud支持取消云盘读QoS带宽，SystemTags增加volumeReadBandwidth选项。
- 选项格式为：volumeReadBandwidth::xxx，其中 xxx 是读QoS
- 例如：volumeReadBandwidth::20971520
ZStack Cloud支持取消云盘写QoS带宽，SystemTags增加volumeWriteBandwidth选项。
- 选项格式为：volumeWriteBandwidth::xxx，其中 xxx 是写QoS
- 例如：vvolumeWriteBandwidth::20971520

获取云盘IO线程绑定信息（GetVolumeIoThreadPin）

用户可以使用GetVolumeIoThreadPin来获取云盘IO线程绑定信息。例如：

GetVolumeIoThreadPin uuid=0b699d672e7346629e7d824c93511ed8

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	资源的UUID，唯一标示该资源		4.7.0
systemTags	系统标签	是	4.7.0
userTags	用户标签	是	4.7.0

设置云盘IO线程绑定（SetVolumeIoThreadPin）

用户可以使用SetVolumeIoThreadPin来设置云盘IO线程绑定。例如：

SetVolumeIoThreadPin ioThreadId=1 pin=1-2 vmUuid=b99452ce3c60451487e01aa1a687f24a uuid=604f2066d8044cb98a9714b851c4b76d

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	资源的UUID，唯一标示该资源		4.7.0
vmUuid	云盘加载目标云主机的UUID		4.7.0
pin	绑定的CPU范围		4.7.0
ioThreadId	IO线程的id		4.7.0
systemTags	系统标签	是	4.7.0
userTags	用户标签	是	4.7.0

获取云盘可被加载的云主机列表（GetDataVolumeAttachableVm）

管理员可以使用GetDataVolumeAttachableVm获取云盘可被加载的云主机列表。例如：

GetDataVolumeAttachableVm volumeUuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	起始支持版本
volumeUuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

挂载云盘到云主机上（AttachDataVolumeToVm）

管理员可以使用AttachDataVolumeToVm挂载云盘到云主机上。例如：

AttachDataVolumeToVm volumeUuid=30b1f7abb7884b80bbdacaf0fd1c7fe9 \
vmInstanceUuid=108af59a0f4e4d6cb838a5591db1016a

参数（Parameters）

名字	描述	可选的	起始支持版本
vmInstanceUuid	云主机uuid		0.6
volumeUuid	云盘uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

从云主机上卸载云盘（DetachDataVolumeFromVm）

管理员可以使用DetachDataVolumeFromVm从云主机上卸载云盘。例如：

DetachDataVolumeFromVm uuid=30b1f7abb7884b80bbdacaf0fd1c7fe9

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	云盘uuid		0.6
vmUuid	云主机uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

加载数据云盘到物理机(AttachDataVolumeToHost)

用户可以使用AttachDataVolumeToHost加载数据云盘到物理机。例如：

AttachDataVolumeToHost volumeUuid=95bd25d20dff3591a83f45280d05a67d hostUuid=c7310b853b1d3e97b09e52c32bd2e9c6 mountPath=/test/mount/path

参数（Parameters）

名字	描述	可选的	起始支持版本
volumeUuid	云盘UUID		4.5.0
hostUuid	物理机UUID		4.5.0
mountPath	物理机上的挂在路径		4.5.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	4.5.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	4.5.0
timeout		是

从物理机卸载数据云盘(DetachDataVolumeFromHost)

用户可以使用DetachDataVolumeFromHost将数据云盘从物理机卸载。例如：

DetachDataVolumeFromHost volumeUuid=961e87cd9adc335eb4227d98cb835e3c

参数（Parameters）

名字	描述	可选的	起始支持版本
volumeUuid	云盘UUID		4.5.0
hostUuid	物理机UUID	是	4.5.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	4.5.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	4.5.0
timeout		是

从云盘创建快照（CreateVolumeSnapshot）

管理员可以使用CreateVolumeSnapshot从云盘创建快照。例如：

CreateVolumeSnapshot volumeUuid=30b1f7abb7884b80bbdacaf0fd1c7fe9 name=newsnapshot

参数（Parameters）

名字	描述	可选的	起始支持版本
volumeUuid	云盘uuid		0.6
name	快照名称		0.6
description	快照的详细描述	是	0.6
resourceUuid	资源uuid	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	0.6
timeout		是

查询云盘快照（QueryVolumeSnapshot）

管理员可以使用QueryVolumeSnapshot查询云盘快照。例如：

QueryVolumeSnapshot uuid=2a31798356754fe0a48da09d9ee879dd

原生域查询（Primitive Fields of Query）

请参见云盘快照清单(VolumeSnapshot Inventory)

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field)	清单（Inventory）	起始支持版本
backupStorage	backup storage inventory	0.6
backupStorageRef		0.6
backupStorageRefs		0.6
localStorageHostRef		0.6
primaryStorage	primary storage inventory	0.6
tree		0.6
volume	volume inventory	0.6

查询快照树（QueryVolumeSnapshotTree）

管理员可以使用QueryVolumeSnapshotTree查询快照树。例如：

QueryVolumeSnapshotTree uuid=b3e785f593bd4dc7b74bd0be1f612de8

原生域查询（Primitive Fields of Query）

请参见快照树清单(VolumeSnapshotTree Inventory)。

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field)	清单（Inventory）	描述	起始支持版本
snapshot	云盘快照清单(VolumeSnapshot Inventory)		0.6
volume	volume inventory		0.6

更新云盘快照信息（UpdateVolumeSnapshot）

管理员可以使用UpdateVolumeSnapshot更新云盘快照信息。例如：

UpdateVolumeSnapshot uuid=b3e785f593bd4dc7b74bd0be1f612de8

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	快照uuid		0.6
name	快照的新名称	是	0.6
description	快照的新详细描述	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

删除云盘快照（DeleteVolumeSnapshot）

用户可以使用DeleteVolumeSnapshot删除云盘快照。例如：

DeleteVolumeSnapshot uuid=b3e785f593bd4dc7b74bd0be1f612de8 deleteMode=Permissive

参数（Parameters）

名字	描述	可选的	可选的参数值	起始支持版本
uuid	快照UUID，请参见资源属性			0.6
deleteMode	请参见删除资源(Delete Resources)	是	Permissive Enforcing	0.6
direction	数据合并方向。pull：向前合并；commit：向后合并；auto：自动选择最优合并方向	是		5.4.0
scope	数据合并方式。single：仅合并单个快照；chain：合并整个快照链；auto：自动判断最佳合并范围			5.4.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是		0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是		0.6
timeout		是

将云盘回滚至指定快照（RevertVolumeFromSnapshot）

管理员可以使用RevertVolumeFromSnapshot将云盘回滚至指定快照。例如：

RevertVolumeFromSnapshot uuid=ee70cdf1f9c4492288403a9708bb6434

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	快照uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)；资源类型是 VolumeVO	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)；资源类型是 VolumeVO	是	0.6
timeout		是

获取快照容量(GetVolumeSnapshotSize)

用户可以使用GetVolumeSnapshotSize获取快照容量。例如：

GetVolumeSnapshotSize uuid=ad2126f57be049ad9fcc85ccff53ce78

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	快照UUID		3.5.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.5.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.5.0
timeout		是

快照瘦身（ShrinkVolumeSnapshot）

用户可以使用ShrinkVolumeSnapshot进行快照瘦身。例如：

ShrinkVolumeSnapshot uuid=7d8b27866eb24dc493ccf5bacd6ec883

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	资源的UUID，唯一标示该资源		3.10.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.10.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.10.0
timeout		是

扁平合并云盘（FlattenVolume）

用户可以使用FlattenVolume扁平合并云盘快照。例如：

FlattenVolume uuid=7d8b27866eb24dc493ccf5bacd6ec883

参数（Parameters）

名字	描述	可选的	起始支持版本
uuid	资源的UUID，唯一标示该资源		4.7.0
dryRun	试运行，可用于预测数据用量	是	4.7.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	4.7.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	4.7.0
timeout		是

标签（Tags）

用户可以使用resourceType=VolumeVO在云盘上创建标签。例如：

CreateUserTag resourceType=VolumeVO tag=goldenVolume \
resourceUuid=f97b8cb9bccc4872a723c8b7785d9a12