Get container info by ID

curl --request GET \
  --url https://console.gmicloud.ai/api/v1/containers/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.gmicloud.ai/api/v1/containers/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.gmicloud.ai/api/v1/containers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.gmicloud.ai/api/v1/containers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://console.gmicloud.ai/api/v1/containers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://console.gmicloud.ai/api/v1/containers/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.gmicloud.ai/api/v1/containers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "reason": "<string>",
  "storages": [
    {
      "containerPath": "/workspace",
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "idc": "<string>",
  "product": "<string>",
  "name": "LLM training",
  "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "eipAddress": "<string>",
  "eipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firewalls": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inboundIP": {
    "ipAddress": "<string>"
  },
  "modifiedAt": "2023-11-07T05:31:56Z",
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outboundIP": {
    "ipAddress": "<string>"
  },
  "publicIP": {
    "ipAddress": "<string>"
  },
  "args": [],
  "command": "",
  "envs": [
    {
      "name": "access_token",
      "value": "kalsk113=="
    }
  ],
  "ports": [],
  "sshKeyIdList": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

GET

containers

{id}

Get container info by ID

curl --request GET \
  --url https://console.gmicloud.ai/api/v1/containers/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.gmicloud.ai/api/v1/containers/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.gmicloud.ai/api/v1/containers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.gmicloud.ai/api/v1/containers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://console.gmicloud.ai/api/v1/containers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://console.gmicloud.ai/api/v1/containers/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.gmicloud.ai/api/v1/containers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "reason": "<string>",
  "storages": [
    {
      "containerPath": "/workspace",
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "idc": "<string>",
  "product": "<string>",
  "name": "LLM training",
  "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "eipAddress": "<string>",
  "eipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firewalls": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inboundIP": {
    "ipAddress": "<string>"
  },
  "modifiedAt": "2023-11-07T05:31:56Z",
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outboundIP": {
    "ipAddress": "<string>"
  },
  "publicIP": {
    "ipAddress": "<string>"
  },
  "args": [],
  "command": "",
  "envs": [
    {
      "name": "access_token",
      "value": "kalsk113=="
    }
  ],
  "ports": [],
  "sshKeyIdList": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

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

Show child attributes

Example:

[
  {
    "containerPath": "/workspace",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
]

idc

string

required

Maximum string length: 50

Pattern: ^[a-zA-Z0-9._-]+$

product

string

required

Maximum string length: 256

Pattern: ^[a-zA-Z0-9._-]+$

name

string

required

Maximum string length: 255

Pattern: ^([A-Za-z0-9][A-Za-z0-9_\-. ]*)?[A-Za-z0-9]$

Example:

"LLM training"

templateId

string<uuid>

required

template id

createdAt

string<date-time>

eipAddress

string

eipId

string<uuid>

firewalls

string<uuid>[]

string<uuid>

inboundIP

object

Show child attributes

modifiedAt

string<date-time>

orgId

string<uuid>

outboundIP

object

Show child attributes

publicIP

object

Show child attributes

args

string[]

Optional container command arguments

command

string

default:""

Optional container start command

envs

object[]

Show child attributes

Example:

[
  {
    "name": "access_token",
    "value": "kalsk113=="
  }
]

ports

object[]

Show child attributes

sshKeyIdList

string<uuid>[]

The list of SSH key IDs to use in the container

Create containers Update container

API Introduction

IAM Service APIs

Compute Service APIs

IDC Service APIs

Get container info by ID

Authorizations

Path Parameters

Response