华为云用户手册

  • 响应示例 状态码: 200 OK { "snapshot" : { "status" : "available", "description" : "Daily backup", "created_at" : "2013-02-25T03:56:53.081642", "metadata" : { }, "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "size" : 1, "id" : "f9faf7df-fdc1-4093-9ef3-5cba06eef995", "name" : "snap-001", "updated_at" : "2013-02-25T03:56:53.081642" } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 snapshot SnapshotDetails object 快照信息 表6 SnapshotDetails 参数 参数类型 描述 id String 云硬盘快照ID。 status String 云硬盘快照状态。关于云硬盘快照状态参见云硬盘快照状态。 name String 云硬盘快照名称。 description String 云硬盘快照描述信息。 created_at String 云硬盘快照创建时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX updated_at String 快照更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX metadata Object 云硬盘快照的元数据信息。 volume_id String 快照所属的云硬盘ID。 size Integer 云硬盘快照大小,单位为GiB。 os-extended-snapshot-attributes:project_id String 预留属性。 os-extended-snapshot-attributes:progress String 预留属性。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误码。错误码和其对应的含义请参考错误码说明。 表8 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 snapshot 是 UpdateSnapshotOption object 快照信息。 表4 UpdateSnapshotOption 参数 是否必选 参数类型 描述 description 否 String 云硬盘快照描述。最大支持85个字符。 name 否 String 云硬盘快照名称。最大支持64个字符。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 extensions Array of Extension objects 扩展接口列表。 表4 Extension 参数 参数类型 描述 alias String 扩展的别名。 description String 描述 links Array of Link objects 云硬盘传递的链接 name String 云硬盘传递的名称。 updated String 最后的更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.+XX.XX,其中+XX.XX表示时区。 表5 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 响应示例 状态码: 200 OK { "extensions" : [ { "updated" : "2013-04-18T00:00:00+00:00", "name" : "SchedulerHints", "links" : [ ], "alias" : "OS-SCH-HNT", "description" : "Pass arbitrary key/value pairs to the scheduler." }, { "updated" : "2011-06-29T00:00:00+00:00", "name" : "Hosts", "links" : [ ], "alias" : "os-hosts", "description" : "Admin-only host administration." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeTenantAttribute", "links" : [ ], "alias" : "os-vol-tenant-attr", "description" : "Expose the internal project_id as an attribute of a volume." } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-extend 是 CinderResizeVolumeOption object 标记扩容云硬盘操作 表4 CinderResizeVolumeOption 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后的云硬盘大小,单位为GiB。 扩容后的云硬盘容量范围:大于原有云硬盘容量~云硬盘最大容量(数据盘为32768GiB;系统盘为1024GiB)
  • 状态码 正常 错误码状态 描述 200 OK 201 Created 202 Accepted 204 No Content 异常 错误码状态 描述 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 409 Conflict 413 overLimit 415 badMediaType 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout 父主题: 附录
  • URI DELETE /v2/{project_id}/volumes/{volume_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 volume_id 是 String 云硬盘ID 表2 Query参数 参数 是否必选 参数类型 描述 cascade 否 Boolean 删除云硬盘关联的所有快照,默认值为false。 缺省值:false
  • 响应示例 状态码: 200 OK { "volumes" : [ { "id" : "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "2bce4552-9a7d-48fa-8484-abbbf64b206e", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "bookmark" } ], "name" : "zjb_u25_test" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "next" } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 volumes Array of VolumeBody objects 查询请求返回的云硬盘列表。 volumes_links Array of Link objects 云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时,会返回查询到的当前云硬盘mark标记的url,可以继续使用这个url查询剩余列表信息。 表5 VolumeBody 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 name String 云硬盘名称。 表6 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表8 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • URI GET /v3/{project_id}/volumes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。 name 否 String 云硬盘名称。最大支持64个字符。 limit 否 Integer 返回结果个数限制。 最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。 当租户所有的云硬盘数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例: GET /v2/xxx/volumes?limit=50,表示查询第1~50个云硬盘。GET /v2/xxx/volumes?offset=50&limit=50,表示查询第51~100个云硬盘。 sort_dir 否 String 返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc sort_key 否 String 返回结果按该关键字排序,支持id,status,size,created_at等关键字,默认为“created_at”。 offset 否 Integer 偏移量 偏移量为一个大于0小于磁盘总个数的整数,表示查询该偏移量后面的所有的云硬盘。 status 否 String 云硬盘状态,具体请参见云硬盘状态。 metadata 否 String 云硬盘元数据。 availability_zone 否 String AZ信息。
  • 云硬盘快照状态 云硬盘快照状态 说明 creating 云硬盘快照处于正在创建的过程中。 available 云硬盘快照创建成功,可以使用。 error 云硬盘快照在创建过程中出现错误。 deleting 云硬盘快照处于正在删除的过程中。 error_deleting 云硬盘快照在删除过程中出现错误 rollbacking 云硬盘快照处于正在回滚数据的过程中。 说明: 只支持快照回滚到源云硬盘,不支持快照回滚到其它指定云硬盘。 只有当云硬盘的状态处于“可用”或“回滚数据失败”状态才允许快照回滚到源云硬盘。 backing-up 通过OpenStack原生API,可以直接通过快照创建备份,快照状态就会变为backing-up。 通过API对磁盘创建备份过程中,系统会自动创建快照,该快照状态为backing-up。 父主题: 附录
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 extensions Array of Extension objects 扩展接口列表。 表4 Extension 参数 参数类型 描述 alias String 扩展的别名。 description String 描述 links Array of Link objects 云硬盘传递的链接 name String 云硬盘传递的名称。 updated String 最后的更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.+XX.XX,其中+XX.XX表示时区。 表5 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 响应示例 状态码: 200 OK { "extensions" : [ { "updated" : "2013-04-18T00:00:00+00:00", "name" : "SchedulerHints", "links" : [ ], "alias" : "OS-SCH-HNT", "description" : "Pass arbitrary key/value pairs to the scheduler." }, { "updated" : "2011-06-29T00:00:00+00:00", "name" : "Hosts", "links" : [ ], "alias" : "os-hosts", "description" : "Admin-only host administration." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeTenantAttribute", "links" : [ ], "alias" : "os-vol-tenant-attr", "description" : "Expose the internal project_id as an attribute of a volume." }, { "updated" : "2011-08-08T00:00:00+00:00", "name" : "Quotas", "links" : [ ], "alias" : "os-quota-sets", "description" : "Quota management support." }, { "updated" : "2011-08-24T00:00:00+00:00", "name" : "TypesManage", "links" : [ ], "alias" : "os-types-manage", "description" : "Types manage support." }, { "updated" : "2013-07-10T00:00:00+00:00", "name" : "VolumeEncryptionMetadata", "links" : [ ], "alias" : "os-volume-encryption-metadata", "description" : "Volume encryption metadata retrieval support." }, { "updated" : "2012-12-12T00:00:00+00:00", "name" : "Backups", "links" : [ ], "alias" : "backups", "description" : "Backups support." }, { "updated" : "2013-07-16T00:00:00+00:00", "name" : "SnapshotActions", "links" : [ ], "alias" : "os-snapshot-actions", "description" : "Enable snapshot manager actions." }, { "updated" : "2012-05-31T00:00:00+00:00", "name" : "VolumeActions", "links" : [ ], "alias" : "os-volume-actions", "description" : "Enable volume actions" }, { "updated" : "2013-10-03T00:00:00+00:00", "name" : "UsedLimits", "links" : [ ], "alias" : "os-used-limits", "description" : "Provide data on limited resources that are being used." }, { "updated" : "2012-05-31T00:00:00+00:00", "name" : "VolumeUnmanage", "links" : [ ], "alias" : "os-volume-unmanage", "description" : "Enable volume unmanage operation." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeHostAttribute", "links" : [ ], "alias" : "os-vol-host-attr", "description" : "Expose host as an attribute of a volume." }, { "updated" : "2013-07-01T00:00:00+00:00", "name" : "VolumeTypeEncryption", "links" : [ ], "alias" : "encryption", "description" : "Encryption support for volume types." }, { "updated" : "2013-06-27T00:00:00+00:00", "name" : "AvailabilityZones", "links" : [ ], "alias" : "os-availability-zone", "description" : "Describe Availability Zones." }, { "updated" : "2013-08-02T00:00:00+00:00", "name" : "Qos_specs_manage", "links" : [ ], "alias" : "qos-specs", "description" : "QoS specs support." }, { "updated" : "2011-08-24T00:00:00+00:00", "name" : "TypesExtraSpecs", "links" : [ ], "alias" : "os-types-extra-specs", "description" : "Type extra specs support." }, { "updated" : "2013-08-08T00:00:00+00:00", "name" : "VolumeMigStatusAttribute", "links" : [ ], "alias" : "os-vol-mig-status-attr", "description" : "Expose migration_status as an attribute of a volume." }, { "updated" : "2012-08-13T00:00:00+00:00", "name" : "CreateVolumeExtension", "links" : [ ], "alias" : "os-image-create", "description" : "Allow creating a volume from an image in the Create Volume v1 API." }, { "updated" : "2014-01-10T00:00:00-00:00", "name" : "ExtendedServices", "links" : [ ], "alias" : "os-extended-services", "description" : "Extended services support." }, { "updated" : "2012-06-19T00:00:00+00:00", "name" : "ExtendedSnapshotAttributes", "links" : [ ], "alias" : "os-extended-snapshot-attributes", "description" : "Extended SnapshotAttributes support." }, { "updated" : "2012-12-07T00:00:00+00:00", "name" : "VolumeImageMetadata", "links" : [ ], "alias" : "os-vol-image-meta", "description" : "Show image metadata associated with the volume." }, { "updated" : "2012-03-12T00:00:00+00:00", "name" : "QuotaClasses", "links" : [ ], "alias" : "os-quota-class-sets", "description" : "Quota classes management support." }, { "updated" : "2013-05-29T00:00:00+00:00", "name" : "VolumeTransfer", "links" : [ ], "alias" : "os-volume-transfer", "description" : "Volume transfer management support." }, { "updated" : "2014-02-10T00:00:00+00:00", "name" : "VolumeManage", "links" : [ ], "alias" : "os-volume-manage", "description" : "Allows existing backend storage to be 'managed' by Cinder." }, { "updated" : "2012-08-25T00:00:00+00:00", "name" : "AdminActions", "links" : [ ], "alias" : "os-admin-actions", "description" : "Enable admin actions." }, { "updated" : "2012-10-28T00:00:00-00:00", "name" : "Services", "links" : [ ], "alias" : "os-services", "description" : "Services support." } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-update_readonly_flag 是 CinderUpdateVolumeReadonlyOption object 标记设置云硬盘只读标识操作。 表4 CinderUpdateVolumeReadonlyOption 参数 是否必选 参数类型 描述 readonly 是 Boolean 是否只读标识。 true:表示只读。 false:表示非只读。 缺省值:true
  • 响应示例 状态码: 200 OK { "volume" : { "attachments" : [ ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "db-rabbitmq201#LVM_iSCSI", "encrypted" : false, "id" : "da4f9c7a-c275-4bc9-80c4-76c7d479a218", "size" : 1, "os-vol-tenant-attr:tenant_id" : "3dab0aaf682849678a94ec7b5a3af2ce", "metadata" : { }, "status" : "available", "display_name" : "test", "bootable" : "false", "created_at" : "2014-12-18T17:14:38.000000", "volume_type" : "SATA", "multiattach" : false } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 volume CinderVolumeDetail object 查询请求返回的云硬盘。 表3 CinderVolumeDetail 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘uri自描述信息。 name String 云硬盘名称。 status String 云硬盘状态,具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 是否挂载信息。 availability_zone String 云硬盘所属AZ。 source_volid String 源云硬盘ID,如果是从源云硬盘创建,则有值。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID,如果是从快照创建,则有值。 description String 云硬盘描述。 bootable String 是否为启动云硬盘。 true:表示为启动云硬盘。 false:表示为非启动云硬盘。 created_at String 云硬盘创建时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX volume_type String 云硬盘类型。 目前支持"SATA","SAS","GPSSD","SSD","ESSD","GPSSD2","ESSD2"七种。 "SATA"为普通IO云硬盘(已售罄) "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 "ESSD"为极速IO云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 metadata VolumeMetadata object 云硬盘的元数据。 如果元数据中不包含hw:passthrough字段,云硬盘默认为VBD类型。 如果元数据中不包含__system__encrypted字段,云硬盘默认为不加密。 size Integer 云硬盘大小,单位为GiB。 shareable Boolean 是否为可共享云硬盘。 说明: 该字段已经废弃,请使用multiattach。 multiattach Boolean 是否为可共享云硬盘。 os-vol-tenant-attr:tenant_id String 云硬盘所属的租户ID。租户ID就是项目ID。 volume_image_metadata Object 云硬盘镜像的元数据。 关于“volume_image_metadata”字段的详细说明,具体请参见:"查询镜像详情"。 os-vol-host-attr:host String 预留属性。 os-volume-replication:extended_status String 预留属性。 consistencygroup_id String 预留属性。 iops iops object 云硬盘的iops信息,云硬盘类型是ESSD2、GPSSD2才返回。 throughput throughput object 云硬盘的吞吐量信息,云硬盘类型是GPSSD2才返回。 updated_at String 云硬盘更新时间。 replication_status String 预留属性。 user_id String 预留属性。 encrypted Boolean 预留属性。 表4 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 表5 VolumeAttachment 参数 参数类型 描述 attached_at String 挂载的时间信息。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_id String 挂载信息对应的ID。 device String 挂载点 host_name String 云硬盘挂载到的云服务器云主机对应 的物理主机的名称。 id String 挂载的资源ID server_id String 云硬盘挂载到的云服务器云主机的 ID。 volume_id String 云硬盘ID 表6 VolumeMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。 说明: 请参考 查询密钥列表,通过HTTPS请求获取密钥ID。 __system__encrypted String metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 full_clone String 从快照创建云硬盘时,如需使用link克隆方式,请指定该字段的值为0。 hw:passthrough String true表示云硬盘的设备类型为SCSI类型,即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型,即为默认类型,VBD只能支持简单的SCSI读写命令。 该字段不存在时,云硬盘默认为VBD类型。 表7 iops 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值:false id String 云硬盘iops标识。 total_val Integer iops大小。 volume_id String 云硬盘ID。 表8 throughput 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值:false id String 云硬盘吞吐量标识。 total_val Integer 吞吐量大小。 volume_id String 云盘ID。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表10 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 云硬盘 本章节仅列出了云硬盘v2接口的授权信息。对于v3接口,如果提供的功能与v2接口一样,则授权信息也一致。 例如:创建云硬盘时,v2接口为POST /v2/{project_id}/cloudvolumes,对应的v3接口为POST /v3/{project_id}/cloudvolumes,两个接口支持的授权信息一致。 授权项列表中,“√”表示支持,“×”表示暂不支持。 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 创建云硬盘 POST /v2/{project_id}/cloudvolumes evs:volumes:create √ √ 创建云硬盘(OpenStack Cinder) POST /v2/{project_id}/volumes 创空白云硬盘 evs:volumes:create evs:volumes:get 通过镜像创建云硬盘 evs:volumes:create ims:images:get evs:volumes:get 通过快照创建云硬盘 evs:volumes:create evs:snapshots:get evs:volumes:get √ × 创建云硬盘(按需或包周期) POST /v2.1/{project_id}/cloudvolumes evs:volumes:create evs:volumes:get √ √ 扩容云硬盘 POST /v2/{project_id}/cloudvolumes/{volume_id}/action evs:volumes:extend √ √ 扩容云硬盘(按需或包周期) POST /v2.1/{project_id}/cloudvolumes/{volume_id}/action evs:volumes:extend √ √ 查询云硬盘列表 GET /v2/{project_id}/cloudvolumes evs:volumes:list √ × 查询云硬盘列表(OpenStack Cinder) GET /v2/{project_id}/volumes evs:volumes:list √ × 查询所有云硬盘详情 GET /v2/{project_id}/cloudvolumes/detail evs:volumes:list √ √ 查询所有云硬盘详情 GET /v2/{project_id}/os-vendor-volumes/detail evs:volumes:list √ × 查询所有云硬盘详情(OpenStack Cinder) GET /v2/{project_id}/volumes/detail evs:volumes:list √ × 查询单个云硬盘详情 GET /v2/{project_id}/os-vendor-volumes/{volume_id} evs:volumes:get √ × 查询单个云硬盘详情(OpenStack Cinder ) GET /v2/{project_id}/volumes/{volume_id} evs:volumes:get √ × 查询单个云硬盘详情 GET /v2/{project_id}/cloudvolumes/{volume_id} evs:volumes:get √ √ 删除云硬盘 DELETE /v2/{project_id}/cloudvolumes/{volume_id} evs:volumes:delete √ √ 删除云硬盘(OpenStack Cinder ) DELETE /v2/{project_id}/volumes/{volume_id} evs:volumes:delete evs:volumes:get √ × 更新云硬盘 PUT /v2/{project_id}/cloudvolumes/{volume_id} evs:volumes:update √ √ 更新云硬盘(OpenStack Cinder ) PUT /v2/{project_id}/volumes/{volume_id} evs:volumes:update evs:volumes:get √ × 更新云硬盘的单个元数据(OpenStack Cinder) PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key} evs:volumes:update evs:volumes:get √ × 更新云硬盘的元数据(OpenStack Cinder) PUT /v2/{project_id}/volumes/{volume_id}/metadata evs:volumes:update evs:volumes:get √ × 查询云硬盘的单个元数据(OpenStack Cinder) GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} evs:volumes:get √ × 删除云硬盘的单个元数据(OpenStack Cinder) DELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key} evs:volumes:delete evs:volumes:get √ × 查询云硬盘的元数据(OpenStack Cinder) GET /v2/{project_id}/volumes/{volume_id}/metadata/{key} evs:volumes:get √ × 添加云硬盘的元数据(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/metadata evs:volumes:update evs:volumes:get √ × 查询云硬盘类型列表(OpenStack Cinder) GET /v2/{project_id}/types evs:types:get √ × 查询单个云硬盘类型的详细信息(OpenStack Cinder) GET /v2/{project_id}/types/{type_id} evs:types:get √ × 查询租户的详细配额(OpenStack Cinder) GET /v2/{project_id}/os-quota-sets/{project_id} evs:quotas:get √ × 查询扩展接口(OpenStack Cinder) GET /v2/{project_id}/extensions 无 √ × 查询所有的可用分区信息(OpenStack Cinder) GET /v2/{project_id}/os-availability-zone 无 √ × 授权项(Action)为无,表示无需授权。 父主题: 权限和授权项
  • 响应示例 状态码: 200 OK { "snapshots": [ { "status": "available", "os-extended-snapshot-attributes:progress": "100%", "description": null, "created_at": "2013-06-19T07:15:29.000000", "metadata": {}, "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", "size": 5, "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa", "name": "name_xx2-snap", "updated_at": null, }, { "status": "available", "os-extended-snapshot-attributes:progress": "100%", "description": null, "created_at": "2013-06-19T09:08:08.000000", "metadata": {}, "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", "size": 5, "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f", "name": "name_xx2-snap", "updated_at": null, } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • URI GET /v3/{project_id}/snapshots/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。 volume_id 否 String 云硬盘快照对应的云硬盘ID。 limit 否 Integer 返回结果个数限制。 最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。 当租户所有的快照数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例: GET /v2/xxx/snapshots/detail?limit=50,表示查询第1~50个快照。GET /v2/xxx/snapshots/detail?offset=50&limit=50,表示查询第51~100个快照。 name 否 String 云硬盘快照名称。最大支持255个字符。 offset 否 Integer 偏移量。 说明: 说明: 分页查询快照时使用,与limit配合使用。假如共有30个快照, 设置offset为11,limit为10,即为从第12个快照开始查询, 一次最多可读取10个快照。 status 否 String 云硬盘快照状态,具体请参见云硬盘快照状态。
  • 请求示例 POST https://{endpoint}/v3/{project_id}/volumes { "volume" : { "name" : "openapi_vol01", "imageRef" : "027cf713-45a6-45f0-ac1b-0ccc57ac12e2", "availability_zone" : "az-dc-1", "description" : "create for api test", "volume_type" : "SATA", "metadata" : { "volume_owner" : "openapi" }, "multiattach" : false, "size" : 40 }, "OS-SCH-HNT:scheduler_hints" : { "dedicated_storage_id" : "eddc1a3e-4145-45be-98d7-bf6f65af9767" } }
  • 响应示例 状态码: 202 Accepted { "volume" : { "attachments" : [ ], "availability_zone" : "az-dc-1", "bootable" : "false", "consistencygroup_id" : null, "created_at" : "2016-05-25T02:38:40.392463", "description" : "create for api test", "encrypted" : false, "id" : "8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel" : "bookmark" } ], "metadata" : { "volume_owner" : "openapi" }, "name" : "openapi_vol01", "replication_status" : "disabled", "multiattach" : false, "size" : 40, "snapshot_id" : null, "source_volid" : null, "status" : "creating", "updated_at" : null, "user_id" : "39f6696ae23740708d0f358a253c2637", "volume_type" : "SATA" } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 202 表7 响应Body参数 参数 参数类型 描述 volume CreateVolumeDetail object 待创建的云硬盘信息。 表8 CreateVolumeDetail 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 name String 云硬盘名称。 status String 云硬盘状态,具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 挂载信息。 availability_zone String 云硬盘所属AZ。 bootable String 是否为启动云硬盘。 true:表示为启动云硬盘。 false:表示为非启动云硬盘。 encrypted Boolean 当前云硬盘服务不支持该字段。 created_at String 创建云硬盘的时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX description String 云硬盘描述。 volume_type String 云硬盘类型。 目前支持"SATA", "SAS", "GPSSD, "SSD","ESSD","GPSSD2","ESSD2"七种 “SATA”为普通IO云硬盘 “SAS”为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 “SSD”为超高IO云硬盘 “ESSD”为极速IO云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。 replication_status String 预留属性。 consistencygroup_id String 所属一致性组ID。 source_volid String 源云硬盘ID。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID。 metadata VolumeMetadata object 元数据。 size Integer 云硬盘大小,单位为GiB。 user_id String 使用云硬盘用户ID。 updated_at String 云硬盘更新时间。 shareable Boolean 是否为可共享云硬盘。 说明: 该字段已经废弃,请使用multiattach。 multiattach Boolean 是否为共享云硬盘。 true:表示为共享云硬盘。 false:表示为非共享云硬盘。 storage_cluster_id String 预留属性。 表9 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 表10 VolumeAttachment 参数 参数类型 描述 attached_at String 挂载的时间信息。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_id String 挂载信息对应的ID。 device String 挂载点 host_name String 云硬盘挂载到的云服务器云主机对应 的物理主机的名称。 id String 挂载的资源ID server_id String 云硬盘挂载到的云服务器云主机的 ID。 volume_id String 云硬盘ID 表11 VolumeMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。 说明: 请参考 查询密钥列表,通过HTTPS请求获取密钥ID。 __system__encrypted String metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 full_clone String 从快照创建云硬盘时,如需使用link克隆方式,请指定该字段的值为0。 hw:passthrough String true表示云硬盘的设备类型为SCSI类型,即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型,即为默认类型,VBD只能支持简单的SCSI读写命令。 该字段不存在时,云硬盘默认为VBD类型。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表13 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 volume 是 CinderCreateVolumeOption object 待创建的云硬盘信息 说明: 不支持同时使用“source_volid”、“snapshot_id”和“imageRef”这三个字段中的任意两个。 OS-SCH-HNT:scheduler_hints 否 CinderCreateVolumeSchedulerHints object 调度参数。调度参数,当前支持dedicated_storage_id字段,表明将云硬盘创建在DSS存储池中。 表4 CinderCreateVolumeOption 参数 是否必选 参数类型 描述 availability_zone 是 String 指定要创建云硬盘的AZ。 若指定的AZ不存在或指定的AZ和备份所在的AZ不同,则创云硬盘失败。 consistencygroup_id 否 String 一致性组ID,该参数表示此云硬盘属 于该一致性组,当前云硬盘服务不支 持该功能 description 否 String 云硬盘的描述。最大支持85个字符。 imageRef 否 String 镜像ID,指定该参数表示创建云硬盘方式为从镜像创建。 说明: 不支持通过BMS的镜像创建BMS系统盘。 获取镜像ID的方法:请参见查询镜像列表。 metadata 否 VolumeMetadata object 云硬盘的metadata数据,metadata中的key和value长度不大于255个字节。 “metadata”字段信息中列举了部分字段,您还可以根据创建云硬盘的要求输入其他字段。 说明: metadata里面不能有value为null的键值对。 multiattach 否 Boolean 创建共享云硬盘的信息。默认值为false。 true:表示为共享云硬盘。 false:表示为非共享云硬盘。 请参见 共享云硬盘及使用方法了解更多信息。 name 否 String 云硬盘名称。最大支持64个字符。 size 否 Integer 云硬盘大小,单位为GiB,其限制如下: 系统盘:1GiB-1024GiB 数据盘:10GiB-32768GiB 创建空白云硬盘,size为必选,请在范围内根据需求自定义。 从快照创建云硬盘时,size为必选,且云硬盘大小不能小于快照大小。 从镜像创建云硬盘时,size为必选,且云硬盘大小不小于镜像属性中min_disk要求的最小云硬盘容量。 snapshot_id 否 String 快照ID,指定该参数表示创建云硬盘方式为从快照创建云硬盘 source_replica 否 String 该参数表示从云硬盘的克隆来创建云硬 盘,当前云硬盘服务不支持该功能 source_volid 否 String 源云硬盘ID,指定该参数表示创建云 硬盘方式为从源云硬盘克隆。当前云 硬盘服务不支持该功能。 volume_type 是 String 云硬盘类型。 目前支持"SATA", "SAS", "GPSSD, "SSD","ESSD","GPSSD2","ESSD2"七种 “SATA”为普通IO云硬盘 “SAS”为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 “SSD”为超高IO云硬盘 “ESSD”为极速IO云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。 说明: 从快照创建云硬盘时,volume_type字段必须和快照源云硬盘保持一致。 了解不同云硬盘类型的详细信息,请参见 云硬盘类型及性能介绍。 枚举值: ESSD2 GPSSD2 ESSD SSD GPSSD SAS SATA iops 否 Integer 给云硬盘配置iops,购买GPSSD2、ESSD2类型的云硬盘时必填,其他类型不能设置。 说明: 了解GPSSD2、ESSD2类型的iops大小范围,请参见云硬盘类型及性能介绍里面的云硬盘性能数据表。 只支持按需计费。 throughput 否 Integer 给云硬盘配置吞吐量,单位是MiB/s,购买GPSSD2类型云盘时必填,其他类型不能设置。 说明: -了解GPSSD2类型的吞吐量大小范围,请参见云硬盘类型及性能介绍里面的云硬盘性能数据表。 只支持按需计费。 表5 VolumeMetadata 参数 是否必选 参数类型 描述 __system__cmkid 否 String metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。 说明: 请参考 查询密钥列表,通过HTTPS请求获取密钥ID。 __system__encrypted 否 String metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 full_clone 否 String 从快照创建云硬盘时,如需使用link克隆方式,请指定该字段的值为0。 hw:passthrough 否 String true表示云硬盘的设备类型为SCSI类型,即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型,即为默认类型,VBD只能支持简单的SCSI读写命令。 该字段不存在时,云硬盘默认为VBD类型。 表6 CinderCreateVolumeSchedulerHints 参数 是否必选 参数类型 描述 dedicated_storage_id 否 String 专属分布式存储池id。
  • 响应示例 状态码: 200 OK { "quota_set" : { "gigabytes_SAS" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 21 }, "volumes_SATA" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 8 }, "gigabytes" : { "reserved" : 0, "allocated" : 0, "limit" : 42790, "in_use" : 2792 }, "backup_gigabytes" : { "reserved" : 0, "allocated" : 0, "limit" : 5120, "in_use" : 51 }, "snapshots_SAS" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 0 }, "volumes_SSD" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 28 }, "snapshots" : { "reserved" : 0, "allocated" : 0, "limit" : 10, "in_use" : 6 }, "id" : "cd631140887d4b6e9c786b67a6dd4c02", "volumes_SAS" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 2 }, "snapshots_SSD" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 0 }, "volumes" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 108 }, "gigabytes_SATA" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 168 }, "backups" : { "reserved" : 0, "allocated" : 0, "limit" : 100, "in_use" : 10 }, "gigabytes_SSD" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 1085 }, "snapshots_SATA" : { "reserved" : 0, "allocated" : 0, "limit" : -1, "in_use" : 0 } } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 quota_set QuotaList object 查询请求返回的配额信息。 表5 QuotaList 参数 参数类型 描述 backup_gigabytes QuotaDetailBackupGigabytes object 备份容量,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 backups QuotaDetailBackups object 备份个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 gigabytes QuotaDetailGigabytes object 总容量,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 id String 项目ID。 snapshots QuotaDetailSnapshots object 快照个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 volumes QuotaDetailVolumes object 云硬盘个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 gigabytes_SATA QuotaDetailGigabytesSATA object SATA云硬盘类型预留的容量大小,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 snapshots_SATA QuotaDetailSnapshotsSATA object SATA云硬盘类型预留快照个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 volumes_SATA QuotaDetailVolumesSATA object SATA云硬盘类型预留的云硬盘个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 gigabytes_SAS QuotaDetailGigabytesSAS object SAS类型云硬盘预留的size大小,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 snapshots_SAS QuotaDetailSnapshotsSAS object SAS类型云硬盘预留快照个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 volumes_SAS QuotaDetailVolumesSAS object SAS类型云硬盘预留的云硬盘个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 gigabytes_SSD QuotaDetailGigabytesSSD object SSD类型云硬盘预留的size大小,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 snapshots_SSD QuotaDetailSnapshotsSSD object SSD类型云硬盘预留快照个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 volumes_SSD QuotaDetailVolumesSSD object SSD类型云硬盘预留的云硬盘个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 gigabytes_GPSSD QuotaDetailGigabytesGPSSD object GPSSD类型云硬盘预留的size大小,单位为GiB,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 snapshots_GPSSD QuotaDetailSnapshotsGPSSD object GPSSD类型云硬盘预留快照个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 volumes_GPSSD QuotaDetailVolumesGPSSD object GPSSD类型云硬盘预留的云硬盘个数,键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 per_volume_gigabytes QuotaDetailPerVolumeGigabytes object 每个云硬盘的容量配额限制。键值对,包含:reserved(预留)、limit(最大)和in_use(已使用)。 表6 QuotaDetailBackupGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表7 QuotaDetailBackups 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表8 QuotaDetailGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表9 QuotaDetailSnapshots 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表10 QuotaDetailVolumes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表11 QuotaDetailGigabytesSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表12 QuotaDetailSnapshotsSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表13 QuotaDetailVolumesSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表14 QuotaDetailGigabytesSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表15 QuotaDetailSnapshotsSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表16 QuotaDetailVolumesSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表17 QuotaDetailGigabytesSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表18 QuotaDetailSnapshotsSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表19 QuotaDetailVolumesSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表20 QuotaDetailGigabytesGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表21 QuotaDetailSnapshotsGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表22 QuotaDetailVolumesGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表23 QuotaDetailPerVolumeGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 状态码: 400 表24 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表25 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • URI GET /v3/{project_id}/os-quota-sets/{target_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID target_project_id 是 String 目标的项目ID。与project_id保持一致即可。 表2 Query参数 参数 是否必选 参数类型 描述 usage 是 String 是否查询配额详细信息。当前只支持传True。 枚举值: True
  • 云硬盘Actions 本章节仅列出了云硬盘v2接口的授权信息。对于v3接口,如果提供的功能与v2接口一样,则授权信息也一致。 例如:创建云硬盘时,v2接口为POST /v2/{project_id}/cloudvolumes,对应的v3接口为POST /v3/{project_id}/cloudvolumes,两个接口支持的授权信息一致。 授权项列表中,“√”表示支持,“×”表示暂不支持。 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 扩容云硬盘(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-extend" evs:volumes:extend evs:volumes:get √ × 将云硬盘导出为镜像(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-volume_upload_image" evs:volumes:uploadImage √ × 挂载云硬盘(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-attach" evs:volumes:attach evs:volumes:get √ × 卸载云硬盘(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-detach" evs:volumes:detach evs:volumes:get √ × 保留云硬盘(OpenStack Cinder ) POST /v2/{project_id}/volumes/{volume_id}/action action="os-reserve" evs:volumes:attach √ × 取消保留云硬盘(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-unreserve" evs:volumes:attach √ × 设置云硬盘启动盘标识(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-set_bootable" evs:volumes:update √ × 设置云硬盘只读标识(OpenStack Cinder) POST /v2/{project_id}/volumes/{volume_id}/action action="os-update_readonly_flag" evs:volumes:update √ × 父主题: 权限和授权项
  • 响应示例 状态码: 200 OK { "snapshots" : [ { "created_at" : "2016-02-16T16:54:14.981520", "description" : null, "id" : "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", "metadata" : { }, "name" : "test01", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:19.475397", "description" : null, "id" : "83be494d-329e-4a78-8ac5-9af900f48b95", "metadata" : { }, "name" : "test02", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:24.367414", "description" : null, "id" : "dd360f46-7593-4d35-8f2c-5566fd0bd79e", "metadata" : { }, "name" : "test03", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:29.766740", "description" : null, "id" : "4c29796a-8cf4-4482-9afc-e66da9a81240", "metadata" : { }, "name" : "test04", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null } ], "snapshots_links" : null } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • URI GET /v2/{project_id}/snapshots 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。 offset 否 Integer 偏移量。 说明: 分页查询快照时使用,与limit配合使用。假如共有30个快照,设置offset为11,limit为10,即为从第12个快照开始查询,一次最多可读取10个快照 limit 否 Integer 返回结果个数限制。 最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。 当租户所有的快照数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例: GET /v2/xxx/snapshots?limit=50,表示查询第1~50个快照。GET /v2/xxx/snapshots?offset=50&limit=50,表示查询第51~100个快照。 name 否 String 云硬盘快照名称,不支持模糊匹配。最大支持255个字符。 status 否 String 云硬盘快照状态,具体请参见云硬盘快照状态。 volume_id 否 String 云硬盘快照对应的卷ID。
共100000条