查询指定卷 本节主要介绍如何使用API查询指定卷。 此操作用来查询指定卷。 请求语法 plaintext GET /rest/v2/block/lun/lunName HTTP/1.1 Date: date Host: ip:port Authorization: authorization 请求参数 参数 类型 描述 是否必须 lunName String 卷名称。 说明 如果不填写此项,会返回所有卷信息。 取值:长度范围是1~16,只能由字母、数字和短横线()组成,字母区分大小写,且仅支持以字母或数字开头。 否 响应结果 名称 类型 描述 lunName String 卷名称。 targetName String target名称。 status String 卷的状态: Normal:正常。 Deleting:卷正在删除中。 DeleteFailed:卷删除失败。 Recovering:卷正在还原中。 RecoverFailed:卷还原失败。 Rollbacking:卷正在回滚。 Flattening:与快照的关系链断开过程中,表示克隆卷正在复制源卷的数据,复制完成之后将变成独立卷,不再依赖快照和源卷。 Importing:正在导入备份数据。 Wiping:卷正在清空数据。 WipeFailed:清空数据失败。 Suspended:卷挂起。 Suspending:卷正在挂起。 SuspendFailed:卷挂起失败。 progress Double 卷还原进度百分比。 仅卷状态为Recovering时显示。 recoverFailedReason String 卷还原失败的原因。 仅卷状态为RecoverFailed时显示。 deleteFailedReason String 卷云上数据删除失败的原因。 仅卷状态为DeleteFailed时显示。 wipeFailedReason String 卷清空失败的原因。 仅卷状态为WipeFailed时显示。 waitUploadBytes String 待上传数据量,单位是bytes。 仅卷状态为Suspending时显示。 SuspendFailedReason String 卷挂起失败的原因。 仅卷状态为SuspendFailed时显示。 capacity Integer 卷容量,单位是GiB。 storageMode String 卷的存储类型: Local:本地模式,数据全部保留在本地。 Cache:缓存模式,本地保留部分热数据,全部数据异步存储到对象存储中。 Storage:存储模式,本地保留全部数据,并异步存储到对象存储中。 createTime Long 卷创建时间。unix时间戳(UTC),精确到毫秒。 iSCSITargets Array of iSCSITarget iSCSI target属性集合,详见“表1 响应参数iSCSITarget说明”。 cloud.bucketName String 存储桶的名称(仅上云卷支持)。 cloud.prefix String 对象存储中的前缀名称(仅上云卷支持)。 如果未设置,则不返回此项。 cloud.accessKey String 对象存储服务的Access Key(仅上云卷支持)。 cloud.endpoint String 对象存储Endpoint(仅上云卷支持)。 cloud.objectSize Integer 数据存储在对象存储的大小(仅上云卷支持)。 cloud.storageClass String 数据在对象存储的存储类型(仅上云卷支持): STANDARD:标准存储。 STANDARDIA:低频访问存储。 cloud.compression String 是否压缩数据上传至对象存储(仅上云卷支持): Enabled:压缩数据上传至对象存储。 Disabled:不压缩数据上传至对象存储。 cloud.signVersion String 上云签名认证的类型(仅上云卷支持): v2:V2签名认证。 v4:V4签名认证。 cloud.region String Endpoint资源池所在区域(仅上云卷支持)。 cloud.provider String 对象存储服务名称: OOS:天翼云对象存储经典版I型。 S3:兼容S3的其他对象存储。 config.localStorageClass String 卷冗余模式(仅集群版支持): singlecopy:单副本。 2copy:两副本。 3copy:三副本。 EC N+M。 config.minReplica Integer 卷的最小副本数(仅集群版支持)。 config.ECfragmentSize Integer 分片大小(仅集群版支持)。如果冗余模式为EC N+M,则会返回此项。 config.sectorSize Long 扇区大小,单位是bytes。 config.highAvailability String 高可用模式类型(仅集群版支持): ActiveStandby:主备,该卷关联对应target下的所有IQN。 Disabled:禁用,该卷关联对应target下的1个IQN。 config.writePolicy String 卷的写策略: WriteBack:回写,指数据写入到内存后即返回客户端成功,之后再异步写入磁盘。 WriteThrough:透写,指数据同时写入内存和磁盘,并在都写成功后再返回客户端成功。 WriteAround:绕写,指数据直接写到磁盘,不写入内存。 config.cachePool String 缓存存储池(仅集群版支持)。 config.pool String 存储池(仅集群版支持),表示最终存储池,卷数据最终落在该存储池内。 config.redundancyOverlap Integer 卷的折叠副本数(仅集群版支持)。 config.serverAffinity Object 卷主备分布优先级设置,详见“表5 响应参数config.serverAffinity说明”。 config.qosPolicy Object 卷关联的QoS策略信息,详见表“6 响应参数config.qosPolicy说明”。 config.qosPolicyforLUN Object 卷所在存储池中卷的默认QoS策略信息(仅集群版支持),详见“表7 响应参数config.qosPolicyforLUN”。 说明 如果卷的缓存存储池和存储池同时存在时,展示缓存存储池的“存储池内卷的默认QoS策略”;如果缓存存储池未设置“存储池内卷的默认QoS策略”,则不返回此项。 如果卷只有存储池:展示存储池的“存储池内卷的默认QoS策略”;如果存储池未设置“存储池内卷的默认QoS策略”,则不返回此项。 config.path String 数据目录(仅单机版支持)。 dataHealth.normal Double 卷正常数据的百分比。 dataHealth.lowRedundancy Double 卷降级数据的百分比。 dataHealth.error Double 卷错误数据的百分比。 dataHealth.reconstructionProgress Double 如果卷存在降级状态的数据,数据重建进度的百分比。 dataHealth.ETR Long 卷如果存在降级数据,预计剩余的数据重建时间。单位为秒。如果返回值为负数,说明数据无法重建,需用户尽快修复。 number Long 卷编号。LUN在target下的编号,由存储系统分配,对应客户端挂载存储设备时设备地址中的LUN ID。如果target下只有一个LUN,LUN的编号一般为0。 uuid String 卷的唯一识别码。 isClone Boolean 是否是克隆卷: true:是克隆卷。 false:不是克隆卷。 sourceSnapshotName String 对应的快照名称(仅克隆卷支持)。 snapshots.snapshotNumbers Integer 卷的快照个数(仅本地卷支持)。 snapshots.basisofCurData Boolean 当前的读写是否是基于卷的初始状态: true:是。 false:否。 snapshots.lunSnapshots Array of lunSnapshot 卷的快照信息集合(仅本地卷支持),详见“表8 响应参数lunSnapshot/Children说明”。 snapshots.snapshotSize Long 卷关联的快照大小的总和(仅本地卷支持),即快照记录的数据量。单位是bytes。 注意 卷异常或上游快照删除等因素可能导致快照大小波动。 WWID String 卷的唯一标识符。 表1 响应参数iSCSITarget说明 名称 类型 描述 iqn String iSCSI target IQN。 status String 卷对应的target的状态: Active:主target。 Standby:热备target。 Offline:离线target。 Unavailable:冷备target。 ips Array of ip iSCSI target的IP属性集合,详见“表2 响应参数ip说明”。 targetPortalIP Array of targetPortalIP iSCSI目标门户,详见“表3 响应参数targetPortalIP说明”。 serverId String IQN所在的服务器ID。 表2 响应参数ip说明 名称 类型 描述 ip String iSCSI target的IP。 port Integer iSCSI target的端口号。 表3 响应参数targetPortalIP说明 名称 类型 描述 ips Array of ip iSCSI目标门户的IP属性集合,详见“表4 响应参数ip(iSCSI目标门户的IP)说明”。 status String iSCSI目标门户的状态: Enabled:启用状态。 Disabled:禁用状态。 表4 响应参数ip(iSCSI目标门户的IP)说明 名称 类型 描述 ip String iSCSI目标门户的IP地址。 port Integer iSCSI目标门户的端口号。 表5 响应参数config.serverAffinity说明 名称 类型 描述 autoFailback String 针对卷主备状态,当高优先级的服务器恢复正常后,是否自动进行主备状态切换(仅集群版支持): Enabled:自动进行主备切换。 Disabled:不自动进行主备切换。 priority Array of string 卷主备分布优先级的服务器ID(仅集群版支持),系统根据指定的服务器ID顺序来选择卷的主备IQN。 表6 响应参数config.qosPolicy 名称 类型 描述 qosName String QoS策略名称。 表7 响应参数config.qosPolicyforLUN 名称 类型 描述 qosName String QoS策略名称。 poolName String 存储池名称。 表8 响应参数lunSnapshot/Children说明 名称 类型 描述 snapshotName String 快照名称。 description Integer 快照描述信息。 lunCapacity String 创建快照时刻,源卷的容量。 consistencySnapshotName String 所属的一致性快照名称。 说明 仅一致性快照的卷快照显示。 status String 快照的状态: Normal:正常。 Error:异常。 Pending:创建中。 Deleting:删除中。 reclaimPolicy String 快照回收策略: Delete:当快照无关联克隆卷,且最多拥有1个子节点(子节点表示存在其他快照依赖此快照,或者当前写操作基于此快照),快照自动删除。 Retain:当快照无关联克隆卷,且最多拥有1个子节点,快照仍然保留。 createTime Long 快照的创建时间。 basisofCurData Boolean 卷当前数据是否基于该快照: true:基于该快照。 false:不基于该快照。 snapshotSize Long 快照大小,具体快照记录的数据量。单位是bytes。 注意 卷异常或上游快照删除等因素可能导致快照大小波动。 children Array of children 基于该快照创建的快照信息集合,参数解释详见本表。