Batch refresh CVM instance IDs
curl --request PATCH \
--url https://cloud-api.phala.com/api/v1/cvms/instance-ids \
--header 'Content-Type: application/json' \
--data '
{
"cvm_ids": [
"<string>"
],
"running_only": true,
"missing_only": true,
"overwrite": false,
"limit": 100,
"dry_run": false
}
'import requests
url = "https://cloud-api.phala.com/api/v1/cvms/instance-ids"
payload = {
"cvm_ids": ["<string>"],
"running_only": True,
"missing_only": True,
"overwrite": False,
"limit": 100,
"dry_run": False
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
cvm_ids: ['<string>'],
running_only: true,
missing_only: true,
overwrite: false,
limit: 100,
dry_run: false
})
};
fetch('https://cloud-api.phala.com/api/v1/cvms/instance-ids', 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/instance-ids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'cvm_ids' => [
'<string>'
],
'running_only' => true,
'missing_only' => true,
'overwrite' => false,
'limit' => 100,
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/cvms/instance-ids"
payload := strings.NewReader("{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://cloud-api.phala.com/api/v1/cvms/instance-ids")
.header("Content-Type", "application/json")
.body("{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/cvms/instance-ids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"scanned": 123,
"updated": 123,
"unchanged": 123,
"skipped": 123,
"conflicts": 123,
"errors": 123,
"items": [
{
"cvm_id": 123,
"identifier": "<string>",
"old_instance_id": "<string>",
"new_instance_id": "<string>",
"source": "none",
"verified_with_gateway": false,
"reason": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}CVMs
Batch refresh CVM instance IDs
Resolves and persists missing instance_id values. Admin can pass cross-workspace CVM IDs.
PATCH
/
api
/
v1
/
cvms
/
instance-ids
Batch refresh CVM instance IDs
curl --request PATCH \
--url https://cloud-api.phala.com/api/v1/cvms/instance-ids \
--header 'Content-Type: application/json' \
--data '
{
"cvm_ids": [
"<string>"
],
"running_only": true,
"missing_only": true,
"overwrite": false,
"limit": 100,
"dry_run": false
}
'import requests
url = "https://cloud-api.phala.com/api/v1/cvms/instance-ids"
payload = {
"cvm_ids": ["<string>"],
"running_only": True,
"missing_only": True,
"overwrite": False,
"limit": 100,
"dry_run": False
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
cvm_ids: ['<string>'],
running_only: true,
missing_only: true,
overwrite: false,
limit: 100,
dry_run: false
})
};
fetch('https://cloud-api.phala.com/api/v1/cvms/instance-ids', 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/instance-ids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'cvm_ids' => [
'<string>'
],
'running_only' => true,
'missing_only' => true,
'overwrite' => false,
'limit' => 100,
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/cvms/instance-ids"
payload := strings.NewReader("{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://cloud-api.phala.com/api/v1/cvms/instance-ids")
.header("Content-Type", "application/json")
.body("{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/cvms/instance-ids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"cvm_ids\": [\n \"<string>\"\n ],\n \"running_only\": true,\n \"missing_only\": true,\n \"overwrite\": false,\n \"limit\": 100,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"scanned": 123,
"updated": 123,
"unchanged": 123,
"skipped": 123,
"conflicts": 123,
"errors": 123,
"items": [
{
"cvm_id": 123,
"identifier": "<string>",
"old_instance_id": "<string>",
"new_instance_id": "<string>",
"source": "none",
"verified_with_gateway": false,
"reason": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Optional CVM identifiers. Admin can pass cross-workspace IDs.
Only process CVMs with status=running
Only process CVMs with missing instance_id
Overwrite existing instance_id when different
Max CVMs to process in one request
Required range:
1 <= x <= 500Preview changes without persisting
Was this page helpful?
⌘I

