> ## 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. # Query status and config of Cluster Instances. > GET /api/v1/cluster/instances/status-config. Orchestrator 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/orchestrator.json) A successful response. Bad Request. The API gateway did not process the request because of invalid value of filter parameters. 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 application level access permission for the operation or does not have access scope to the project. 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/orchestrator.json GET /v1/cluster/instances/status-config openapi: 3.0.0 info: title: ZEDEDA Orchestrator Service description: >- The ZEDEDA Orchestrator Service is part of ZEDEDA Edge Orchestration Platform. Orchestrator service defines the user facing APIs to interact with a third-party client (e.x. Azure, Rancher). 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: ClusterInstanceConfiguration - name: ClusterInstanceStatus - name: ThirdPartyPluginManagement - name: DataStreamConfigs - name: AzureDeployments - name: APIUsageTracking externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/cluster-instance-management paths: /v1/cluster/instances/status-config: get: tags: - ClusterInstanceStatus summary: Query status and config of Cluster Instances. description: >- Query the status and config of Cluster Instances as reported by the edge nodes where the cluster nodes are deployed. operationId: ClusterInstanceStatus_QueryClusterInstanceStatusConfig parameters: - name: summary description: cluster instance summary flag in: query required: false schema: type: boolean - name: namePattern description: name pattern in: query required: false schema: type: string - name: project description: >- User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed in: query required: false schema: type: string - name: projectNamePattern description: project name pattern in: query required: false schema: type: string - name: next.pageToken description: Page Token in: query required: false schema: type: string - name: next.orderBy description: OrderBy helps in sorting the list response in: query required: false explode: true schema: type: array items: type: string - name: next.pageNum description: Page Number in: query required: false schema: type: number format: int64 - name: next.pageSize description: Defines the page size in: query required: false schema: type: number format: int64 - name: next.totalPages description: Total number of pages to be fetched. in: query required: false schema: type: number format: int64 - name: fields description: >- Fields to select: id, name, title, projectId, tags, clusterPolicyId, adminState, runState, edgeNodePoolIDs, serverNodeIDs, agentNodeIDs, nodesJobName, orchestratorClusterID, orchestratorClusterRunState, orchestratorClusterErrMsg, orchestratorClusterWarnMsg, projectName, clusterType in: query required: false explode: true schema: type: array items: 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/ClusterInstStatusListMsg' '400': description: >- Bad Request. The API gateway did not process the request because of invalid value of filter parameters. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '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 application level access permission for the operation or does not have access scope to the project. 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/cluster-instance-management components: schemas: ClusterInstStatusListMsg: type: object properties: list: type: array items: $ref: '#/components/schemas/ClusterInstStatusSummaryMsg' description: cluster instance status summary summaryByState: description: cluster instance status by state allOf: - $ref: '#/components/schemas/Summary' next: description: cursor next allOf: - $ref: '#/components/schemas/Cursor' description: >- ClusterInstStatusListMsg is used for listing the cluster instance statuses title: Cluster instance status list 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' ClusterInstStatusSummaryMsg: type: object properties: id: type: string description: System defined universally unique Id of the cluster instance readOnly: true pattern: '[0-9A-Za-z-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/ClusterInstStatusSummaryMsg/properties/id' keyword: uniqueItems sourceValue: true name: type: string description: >- User defined name of the cluster instance, unique across the enterprise. Once cluster instance is created, name can’t be changed maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/ClusterInstStatusSummaryMsg/properties/name' keyword: uniqueItems sourceValue: true title: type: string description: >- User defined title of the cluster instance. Title can be changed at any time maxLength: 256 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$ projectId: type: string description: project name which the given app instance belong to tags: type: object additionalProperties: type: string description: >- Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3. maxLength: 32 pattern: ^[^<%&?/\>]+$ clusterPolicyId: type: string description: System defined universally unique Id of the cluster policy readOnly: true pattern: '[0-9A-Za-z-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: >- #/definitions/ClusterInstStatusSummaryMsg/properties/clusterPolicyId keyword: uniqueItems sourceValue: true adminState: description: SPU details allOf: - $ref: '#/components/schemas/AdminState' runState: description: operation status allOf: - $ref: '#/components/schemas/ClusterRunState' edgeNodePoolIDs: type: array items: type: string description: Array of Device IDs serverNodeIDs: type: array items: type: string description: Array of Server App Inst IDs agentNodeIDs: type: array items: type: string description: Array of Agent App Inst IDs nodesJobName: type: string description: Name of the job object tracking ClusterNodes deployment maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: >- #/definitions/ClusterInstStatusSummaryMsg/properties/nodesJobName keyword: uniqueItems sourceValue: true orchestratorClusterID: type: string description: Orchestrator cluster object ID maxLength: 256 orchestratorClusterRunState: description: Orchestrator cluster object's state allOf: - $ref: '#/components/schemas/RunState' orchestratorClusterErrMsg: description: Error message from Orchestrator cluster object allOf: - $ref: '#/components/schemas/OrchestratorObjectError' orchestratorClusterWarnMsg: description: Warning message from Orchestrator cluster object allOf: - $ref: '#/components/schemas/OrchestratorObjectError' projectName: type: string description: project name which the given cluster instance belong to maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/ClusterInstStatusSummaryMsg/properties/projectName' keyword: uniqueItems sourceValue: true clusterType: description: Type of cluster allOf: - $ref: '#/components/schemas/ClusterType' description: >- ClusterInstStatusSummaryMsg stores the summary of the cluster instance status title: Cluster instance status summary Summary: type: object properties: description: type: string description: Summary description total: type: number format: int64 description: Total values: type: object additionalProperties: type: integer format: int64 description: 'Values: Map for storing ' description: Summary is used to store the Summary details title: Summary is used to store the Summary details Cursor: type: object properties: pageToken: type: string description: Page Token orderBy: type: array items: type: string description: OrderBy helps in sorting the list response pageNum: type: number format: int64 description: Page Number pageSize: type: number format: int64 description: Defines the page size totalPages: type: number format: int64 description: Total number of pages to be fetched. description: >- Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. title: Cursor is used as filter in list operation. 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 AdminState: type: string enum: - ADMIN_STATE_UNSPECIFIED - ADMIN_STATE_CREATED - ADMIN_STATE_DELETED - ADMIN_STATE_ACTIVE - ADMIN_STATE_INACTIVE - ADMIN_STATE_REGISTERED - ADMIN_STATE_ARCHIVED - ADMIN_STATE_DELETION_PENDING default: ADMIN_STATE_UNSPECIFIED description: |- - ADMIN_STATE_CREATED: Entity Created in the controller - ADMIN_STATE_DELETED: Entity Deleted in the controller - ADMIN_STATE_ACTIVE: Entity Activated in the controller - ADMIN_STATE_INACTIVE: Entity Deactivated in the controller - ADMIN_STATE_REGISTERED: Specific to Edge-node - Edge-node Registered with the controller - ADMIN_STATE_ARCHIVED: Entity Archived in the controller - ADMIN_STATE_DELETION_PENDING: Entity was marked as Deleted but not yet deleted in the controller title: AdminState - On update, please update AdminState_HttpRequest as well ClusterRunState: type: string enum: - CLUSTER_RUN_STATE_UNSPECIFIED - CLUSTER_RUN_STATE_INIT - CLUSTER_RUN_STATE_PROVISIONING_SEED_SERVER - CLUSTER_RUN_STATE_PROVISIONED_SEED_SERVER - CLUSTER_RUN_STATE_UNHEALTHY - CLUSTER_RUN_STATE_PROVISIONING_NODES - CLUSTER_RUN_STATE_HEALTHY - CLUSTER_RUN_STATE_PARTIALLY_HEALTHY - CLUSTER_RUN_STATE_OFFLINE default: CLUSTER_RUN_STATE_UNSPECIFIED description: |- - CLUSTER_RUN_STATE_INIT: Cluster Initializing - CLUSTER_RUN_STATE_PROVISIONING_SEED_SERVER: Cluster Provisioning seed server - CLUSTER_RUN_STATE_PROVISIONED_SEED_SERVER: Cluster Provisioned seed server - CLUSTER_RUN_STATE_UNHEALTHY: Cluster unhealthy - CLUSTER_RUN_STATE_PROVISIONING_NODES: Cluster Provisioning node - CLUSTER_RUN_STATE_HEALTHY: Cluster healthy - CLUSTER_RUN_STATE_PARTIALLY_HEALTHY: Cluster partially healthy - CLUSTER_RUN_STATE_OFFLINE: Cluster offline title: Run-time state of an object, reported by EVE 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 OrchestratorObjectError: type: object properties: description: type: string description: Description of the error severity: type: string description: Severity of the error objectName: type: string description: Name of the orchestrator object description: >- OrchestratorObjectError store the error occurred at the Orchestrator object title: >- OrchestratorObjectError is used to store the error details of the Orchestrator object. required: - description - severity - objectName ClusterType: type: string enum: - CLUSTER_TYPE_UNSPECIFIED - CLUSTER_TYPE_K3S - CLUSTER_TYPE_TKG_ATTACH default: CLUSTER_TYPE_UNSPECIFIED title: |- - CLUSTER_TYPE_K3S: cluster type is k3s - CLUSTER_TYPE_TKG_ATTACH: cluster type is TKG, with subtype ATTACH 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 securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````