GET
/
gpu-instance
/
openapi
/
v1
/
gpu
/
instances

​
Request Headers

​
Content-Type
string
required

Enum: application/json

​
Authorization
string
required

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

​
Query Parameters

​
pageSize
integer

Maximum number of entries returned on one page.

​
pageNum
integer

Current page index.

​
name
string

Filter by instance name

​
productName
string

Filter by product name

​
status
string

Instance status

​
isUseSavingPlan
integer

1: Use saving plan; 2: Do not use saving plan

​
Response

​
instances
object[]
​
pageSize
integer

Maximum number of entries returned on one page.

​
pageNum
integer

Current page index.

​
total
integer

​
Example

Request

curl --request GET \
  --url https://api.novita.ai/gpu-instance/openapi/v1/gpu/instances \
  --header 'Authorization: Bearer {{API Key}}'

Response

{
  "instances": [
    {
      "id": "12948885700ef8e3",
      "name": "",
      "clusterId": "5",
      "clusterName": "China",
      "status": "running",
      "imageUrl": "nginx:latest",
      "command": "",
      "cpuNum": "8",
      "memory": "63",
      "gpuNum": "1",
      "createdAt": "1713230117",
      "lastStartedAt": "1713258924",
      "lastStoppedAt": "0",
      "useTime": "30131",
      "billingMode": "instance_afterusage",
      "productId": "26",
      "productName": "RTX 4090 24GB",
      "rootfsSize": 10,
      "statusError": {
        "state": "",
        "message": ""
      },
      "envs": [
        {
          "key": "testkey",
          "value": "123"
        }
      ],
      "diskSize": 0,
      "instancePrice": "269100",
      "localStoragePrice": "100",
      "exitedLocalStoragePrice": "100"
    }
  ],
  "pageSize": 0,
  "pageNum": 0,
  "total": 2
}

Was this page helpful?

Get InstanceStart Instance