查询卷的扩展属性(本地卷适用)
更新时间 2026-03-24 17:16:03
最近更新时间: 2026-03-24 17:16:03
本节主要介绍如何使用API查询卷的扩展属性。
此操作用来查询指定卷的扩展属性。
请求语法
GET /rest/v1/block/lun/lunName/xattr?xattrKey=xattrKey&xattrInnerKey=xattrInnerKey HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lunName | String | 卷名称。 取值:长度范围是1~16,只能由字母、数字和短横线(-)组成,字母区分大小写,且仅支持以字母或数字开头。 | 是 |
| xattrKey | String | 指定卷的扩展属性的key值。 取值:
| 否 |
| xattrInnerKey | String | 指定xattrValue中的Key值。可以指定多个Key值,以英文逗号隔开。如果不填写,则查询扩展属性key下的所有属性。 取值:长度范围是1~500,只能由字母、数字、汉字和特殊字符(~ ! @ $ ( ) _ + - ; . :)组成,特殊符号需转义。 | 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| xattr | Object | 卷的扩展属性,详见“表1 响应参数xattr说明”。 |
表1 响应参数xattr说明
| 名称 | 类型 | 描述 |
|---|---|---|
| xattrKey | Object | 卷的扩展属性的key值,详见“表2响应参数xattrKey说明”。 |
表2响应参数xattrKey说明
| 名称 | 类型 | 描述 |
|---|---|---|
xattrInnerKey | String | xattrValue中的Key值。 |
| xattrInnerKeyValue | String | xattrValue中的Key的Value值。 |
请求示例1
查询卷lun01a中xattrKey为OPENSTACK_META的扩展属性。
GET /rest/v1/block/lun/lun01a/xattr?xattrKey=OPENSTACK_META HTTP/1.1
Date: Tue, 3 Mar 2026 02:41:07 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.64:1443 响应示例1
HTTP/1.1 200 OK
x-hblock-request-id: 440b18eb0f374be0830fe086ff307981
Connection: keep-alive
Content-Length: 371
Date: Tue, 3 Mar 2026 02:41:07 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"xattr": {
"OPENSTACK_META": {
"5b157817-cccf-471d-bca3-5cb7598bb376": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
"27157817-cccf-471d-bca3-5cb7598bb389": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
"6b157817-cccf-471d-bca3-5cb7598bb376": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
"77157817-cccf-471d-bca3-5cb7598bb389": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}
}
}
}请求示例2
查询卷lun01a的扩展属性,其中xattrKey为OPENSTACK_META,且xattrInnerKey为5b157817-cccf-471d-bca3-5cb7598bb376和27157817-cccf-471d-bca3-5cb7598bb389。
GET /rest/v1/block/lun/lun01a/xattr?xattrKey=OPENSTACK_META&xattrInnerKey=5b157817-cccf-471d-bca3-5cb7598bb376,27157817-cccf-471d-bca3-5cb7598bb389 HTTP/1.1
Date: Tue, 03 Mar 2026 02:37:36 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.64:1443 响应示例2
HTTP/1.1 200 OK
x-hblock-request-id: a1e5b61f421844f9bbdafbd4a9d383f6
Connection: keep-alive
Content-Length: 205
Date: Tue, 03 Mar 2026 02:37:36 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"xattr": {
"OPENSTACK_META": {
"5b157817-cccf-471d-bca3-5cb7598bb376": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
"27157817-cccf-471d-bca3-5cb7598bb389": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}
}
}
}