Get Access Path List

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

Headers

Authorization: OAuth the-session-uuid

Curl Examples

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

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
systemTags (optional)ListquerySystem tags 4.7.11
userTags (optional)ListqueryUser tags 4.7.11
primaryStorageUuidStringqueryPrimary Storage UUID 4.7.11

API Response

Response Example

{
  "pathInfos": [
    {
      "accessPathId": 1,
      "accessPathIqn": "iqn",
      "targetCount": 1
    }
  ]
}
NameTypeDescriptionStarting Version
successboolean 4.7.11
pathInfosListFor details, see pathInfos4.7.11
errorErrorCodeError code. If not null, indicates the operation failed. This field is null when the operation succeeds. For details, see error4.7.11

pathInfos

NameTypeDescriptionStarting Version
nameStringResource name4.7.11
accessPathIdStringAccess path ID4.7.11
accessPathIqnStringAccess path IQN4.7.11
targetCountIntegerNumber of associated targets4.7.11
gatewayIpsListGateway IP4.7.11

error

NameTypeDescriptionStarting Version
codeStringError code number, globally unique identifier for the error, such as SYS.1000, HOST.10010.6
descriptionStringBrief description of the error0.6
detailsStringDetailed error information0.6
elaborationStringReserved field, defaults to null0.6
opaqueLinkedHashMapReserved field, defaults to null0.6
causeErrorCodeRoot cause. The source error that triggered the current error. If there is no original error, this field is null0.6

SDK Examples

Java SDK

GetAccessPathAction action = new GetAccessPathAction();
action.primaryStorageUuid = "56963d0046b330839488e795b5109e44";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetAccessPathAction.Result res = action.call();

Python SDK

GetAccessPathAction action = GetAccessPathAction()
action.primaryStorageUuid = "56963d0046b330839488e795b5109e44"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetAccessPathAction.Result res = action.call()