GET
/
gpu-instance
/
openapi
/
v1
/
gpu
/
instances
curl --request GET \
  --url https://api.novita.ai/gpu-instance/openapi/v1/gpu/instances \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "instances": [
    {
      "id": "<string>",
      "name": "<string>",
      "clusterId": "<string>",
      "clusterName": "<string>",
      "status": "<string>",
      "imageUrl": "<string>",
      "imageAuthId": "<string>",
      "command": "<string>",
      "cpuNum": "<string>",
      "memory": "<string>",
      "gpuNum": "<string>",
      "portMappings": [
        {
          "port": 123,
          "type": "<string>"
        }
      ],
      "productId": "<string>",
      "productName": "<string>",
      "rootfsSize": 123,
      "volumeMounts": [
        {
          "type": "<string>",
          "size": "<string>",
          "id": "<string>",
          "mountPath": "<string>"
        }
      ],
      "statusError": {
        "state": "<string>",
        "message": "<string>"
      },
      "envs": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "kind": "<string>",
      "billingMode": "<string>",
      "endTime": "<string>"
    }
  ]
}

​
Request Headers

​
Content-Type
string
required

Enum: application/json

​
Authorization
string
required

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

​
Query Parameters

​
pageSize
integer
required

Maximum number of items returned per page. Integer, value >= 0.

​
pageNum
integer
required

Page number to retrieve. Integer, value >= 0.

​
name
string

Instance name (supports fuzzy search). String, length limit: 0-255 characters.

​
productName
string

Product name (supports fuzzy search). String, length limit: 0-255 characters.

​
status
string

Instance status. String, length limit: 0-63 characters. 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

​
Response

​
instances
object[]
required

Instance information.