批量查询iSCSI target
更新时间 2025-09-29 17:49:38
最近更新时间: 2025-09-29 17:49:38
本节主要介绍如何使用API批量查询iSCSI target。
此操作用来批量查询iSCSI target。
请求语法
GET /rest/v1/block/target?filter=filter&range=i-j HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| filter | String | 查询的过滤条件。可以选择多个查询，如果是或的关系，使用or将查询条件分隔开；如果是与的关系，使用and将查询条件分隔开。 支持的过滤条件类型包括：
| 否 |
| range | String | 查询iSCSI target的范围，格式为i-j，i和j为正整数，0 < j-i < 1000。按照target名称进行排序，返回第i到第j的target。 如果输入的查询范围超过iSCSI target的总个数，返回的结果为空，如果未指定range，则返回所有符合条件的iSCSI target。 | 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| targets | Array of target | iSCSI target信息集合，详见“表1 响应参数target说明”。 |
表1 响应参数target说明
| 名称 | 类型 | 描述 |
|---|---|---|
| targetName | String | iSCSI target名称。 |
| maxSessions | Integer | iSCSI target下每个IQN允许建立的最大会话数。 |
| iSCSITargets | Array of iSCSITarget | iSCSI target属性集合，详见“表2 响应参数iSCSITarget说明”。 |
| chap.name | String | CHAP认证名称。 |
| chap.status | String | CHAP认证状态：
|
| createTime | Long | 创建iSCSI target的时间，unix时间戳（UTC），精确到毫秒。 |
| serverIds | Array of string | iSCSI target对应的服务器ID（仅集群版支持）。 |
| num | Integer | target所在的服务器数量（仅集群版支持）。 |
| reclaimPolicy | String | iSCSI target的回收策略：
|
| status | String | iSCSI target的状态：
仅iSCSI target处于删除中会返回此项。 |
表2 响应参数iSCSITarget说明
| 名称 | 类型 | 描述 |
|---|---|---|
| iqn | String | iSCSI target IQN。 |
| ips | Array of ip | iSCSI target的IP属性集合，详见“表3 响应参数ip说明”。 |
| targetPortalIP | Object | iSCSI目标门户，详见“表4 响应参数targetPortalIP说明”。 |
| serverId | String | iSCSI target的IQN所在的服务器ID。 |
| allowlist.initiator | Array of initiator | iSCSI发起方（initiator）允许访问列表。详见“表6 响应参数initiator说明”。 |
| allowlist.target | Array of target | 目标端（target）的允许访问列表。详见“表7 响应参数target说明”。 |
表3 响应参数ip说明
| 名称 | 类型 | 描述 |
|---|---|---|
| ip | String | iSCSI target的IP。 |
| port | Integer | iSCSI target的端口号。 |
表4 响应参数targetPortalIP说明
| 名称 | 类型 | 描述 |
|---|---|---|
| ips | Array of ip | iSCSI目标门户的IP属性集合，详见“表5 响应参数targetPortalIP.ip说明”。 |
| status | String | iSCSI目标门户的状态：
说明 如果未配置，不返回该项。 |
表5 响应参数targetPortalIP.ip说明
| 名称 | 类型 | 描述 |
|---|---|---|
| ip | String | iSCSI目标门户的IP地址。 |
| port | Integer | iSCSI目标门户的端口号。 |
表6 响应参数initiator说明
| 名称 | 类型 | 描述 |
|---|---|---|
| IPs | Array of ip | 根据initiator IP地址设置的iSCSI发起方允许访问列表。 |
| names | Array of name | 根据initiator名称设置的iSCSI发起方允许访问列表。 |
表7 响应参数target说明
| 名称 | 类型 | 描述 |
|---|---|---|
| IPs | Array of ip | 通过target端IP进行设置的target允许访问列表，表示只允许通过target端的指定IP访问target。 |
| NICs | Array of NIC | 通过target端的网卡名称设置的target允许访问列表，表示只允许通过target端的指定网卡访问target。 |
请求示例1
单机版：查询iSCSI target名称中包含target，且关联的卷名称包含lun的iSCSI target，且只列出第1个到第3个的查询结果。
GET /rest/v1/block/target?filter=targetName:target and lunName:lun&range=1-3 HTTP/1.1
Date: Thu, 24 Jul 2025 08:16:12 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.66:1443响应示例1
HTTP/1.1 200 OK
x-hblock-request-id: c5271562a56f4805a9ce2f39214953ab
Connection: keep-alive
Content-Length: 874
Date: Thu, 24 Jul 2025 08:16:12 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"targets": [
{
"targetName": "targeta",
"maxSessions": 3,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:targeta.1",
"ips": [
{
"ip": "192.168.0.66",
"port": 3260
}
],
"serverId": "hblock_1",
"allowlist": {
"initiator": [
{
"IPs": [
"192.168.0.68"
]
},
{
"IPs": [
"192.168.0.70"
]
}
],
"target": [
{
"IPs": [
"192.168.0.66"
]
}
]
}
}
],
"chap": {
"name": "chanptest",
"status": "Disabled"
},
"createTime": 1753172337443,
"num": 1,
"reclaimPolicy": "Delete"
},
{
"targetName": "targetb",
"maxSessions": 1,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:targetb.2",
"ips": [
{
"ip": "192.168.0.66",
"port": 3260
}
],
"serverId": "hblock_1"
}
],
"createTime": 1753237554317,
"num": 1,
"reclaimPolicy": "Delete"
},
{
"targetName": "targete",
"maxSessions": 1,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:targete.3",
"ips": [
{
"ip": "192.168.0.66",
"port": 3260
}
],
"serverId": "hblock_1"
}
],
"createTime": 1753324422341,
"num": 1,
"reclaimPolicy": "Retain"
}
]
}
}请求示例2
集群版：查询iSCSI target名称中包含target0，且关联的卷名称包含lun0的iSCSI target，且只列出第1个到第3个的查询结果。
GET /rest/v1/block/target?filter=targetName:target0 and lunName:lun0&range=1-3 HTTP/1.1
Date: Thu, 24 Jul 2025 08:24:26 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.64:1443响应示例2
HTTP/1.1 200 OK
x-hblock-request-id: d820500731e04a03a2477fb09e2fd3fe
Connection: keep-alive
Content-Length: 1942
Date: Thu, 24 Jul 2025 08:24:26 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"targets": [
{
"targetName": "target0",
"maxSessions": 1,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target0.1",
"ips": [
{
"ip": "192.168.0.67",
"port": 3260
}
],
"serverId": "hblock_3",
"allowlist": {
"initiator": [
{
"IPs": [
"1.1.1.1"
]
}
]
}
},
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target0.2",
"ips": [
{
"ip": "192.168.0.64",
"port": 3260
}
],
"serverId": "hblock_2",
"allowlist": {
"initiator": [
{
"IPs": [
"1.1.1.1"
]
}
]
}
}
],
"createTime": 1752111608672,
"serverIds": [
"hblock_2",
"hblock_3"
],
"num": 2,
"reclaimPolicy": "Delete"
},
{
"targetName": "target01",
"maxSessions": 1,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target01.3",
"ips": [
{
"ip": "192.168.0.65",
"port": 3260
}
],
"serverId": "hblock_1"
},
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target01.4",
"ips": [
{
"ip": "192.168.0.67",
"port": 3260
}
],
"serverId": "hblock_3",
"allowlist": {
"target": [
{
"IPs": [
"192.168.0.67"
]
}
]
}
}
],
"createTime": 1752111636790,
"serverIds": [
"hblock_1",
"hblock_3"
],
"num": 2,
"reclaimPolicy": "Delete"
},
{
"targetName": "target03",
"maxSessions": 2,
"iSCSITargets": [
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target03.5",
"ips": [
{
"ip": "192.168.0.67",
"port": 3260
}
],
"serverId": "hblock_3",
"allowlist": {
"initiator": [
{
"names": [
"iqn.1991-05.com.microsoft:songt-0001"
],
"IPs": [
"192.168.0.70"
]
},
{
"IPs": [
"192.168.0.66"
]
}
],
"target": [
{
"IPs": [
"192.168.0.64"
]
},
{
"IPs": [
"192.168.0.65"
]
},
{
"IPs": [
"192.168.0.67"
]
},
{
"IPs": [
"192.168.0.64",
"192.168.0.65",
"192.168.0.67"
]
},
{
"IPs": [
"192.168.0.71"
]
}
]
}
},
{
"iqn": "iqn.2012-08.cn.ctyunapi.oos:target03.6",
"ips": [
{
"ip": "192.168.0.65",
"port": 3260
}
],
"serverId": "hblock_1",
"allowlist": {
"initiator": [
{
"names": [
"iqn.1991-05.com.microsoft:songt-0001"
],
"IPs": [
"192.168.0.70"
]
},
{
"IPs": [
"192.168.0.66"
]
}
],
"target": [
{
"IPs": [
"192.168.0.64"
]
},
{
"IPs": [
"192.168.0.65"
]
},
{
"IPs": [
"192.168.0.67"
]
},
{
"IPs": [
"192.168.0.64",
"192.168.0.65",
"192.168.0.67"
]
},
{
"IPs": [
"192.168.0.71"
]
}
]
}
}
],
"chap": {
"name": "chap-test",
"status": "Disabled"
},
"createTime": 1752111720420,
"serverIds": [
"hblock_1",
"hblock_3"
],
"num": 2,
"reclaimPolicy": "Delete"
}
]
}
}
