Query status of edge volume instances

curl --request GET \
  --url https://{apiHost}/api/v1/volumes/instances/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/volumes/instances/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "deviceId": "<string>",
      "runState": "RUN_STATE_UNSPECIFIED",
      "createTime": "2023-11-07T05:31:56Z",
      "projectId": "<string>",
      "type": "VOLUME_INSTANCE_TYPE_UNSPECIFIED",
      "deviceState": "SW_STATE_UNSPECIFIED",
      "progressPercentage": 123,
      "deviceName": "<string>",
      "projectName": "<string>",
      "edgeNodeClusterID": "<string>",
      "clusterVolInstanceStatus": {
        "state": "STORAGE_VOLUME_STATE_UNSPECIFIED",
        "replicas": [
          {
            "nodeName": "<string>",
            "rebuildProgressPercentage": 123,
            "status": "STORAGE_VOLUME_REPLICA_STATUS_UNSPECIFIED"
          }
        ],
        "attachmentState": "STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED",
        "creationTime": "2023-11-07T05:31:56Z",
        "size": "<string>",
        "actualSize": "<string>",
        "robustness": "STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED",
        "robustnessSubstate": "STORAGE_HEALTH_STATUS_UNSPECIFIED"
      }
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByType": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 123,
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Query Parameters

deviceName

string

projectName

string

namePattern

string

runState

enum<string>

default:UNSPECIFIED

Available options:

UNSPECIFIED,

ONLINE,

HALTED,

INIT,

REBOOTING,

OFFLINE,

UNKNOWN,

UNPROVISIONED,

PROVISIONED,

SUSPECT,

DOWNLOADING,

RESTARTING,

PURGING,

HALTING,

ERROR,

VERIFYING,

LOADING,

CREATING_VOLUME,

BOOTING,

MAINTENANCE_MODE,

START_DELAYED,

BASEOS_UPDATING,

PREPARING_POWEROFF,

POWERING_OFF,

PREPARED_POWEROFF

type

enum<string>

default:UNSPECIFIED

Available options:

UNSPECIFIED,

EMPTYDIR,

BLOCKSTORAGE,

HOSTFS,

TMPFS,

SECRET,

NFS,

AWS_BLOCK_STORAGE,

CONTENT_TREE

imageName

string

appInstName

string

deviceNamePattern

string

projectNamePattern

string

next.pageToken

string

Page Token

next.orderBy

string[]

OrderBy helps in sorting the list response

next.pageNum

number<int64>

Page Number

next.pageSize

number<int64>

Defines the page size

next.totalPages

number<int64>

Total number of pages to be fetched.

summary

boolean

fields

string[]

Response

A successful response.

list

object[]

Show child attributes

summaryByState

Summary is used to store the Summary details · object

Summary is used to store the Summary details

Show child attributes

summaryByType

Summary is used to store the Summary details · object

Summary is used to store the Summary details

Show child attributes

totalCount

integer<int64>

Cursor is used as filter in list operation. · object

Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.

Show child attributes

⌘I

Query status of edge volume instances

curl --request GET \
  --url https://{apiHost}/api/v1/volumes/instances/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/volumes/instances/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "deviceId": "<string>",
      "runState": "RUN_STATE_UNSPECIFIED",
      "createTime": "2023-11-07T05:31:56Z",
      "projectId": "<string>",
      "type": "VOLUME_INSTANCE_TYPE_UNSPECIFIED",
      "deviceState": "SW_STATE_UNSPECIFIED",
      "progressPercentage": 123,
      "deviceName": "<string>",
      "projectName": "<string>",
      "edgeNodeClusterID": "<string>",
      "clusterVolInstanceStatus": {
        "state": "STORAGE_VOLUME_STATE_UNSPECIFIED",
        "replicas": [
          {
            "nodeName": "<string>",
            "rebuildProgressPercentage": 123,
            "status": "STORAGE_VOLUME_REPLICA_STATUS_UNSPECIFIED"
          }
        ],
        "attachmentState": "STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED",
        "creationTime": "2023-11-07T05:31:56Z",
        "size": "<string>",
        "actualSize": "<string>",
        "robustness": "STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED",
        "robustnessSubstate": "STORAGE_HEALTH_STATUS_UNSPECIFIED"
      }
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByType": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 123,
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Query status of edge volume instances

Authorizations

Headers

Query Parameters

Response