Phala Cloud Documentation — Private AI on TEE

Get CVM network info

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network', 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://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network")

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

request = Net::HTTP::Get.new(url)

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

{
  "is_online": true,
  "ingress": {
    "gateway_enabled": true,
    "port_policy": {
      "ports": [
        {
          "port": 123,
          "pp": false
        }
      ],
      "restrict_mode": false
    }
  },
  "port_mappings": [
    {
      "id": "pm_0123abcd",
      "host_port": 123,
      "vm_port": 123,
      "protocol": "<string>",
      "host_address": "<string>",
      "nic_index": 0,
      "source_cidrs": [
        "<string>"
      ],
      "description": "<string>",
      "public_host": "<string>",
      "forwarding_backend": "vmm_hostfwd",
      "restart_required": false,
      "guest_ip": "<string>"
    }
  ],
  "endpoints": {
    "kms_urls": [
      "<string>"
    ],
    "gateway_urls": [
      "<string>"
    ],
    "kms_urls_overridden": true,
    "gateway_urls_overridden": true
  },
  "is_public": true,
  "error": "<string>",
  "internal_ip": "<string>",
  "latest_handshake": "2023-11-07T05:31:56Z",
  "public_urls": [
    {
      "app": "<string>",
      "instance": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

cvms

{cvm_id}

network

Get CVM network info

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network', 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://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/network")

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

request = Net::HTTP::Get.new(url)

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

{
  "is_online": true,
  "ingress": {
    "gateway_enabled": true,
    "port_policy": {
      "ports": [
        {
          "port": 123,
          "pp": false
        }
      ],
      "restrict_mode": false
    }
  },
  "port_mappings": [
    {
      "id": "pm_0123abcd",
      "host_port": 123,
      "vm_port": 123,
      "protocol": "<string>",
      "host_address": "<string>",
      "nic_index": 0,
      "source_cidrs": [
        "<string>"
      ],
      "description": "<string>",
      "public_host": "<string>",
      "forwarding_backend": "vmm_hostfwd",
      "restart_required": false,
      "guest_ip": "<string>"
    }
  ],
  "endpoints": {
    "kms_urls": [
      "<string>"
    ],
    "gateway_urls": [
      "<string>"
    ],
    "kms_urls_overridden": true,
    "gateway_urls_overridden": true
  },
  "is_public": true,
  "error": "<string>",
  "internal_ip": "<string>",
  "latest_handshake": "2023-11-07T05:31:56Z",
  "public_urls": [
    {
      "app": "<string>",
      "instance": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

cvm_id

string

required

Response

Network info (may have error if offline)

Gateway status plus the three network layers of a CVM.

is_online

boolean

required

ingress

CvmGatewayIngress · object | null

required

Layer A, from the CVM's current compose; None when it cannot be read.

Show child attributes

port_mappings

PortMappingResponse · object[]

required

Layer B, as GET /cvms/{cvm_id}/ports returns them.

Show child attributes

endpoints

CvmInfrastructureEndpoints · object

required

Layer C.

Show child attributes

is_public

boolean

default:true

error

string | null

internal_ip

string | null

latest_handshake

string<date-time> | null

public_urls

CvmNetworkUrls · object[] | null

Show child attributes