Skip to main content
GET
/
v1
/
containers
List container information
curl --request GET \
  --url https://console.gmicloud.ai/api/v1/containers \
  --header 'Authorization: Bearer <token>'
[
  {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inboundIP": {
      "ipAddress": "<string>",
      "status": "ready"
    },
    "modifiedAt": "2023-11-07T05:31:56Z",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outboundIP": {
      "ipAddress": "<string>",
      "status": "ready"
    },
    "publicIP": {
      "ipAddress": "<string>",
      "status": "ready"
    },
    "reason": "<string>",
    "status": "unknown",
    "storages": [
      {
        "containerPath": "/workspace",
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "idc": "<string>",
    "product": "<string>",
    "args": [],
    "command": "",
    "envs": [
      {
        "name": "access_token",
        "value": "kalsk113=="
      }
    ],
    "name": "LLM training",
    "ports": [],
    "sshKeyIdList": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

successful

​
reason
string
required

reason of container status

​
status
enum<string>
required
Available options:
unknown,
creating,
running,
terminating,
stopped,
error,
zombie
​
storages
object[]
required
Example:
[
  {
    "containerPath": "/workspace",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
]
​
idc
string
required
Maximum length: 50
​
product
string
required
Maximum length: 256
​
name
string
required
Maximum length: 255
​
templateId
string<uuid>
required

template id

​
createdAt
string<date-time>
​
id
string<uuid>
​
inboundIP
object
​
modifiedAt
string<date-time>
​
orgId
string<uuid>
​
outboundIP
object
​
publicIP
object
​
args
string[]

Optional container command arguments

​
command
string
default:""

Optional container start command

​
envs
object[]
Example:
[
  {
    "name": "access_token",
    "value": "kalsk113=="
  }
]
​
ports
object[]
​
sshKeyIdList
string<uuid>[]

The list of SSH key IDs to use in the container