> ## Documentation Index > Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL. > Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other. > Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking. > Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify. # Get edge volume instance status (GET /v1/volumes/instances/name/{name}/status) > GET /api/v1/volumes/instances/name/{name}/status. Storage API reference. Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request. > [accordion] Connect your console > > Sign in to your usual ZedCloud console, then open: > >
    >
  1. Profile menu
  2. Help & Documentation
  3. API Reference
    4. >
> > Your cluster and authorization are filled in automatically. No token to copy. > [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference) Modifying requests stay off until you enable them. [Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/storage.json) A successful response. Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project. Not Found. The API gateway did not process the request because the requested resource could not be found. Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. An unexpected error response. ## OpenAPI ````yaml openapi/services/storage.json GET /v1/volumes/instances/name/{name}/status openapi: 3.0.0 info: title: ZEDEDA Storage Service description: >- The ZEDEDA Storage Service is helper service to ZEDEDA Edge Application Service. This service allows customers to store edge application images and other artifacts (e.g. logo, screenshot, license, developer agreement etc.) in Datastores. This service allows customers to select datastores -- ZEDEDA owned and operated Datastores in public cloud (AWS S3 or Azure Blobstorage) -- Public Datastores (e.g. Docker Hub, Azure Container registry etc.) -- Customer owned and operated Datastores in public cloud (AWS S3 or Azure Blobstorage) -- Customer owned and operated Datastores in their own enterprise Data Centre This service allows binary files of the images and artifacts to be uploaded in one of the above Datastores, artifacts to be downloaded from datastores. Edge nodes will download edge application image binary files from these datastores termsOfService: https://www.zededa.com/terms version: '1.0' contact: name: ZEDEDA API Support url: https://www.zededa.com/support email: support@zededa.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{apiHost}/api variables: apiHost: default: invalid.invalid description: Connect from ZedUI to supply your verified API destination. security: - BearerToken: [] tags: - name: ImageConfiguration - name: DatastoreConfiguration - name: ArtifactManager - name: VolumeInstanceConfiguration - name: VolumeInstanceStatus externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage paths: /v1/volumes/instances/name/{name}/status: get: tags: - VolumeInstanceStatus summary: Get edge volume instance status description: Get the status of an edge volume instance record. operationId: VolumeInstanceStatus_GetVolumeInstanceStatusByName parameters: - name: name in: path required: true schema: type: string - name: X-Request-Id in: header required: false description: User-Agent specified id to track a request schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/VolInstStatusMsg' '401': description: >- Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '403': description: >- Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '404': description: >- Not Found. The API gateway did not process the request because the requested resource could not be found. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '500': description: >- Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '504': description: >- Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage components: schemas: VolInstStatusMsg: type: object properties: id: type: string name: type: string deviceId: type: string title: device on which this volume is located runState: $ref: '#/components/schemas/RunState' projectId: type: string progressPercentage: type: integer format: int64 usage: $ref: '#/components/schemas/DeviceObjectUsageInfo' resource: $ref: '#/components/schemas/VolInstResource' sha256: type: string type: $ref: '#/components/schemas/VolumeInstanceType' deviceState: $ref: '#/components/schemas/SWState' blobs: type: array items: $ref: '#/components/schemas/BlobInfo' errInfo: type: array items: $ref: '#/components/schemas/DeviceError' rawStatus: type: string clusterVolInstanceStatus: $ref: '#/components/schemas/ClusterVolInstanceStatus' ZsrvResponse: type: object properties: operationType: title: |- Describes one of the operations type : possible values Read/Delete/Create/Update/List allOf: - $ref: '#/components/schemas/ZcOpsType' operationStatus: title: if this is log running job allOf: - $ref: '#/components/schemas/ZcOpsStatus' objectKind: type: string title: zedcloud object kind on which the operation was performed objectId: type: string title: Unique value identifies the object that was operated on objectName: type: string title: name of the object objectRevision: type: string title: |- object revision post the operation, note Read operation doesn't change the revision objectType: $ref: '#/components/schemas/ObjectType' operationTime: type: string title: time of operation startTime: type: string title: total time taken by operations endTime: type: string user: type: string title: the operation is performed on behalf of this user httpStatusCode: type: integer format: int32 title: http response httpStatusMsg: type: string title: summary of the error in text format jobId: type: string title: for tracking asynchronous tasks error: type: array items: $ref: '#/components/schemas/ZsrvError' title: |- one or more errors will be set if the operation failed i.e. httpStatusCode != 2xx googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' RunState: type: string enum: - RUN_STATE_UNSPECIFIED - RUN_STATE_ONLINE - RUN_STATE_HALTED - RUN_STATE_INIT - RUN_STATE_REBOOTING - RUN_STATE_OFFLINE - RUN_STATE_UNKNOWN - RUN_STATE_UNPROVISIONED - RUN_STATE_PROVISIONED - RUN_STATE_SUSPECT - RUN_STATE_DOWNLOADING - RUN_STATE_RESTARTING - RUN_STATE_PURGING - RUN_STATE_HALTING - RUN_STATE_ERROR - RUN_STATE_VERIFYING - RUN_STATE_LOADING - RUN_STATE_CREATING_VOLUME - RUN_STATE_BOOTING - RUN_STATE_MAINTENANCE_MODE - RUN_STATE_START_DELAYED - RUN_STATE_BASEOS_UPDATING - RUN_STATE_PREPARING_POWEROFF - RUN_STATE_POWERING_OFF - RUN_STATE_PREPARED_POWEROFF default: RUN_STATE_UNSPECIFIED description: |- - RUN_STATE_ONLINE: Entity Online - RUN_STATE_HALTED: Entity Halted - RUN_STATE_INIT: Entity Initializing - RUN_STATE_REBOOTING: Entity Rebooting - RUN_STATE_OFFLINE: Entity Offline - RUN_STATE_UNKNOWN: Entity state Unknown - RUN_STATE_UNPROVISIONED: Entity Unprovisioned - RUN_STATE_PROVISIONED: Entity Provisioned - RUN_STATE_SUSPECT: Entity Suspect - RUN_STATE_DOWNLOADING: Edge-node downloading entity artifacts - RUN_STATE_RESTARTING: Entity Restarting - RUN_STATE_PURGING: Entity Purging - RUN_STATE_HALTING: Entity Halting - RUN_STATE_ERROR: Entity encountered an error - RUN_STATE_VERIFYING: Verification of downloaded Artifacts in Progress. - RUN_STATE_LOADING: Loading of Artifacts into local datastore in Progress. - RUN_STATE_CREATING_VOLUME: Volume creation from artifacts in Progress - RUN_STATE_BOOTING: Entity booting up - RUN_STATE_MAINTENANCE_MODE: Entity maintenance mode - RUN_STATE_START_DELAYED: Application start delayed as per configuration - RUN_STATE_BASEOS_UPDATING: Device BaseOs Update in Progress - RUN_STATE_PREPARING_POWEROFF: device preparing power off - shutting down all app instances - RUN_STATE_POWERING_OFF: device powering off from local profile server - RUN_STATE_PREPARED_POWEROFF: device prepared power off - all app instances are shut down title: RunState - On update, please update RunState_HttpRequest as well DeviceObjectUsageInfo: type: object properties: createTime: type: object format: date-time description: Timestamp at which object was created refCount: type: number format: int64 description: Object refcount lastRefCountChangeTime: type: object format: date-time description: Timestamp at which object refcount was last changed description: >- DeviceObjectUsageInfo provides the metadata of object usage on the device title: DeviceObjectUsageInfo carries metadata of object usage on the device. required: - createTime - refCount - lastRefCountChangeTime VolInstResource: type: object properties: curSizeBytes: type: string format: uint64 maxSizeBytes: type: string format: uint64 VolumeInstanceType: type: string enum: - VOLUME_INSTANCE_TYPE_UNSPECIFIED - VOLUME_INSTANCE_TYPE_EMPTYDIR - VOLUME_INSTANCE_TYPE_BLOCKSTORAGE - VOLUME_INSTANCE_TYPE_HOSTFS - VOLUME_INSTANCE_TYPE_TMPFS - VOLUME_INSTANCE_TYPE_SECRET - VOLUME_INSTANCE_TYPE_NFS - VOLUME_INSTANCE_TYPE_AWS_BLOCK_STORAGE - VOLUME_INSTANCE_TYPE_CONTENT_TREE default: VOLUME_INSTANCE_TYPE_UNSPECIFIED title: >- VolumeInstanceType - On update, please update VolumeInstanceType_HttpRequest as well SWState: type: string enum: - SW_STATE_UNSPECIFIED - SW_STATE_INITIAL - SW_STATE_DOWNLOAD_IN_PROGRESS - SW_STATE_DOWNLOADED - SW_STATE_VERIFIED - SW_STATE_INSTALLED - SW_STATE_BOOTING - SW_STATE_RUNNING - SW_STATE_HALTING - SW_STATE_HALTED - SW_STATE_REFRESHING - SW_STATE_PURGING - SW_STATE_RESOLVING_TAG - SW_STATE_RESOLVED_TAG - SW_STATE_CREATING_VOLUME - SW_STATE_CREATED_VOLUME - SW_STATE_VERIFYING - SW_STATE_LOADING - SW_STATE_LOADED - SW_STATE_AWAITNETWORKINSTANCE default: SW_STATE_UNSPECIFIED description: |- - SW_STATE_RESOLVING_TAG: Prior to DOWNLOAD_STARTED we go through these: Resolving an image tag - SW_STATE_RESOLVED_TAG: Tag has been resolved/failed - SW_STATE_CREATING_VOLUME: Prior to INSTALLED we go through these: Volume create in progress - SW_STATE_CREATED_VOLUME: Volume create done/failed - SW_STATE_VERIFYING: Verification in-progress - SW_STATE_LOADING: Loading blob in CAS - SW_STATE_LOADED: Loaded blob in CAS - SW_STATE_AWAITNETWORKINSTANCE: Wait for network instance title: State of EVE/Edge Application software BlobInfo: type: object properties: sha256: type: string resource: $ref: '#/components/schemas/VolInstResource' usage: $ref: '#/components/schemas/DeviceObjectUsageInfo' State: $ref: '#/components/schemas/SWState' progressPercentage: type: integer format: int64 errInfo: $ref: '#/components/schemas/DeviceError' DeviceError: type: object properties: description: type: string description: Description of the error severity: type: string description: Severity of the error allOf: - $ref: '#/components/schemas/Severity' timestamp: type: object format: date-time description: Timestamp at which error had occurred entities: type: array items: $ref: '#/components/schemas/DeviceEntity' description: objects referenced by the description or retry_condition retryCondition: type: string description: condition for retry description: DeviceError store the error occurred at the device side title: DeviceError is used to store the error details of the hardware. required: - description - severity - timestamp - entities ClusterVolInstanceStatus: type: object properties: state: $ref: '#/components/schemas/infoStorageVolumeState' replicas: type: array items: $ref: '#/components/schemas/VolumeInstanceReplicaStatus' attachmentState: $ref: '#/components/schemas/infoStorageVolumePVCStatus' creationTime: type: string format: date-time size: type: string format: uint64 actualSize: type: string format: uint64 robustness: $ref: '#/components/schemas/infoStorageVolumeRobustness' robustnessSubstate: $ref: '#/components/schemas/infoStorageHealthStatus' ZcOpsType: type: string enum: - OPS_TYPE_UNSPECIFIED - OPS_TYPE_READ - OPS_TYPE_DELETE - OPS_TYPE_CREATE - OPS_TYPE_UPDATE - OPS_TYPE_LIST default: OPS_TYPE_UNSPECIFIED title: ZedCloud internal operation type ZcOpsStatus: type: string enum: - OPS_STATUS_UNSPECIFIED - OPS_STATUS_PENDING - OPS_STATUS_ONGOING - OPS_STATUS_COMPLETE default: OPS_STATUS_UNSPECIFIED description: >- - OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING. - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases. title: ZedCloud internal operation status ObjectType: type: string enum: - OBJECT_TYPE_UNSPECIFIED - OBJECT_TYPE_USER - OBJECT_TYPE_EDGE_NODE - OBJECT_TYPE_EDGE_APP - OBJECT_TYPE_IMAGE - OBJECT_TYPE_EDGE_APP_INSTANCE - OBJECT_TYPE_PROJECT - OBJECT_TYPE_NETWORK - OBJECT_TYPE_DATASTORE - OBJECT_TYPE_SERVICE - OBJECT_TYPE_SERVICE_INSTANCE - OBJECT_TYPE_ENTERPRISE - OBJECT_TYPE_ROLE - OBJECT_TYPE_CREDENTIAL - OBJECT_TYPE_NETWORK_INSTANCE - OBJECT_TYPE_VOLUME_INSTANCE - OBJECT_TYPE_REALM - OBJECT_TYPE_AUTHPROFILE - OBJECT_TYPE_POLICY - OBJECT_TYPE_APP_POLICY - OBJECT_TYPE_CLUSTER_INSTANCE - OBJECT_TYPE_PLUGIN - OBJECT_TYPE_DOC_POLICY - OBJECT_TYPE_ORCHESTRATOR_CLUSTER - OBJECT_TYPE_TAGS - OBJECT_TYPE_EDGE_NODE_INTERFACE - OBJECT_TYPE_DEPLOYMENT - OBJECT_TYPE_ENTITLEMENTS - OBJECT_TYPE_DATA_STREAM - OBJECT_TYPE_API_USAGE - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT - OBJECT_TYPE_PATCH_ENVELOPE - OBJECT_TYPE_RESOURCE_USAGE_TRACK - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE - OBJECT_TYPE_DEV_PASSTHROUGH - OBJECT_TYPE_EDGE_NODE_CLUSTER - OBJECT_TYPE_ASSET_GROUP - OBJECT_TYPE_APP_PROFILE - OBJECT_TYPE_PROFILE_DEPLOYMENT - OBJECT_TYPE_ZKS_INSTANCE - OBJECT_TYPE_CLUSTER_GROUP default: OBJECT_TYPE_UNSPECIFIED ZsrvError: type: object properties: ec: title: |- Enumrated error code, describes more granular numerical value than just httpStatus allOf: - $ref: '#/components/schemas/ZsrvErrorCode' location: type: string title: 'Ignore: Internal field only' details: type: string title: Field captures string description of details protobufAny: type: object properties: typeUrl: type: string value: type: string format: byte Severity: type: string enum: - SEVERITY_UNSPECIFIED - SEVERITY_NOTICE - SEVERITY_WARNING - SEVERITY_ERROR default: SEVERITY_UNSPECIFIED title: Severity tells the severity type DeviceEntity: type: object properties: entity: $ref: '#/components/schemas/Entity' entityId: type: string entityName: type: string infoStorageVolumeState: type: string enum: - STORAGE_VOLUME_STATE_UNSPECIFIED - STORAGE_VOLUME_STATE_CREATING - STORAGE_VOLUME_STATE_ATTACHED - STORAGE_VOLUME_STATE_DETACHED - STORAGE_VOLUME_STATE_ATTACHING - STORAGE_VOLUME_STATE_DETACHING - STORAGE_VOLUME_STATE_DELETING default: STORAGE_VOLUME_STATE_UNSPECIFIED title: >- StorageVolumeState is the kubernetes 'state' field of a replicated csi-driver volume. Refer to: https://github.com/longhorn/longhorn-manager/blob/v1.6.2/k8s/pkg/apis/longhorn/v1beta1/volume.go#L14 VolumeInstanceReplicaStatus: type: object properties: nodeName: type: string rebuildProgressPercentage: type: integer format: int64 status: $ref: '#/components/schemas/infoStorageVolumeReplicaStatus' infoStorageVolumePVCStatus: type: string enum: - STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED - STORAGE_VOLUME_PVC_STATUS_BOUND - STORAGE_VOLUME_PVC_STATUS_PENDING - STORAGE_VOLUME_PVC_STATUS_AVAILABLE - STORAGE_VOLUME_PVC_STATUS_RELEASED - STORAGE_VOLUME_PVC_STATUS_FAILED default: STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED title: >- StorageVolumePVCStatus is the kubernetes 'phase' of a PVC. Listed as status in cli. Refer to: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase infoStorageVolumeRobustness: type: string enum: - STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED - STORAGE_VOLUME_ROBUSTNESS_HEALTHY - STORAGE_VOLUME_ROBUSTNESS_DEGRADED - STORAGE_VOLUME_ROBUSTNESS_FAULTED default: STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED title: >- StorageVolumeRobustness is the 'robustness' of a replicated csi-driver volume. Refer to: https://github.com/longhorn/longhorn-manager/blob/v1.6.2/k8s/pkg/apis/longhorn/v1beta1/volume.go#L25 infoStorageHealthStatus: type: string enum: - STORAGE_HEALTH_STATUS_UNSPECIFIED - STORAGE_HEALTH_STATUS_HEALTHY - STORAGE_HEALTH_STATUS_DEGRADED_2_REPLICA_AVAILABLE_REPLICATING - STORAGE_HEALTH_STATUS_DEGRADED_2_REPLICA_AVAILABLE_NOT_REPLICATING - STORAGE_HEALTH_STATUS_DEGRADED_1_REPLICA_AVAILABLE_REPLICATING - STORAGE_HEALTH_STATUS_DEGRADED_1_REPLICA_AVAILABLE_NOT_REPLICATING - STORAGE_HEALTH_STATUS_FAILED default: STORAGE_HEALTH_STATUS_UNSPECIFIED description: >- StorageHealthStatus is a higher level tracking status to show redundancy/failure-zone level and rebuild progress. ZsrvErrorCode: type: string enum: - zMsgErrorNone - zMsgSucess - NotFound - AlreadyExists - VersionMismatch - RangeError - LargeResult - IncompleteData - InvalidData - FunctionUnsupported - NoMemory - SendFailure - Timeout - BadReqBody - BadReqParam - InvalidFieldFormat - UrlNotFound - ApiVersionNotSupported - Unauthorized - Forbidden - Conflict - NotModified - DependencyConflict - JsonFmtError - ProtoFmtError - CertError - DataBaseConnection - DBError - zMsgAccepted - zMsgCreated - PreConditionFailed - InternalServerError default: zMsgErrorNone description: |- - zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't expected - FunctionUnsupported: this feature unavailable on this version of device - InvalidFieldFormat: message contained the field that wasn't correctly formatted - JsonFmtError: Marshal / Unmarshal errors - DataBaseConnection: generic DB error title: ZedCould internal error code Entity: type: string enum: - ENTITY_UNSPECIFIED - ENTITY_BASE_OS - ENTITY_SYSTEM_ADAPTER - ENTITY_VAULT - ENTITY_ATTESTATION - ENTITY_APP_INSTANCE - ENTITY_PORT - ENTITY_NETWORK - ENTITY_NETWORK_INSTANCE - ENTITY_CONTENT_TREE - ENTITY_CONTENT_BLOB - ENTITY_VOLUME default: ENTITY_UNSPECIFIED description: |- - ENTITY_UNSPECIFIED: Invalid Device Entity - ENTITY_BASE_OS: Base OS entity - ENTITY_SYSTEM_ADAPTER: System Adapter Entity - ENTITY_VAULT: Vault Entity - ENTITY_ATTESTATION: Attestation Entity - ENTITY_APP_INSTANCE: App Instance Entity - ENTITY_PORT: Port Entity - ENTITY_NETWORK: Network Entity - ENTITY_NETWORK_INSTANCE: Network Instance Entity - ENTITY_CONTENT_TREE: ContentTree Entity - ENTITY_CONTENT_BLOB: Blob Entity - ENTITY_VOLUME: VOLUME Entity title: Edge node components infoStorageVolumeReplicaStatus: type: string enum: - STORAGE_VOLUME_REPLICA_STATUS_UNSPECIFIED - STORAGE_VOLUME_REPLICA_STATUS_REBUILDING - STORAGE_VOLUME_REPLICA_STATUS_ONLINE - STORAGE_VOLUME_REPLICA_STATUS_FAILED - STORAGE_VOLUME_REPLICA_STATUS_OFFLINE - STORAGE_VOLUME_REPLICA_STATUS_STARTING - STORAGE_VOLUME_REPLICA_STATUS_STOPPING default: STORAGE_VOLUME_REPLICA_STATUS_UNSPECIFIED description: >- StorageVolumeReplicaStatus is a higher level status which combines replica and engine status to show a simplified view of a replica rebuild state. securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````