> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Instance

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Query Parameters

**instanceId** `string` *required*

ID of the instance being queried.

## Response

**id** `string` *required*

Instance ID.

**name** `string` *required*

Instance name.

**clusterId** `string` *required*

Cluster ID.

**clusterName** `string` *required*

Name of the cluster.

**imageUrl** `string` *required*

Container image URL.

**imageAuthId** `string` *required*

Image registry authentication information.

**command** `string` *required*

Container startup command.

**entrypoint** `string` *required*

Container startup entrypoint.

**cpuNum** `string` *required*

Number of CPU cores allocated to the instance.

**memory** `string` *required*

Memory size allocated to the instance, in GB.

**gpuNum** `string` *required*

Number of GPU cards allocated to the instance.

**status** `string` *required*

Instance status. Possible values:

* `toCreate`: Pending creation
* `creating`: Creating
* `pulling`: Pulling image
* `running`: Running
* `toStart`: Pending start
* `starting`: Starting
* `toStop`: Pending stop
* `stopping`: Stopping
* `exited`: Stopped
* `toRestart`: Pending restart
* `restarting`: Restarting
* `toRemove`: Pending deletion
* `removing`: Deleting
* `removed`: Deleted
* `toReset`: Pending reset (upgrade)
* `resetting`: Resetting
* `migrating`: Migrating
* `freezing`: Freezing

**statusError** `object`

Error information when instance creation fails or the instance is unavailable.

**properties**

**state** `string`

Abnormal instance status.

**message** `string`

Error message.

**network** `object`

VPC network information for the instance.

**properties**

**id** `string`

VPC network ID.

**ip** `string`

Instance IP address.

**portMappings** `object[]` *required*

Instance port mapping information.

**properties**

**port** `integer` *required*

Port number.

**endpoint** `string` *required*

Endpoint.

**type** `string` *required*

Protocol type.

**volumeMounts** `object[]`

Storage configuration for the instance.

**properties**

**type** `string`

Storage type. Possible values:

* network: Cloud storage.
* local: Local storage.

**size** `number`

Storage capacity.

**id** `string`

Cloud storage ID. Only present when the storage type is "network".

**mountPath** `string`

Mount path for the storage.

**node** `object[]`

Node information.

**properties**

**maxRootfsSize** `number`

Maximum available system disk size.

**jobs** `object[]`

Tasks currently running on the instance.

**properties**

**id** `string`

Task ID.

**type** `string`

Task type. Currently, only saveImage is supported, which indicates saving an image.

**envs** `object[]`

Instance environment variable information.

**properties**

**key** `string`

Environment variable name.

**value** `string`

Environment variable value.

**connectComponentSSH** `object`

Instance SSH connection information.

**properties**

**sshCommand** `string`

Command for SSH remote login.

**password** `string`

Password for SSH remote login.

**isRunning** `boolean`

Whether SSH remote login is active.

**connectComponentWebTerminal** `object`

Instance WebSSH connection information.

**properties**

**address** `string`

Address for web-based remote login.

**username** `string`

Username for web-based remote login.

**password** `string`

Password for web-based remote login.

**isRunning** `boolean`

Whether web-based remote login is active.

**connectComponentJupyter** `object`

Jupyter connection information for the instance (if available).

**properties**

**port** `integer`

Connection port.

**address** `string`

Connection address.

**isRunning** `boolean`

Whether Jupyter remote login is active.

**connectComponentLog** `object`

Instance log connection information (HTTP Stream).

**properties**

**systemLogAddress** `string`

System log address.

**instanceLogAddress** `string`

Instance log address.

**isRunning** `boolean`

Whether log connection is active.

**kind** `string`

Instance type.

**billingMode** `string` *required*

Billing mode for the instance. Values:

* onDemand: Pay-as-you-go billing.
* monthly: Subscription (monthly or yearly) billing.
* spot: Spot instance billing.

**endTime** `string`

Expiration time for subscription instances. For pay-as-you-go instances, returns -1.

**freeStorageSize** `integer`

Free system disk size (GB).

**keepDataDay** `integer`

Number of days data is retained after the instance is shut down.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.