Document navigation

GetAccessPath

API Request

URLs

GET zstack/v1/block-volumes/access/path/

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c"
-X GET http://localhost:8080/zstack/v1/block-volumes/access/path?primaryStorageUuid=56963d0046b330839488e795b5109e44

Request Parameters

Name Type Location Description Optional Value Starting Version
systemTags List query Optional. The system tags. 4.7.11
userTags List query Optional. The user tags. 4.7.11
primaryStorageUuid String query The primary storage UUID. 4.7.11

API Response

Response Sample

{
  "pathInfos": [
    {
      "accessPathId": 1,
      "accessPathIqn": "iqn",
      "targetCount": 1
    }
  ]
}
Name Type Description Starting Version
success boolean Whether the operation succeeded. 4.7.11
inventory VolumeInventory See pathInfos. 4.7.11
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 4.7.11

#pathInfos

Name Type Description Starting Version
name String The resource name. 4.7.11
accessPathId String The access path id. 4.7.11
accessPathIqn String The access path iqn. 4.7.11
targetCount Integer The target count. 4.7.11
gatewayIps List The gateway IPs. 4.7.11

#error

Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 0.6
description String The brief description of the error. 0.6
details String The details about the error. 0.6
elaboration String The reserved field. Default value: null. 0.6
opaque LinkedHashMap The reserved field. Default value: null. 0.6
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 0.6

SDK Sample

Java SDK

CreateBlockVolumeAction action = new CreateBlockVolumeAction();
action.name = "example";
action.description = "block volume test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateBlockVolumeAction.Result res = action.call();

Python SDK

action = CreateBlockVolumeAction()
action.name = "example"
action.description = "block volume test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()