更新 Endpoint

curl --request POST \
  --url https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "clusterID": "<string>",
  "workerConfig": {
    "minNum": 123,
    "maxNum": 123,
    "freeTimeout": 123,
    "maxConcurrent": 123,
    "gpuNum": 123,
    "requestTimeout": 123
  },
  "ports": [
    {
      "port": "<string>"
    }
  ],
  "policy": {
    "type": "<string>",
    "value": 123
  },
  "image": {
    "image": "<string>",
    "authId": "<string>",
    "command": "<string>"
  },
  "volumeMounts": [
    {
      "type": "<string>",
      "size": 123,
      "id": "<string>",
      "mountPath": "<string>"
    }
  ],
  "envs": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "healthy": {
    "path": "<string>"
  }
}
'

import requests

url = "https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update"

payload = {
    "id": "<string>",
    "name": "<string>",
    "clusterID": "<string>",
    "workerConfig": {
        "minNum": 123,
        "maxNum": 123,
        "freeTimeout": 123,
        "maxConcurrent": 123,
        "gpuNum": 123,
        "requestTimeout": 123
    },
    "ports": [{ "port": "<string>" }],
    "policy": {
        "type": "<string>",
        "value": 123
    },
    "image": {
        "image": "<string>",
        "authId": "<string>",
        "command": "<string>"
    },
    "volumeMounts": [
        {
            "type": "<string>",
            "size": 123,
            "id": "<string>",
            "mountPath": "<string>"
        }
    ],
    "envs": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "healthy": { "path": "<string>" }
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    id: '<string>',
    name: '<string>',
    clusterID: '<string>',
    workerConfig: {
      minNum: 123,
      maxNum: 123,
      freeTimeout: 123,
      maxConcurrent: 123,
      gpuNum: 123,
      requestTimeout: 123
    },
    ports: [{port: '<string>'}],
    policy: {type: '<string>', value: 123},
    image: {image: '<string>', authId: '<string>', command: '<string>'},
    volumeMounts: [{type: '<string>', size: 123, id: '<string>', mountPath: '<string>'}],
    envs: [{key: '<string>', value: '<string>'}],
    healthy: {path: '<string>'}
  })
};

fetch('https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update', 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://api.ppio.com/gpu-instance/openapi/v1/endpoint/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'name' => '<string>',
    'clusterID' => '<string>',
    'workerConfig' => [
        'minNum' => 123,
        'maxNum' => 123,
        'freeTimeout' => 123,
        'maxConcurrent' => 123,
        'gpuNum' => 123,
        'requestTimeout' => 123
    ],
    'ports' => [
        [
                'port' => '<string>'
        ]
    ],
    'policy' => [
        'type' => '<string>',
        'value' => 123
    ],
    'image' => [
        'image' => '<string>',
        'authId' => '<string>',
        'command' => '<string>'
    ],
    'volumeMounts' => [
        [
                'type' => '<string>',
                'size' => 123,
                'id' => '<string>',
                'mountPath' => '<string>'
        ]
    ],
    'envs' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'healthy' => [
        'path' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$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://api.ppio.com/gpu-instance/openapi/v1/endpoint/update"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}"

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

POST

gpu-instance

openapi

endpoint

update

更新 Endpoint

curl --request POST \
  --url https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "clusterID": "<string>",
  "workerConfig": {
    "minNum": 123,
    "maxNum": 123,
    "freeTimeout": 123,
    "maxConcurrent": 123,
    "gpuNum": 123,
    "requestTimeout": 123
  },
  "ports": [
    {
      "port": "<string>"
    }
  ],
  "policy": {
    "type": "<string>",
    "value": 123
  },
  "image": {
    "image": "<string>",
    "authId": "<string>",
    "command": "<string>"
  },
  "volumeMounts": [
    {
      "type": "<string>",
      "size": 123,
      "id": "<string>",
      "mountPath": "<string>"
    }
  ],
  "envs": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "healthy": {
    "path": "<string>"
  }
}
'

import requests

url = "https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update"

payload = {
    "id": "<string>",
    "name": "<string>",
    "clusterID": "<string>",
    "workerConfig": {
        "minNum": 123,
        "maxNum": 123,
        "freeTimeout": 123,
        "maxConcurrent": 123,
        "gpuNum": 123,
        "requestTimeout": 123
    },
    "ports": [{ "port": "<string>" }],
    "policy": {
        "type": "<string>",
        "value": 123
    },
    "image": {
        "image": "<string>",
        "authId": "<string>",
        "command": "<string>"
    },
    "volumeMounts": [
        {
            "type": "<string>",
            "size": 123,
            "id": "<string>",
            "mountPath": "<string>"
        }
    ],
    "envs": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "healthy": { "path": "<string>" }
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    id: '<string>',
    name: '<string>',
    clusterID: '<string>',
    workerConfig: {
      minNum: 123,
      maxNum: 123,
      freeTimeout: 123,
      maxConcurrent: 123,
      gpuNum: 123,
      requestTimeout: 123
    },
    ports: [{port: '<string>'}],
    policy: {type: '<string>', value: 123},
    image: {image: '<string>', authId: '<string>', command: '<string>'},
    volumeMounts: [{type: '<string>', size: 123, id: '<string>', mountPath: '<string>'}],
    envs: [{key: '<string>', value: '<string>'}],
    healthy: {path: '<string>'}
  })
};

fetch('https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update', 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://api.ppio.com/gpu-instance/openapi/v1/endpoint/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'name' => '<string>',
    'clusterID' => '<string>',
    'workerConfig' => [
        'minNum' => 123,
        'maxNum' => 123,
        'freeTimeout' => 123,
        'maxConcurrent' => 123,
        'gpuNum' => 123,
        'requestTimeout' => 123
    ],
    'ports' => [
        [
                'port' => '<string>'
        ]
    ],
    'policy' => [
        'type' => '<string>',
        'value' => 123
    ],
    'image' => [
        'image' => '<string>',
        'authId' => '<string>',
        'command' => '<string>'
    ],
    'volumeMounts' => [
        [
                'type' => '<string>',
                'size' => 123,
                'id' => '<string>',
                'mountPath' => '<string>'
        ]
    ],
    'envs' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'healthy' => [
        'path' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$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://api.ppio.com/gpu-instance/openapi/v1/endpoint/update"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"clusterID\": \"<string>\",\n  \"workerConfig\": {\n    \"minNum\": 123,\n    \"maxNum\": 123,\n    \"freeTimeout\": 123,\n    \"maxConcurrent\": 123,\n    \"gpuNum\": 123,\n    \"requestTimeout\": 123\n  },\n  \"ports\": [\n    {\n      \"port\": \"<string>\"\n    }\n  ],\n  \"policy\": {\n    \"type\": \"<string>\",\n    \"value\": 123\n  },\n  \"image\": {\n    \"image\": \"<string>\",\n    \"authId\": \"<string>\",\n    \"command\": \"<string>\"\n  },\n  \"volumeMounts\": [\n    {\n      \"type\": \"<string>\",\n      \"size\": 123,\n      \"id\": \"<string>\",\n      \"mountPath\": \"<string>\"\n    }\n  ],\n  \"envs\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"healthy\": {\n    \"path\": \"<string>\"\n  }\n}"

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

接口说明

更新 Endpoint 时，参数必须全量传递。

请求头

Content-Type

string

必填

枚举值：application/json。

Authorization

string

必填

Bearer 身份验证格式，例如：Bearer {{API 密钥}}。

请求体

string

必填

需要更新的 Endpoint ID。

name

string

Endpoint 名称。

clusterID

string

集群信息，挂载云存储必填，且需要与云存储所在集群 ID 一致。字符串，长度限制：0-255 字符。

workerConfig

object

必填

Worker 配置。取值范围通过参数限制范围接口动态获取。

显示 properties

minNum

integer

必填

最小 Worker 数。

maxNum

integer

必填

最大 Worker 数。

freeTimeout

integer

必填

空闲超时（秒）。

maxConcurrent

integer

必填

最大并发数。

gpuNum

integer

必填

GPU 卡数 / Worker。每个 Worker 的 GPU 卡数。

requestTimeout

integer

必填

请求超时(秒)。

ports

object[]

必填

HTTP 端口。仅支持一个。支持的端口号范围：1-65535，其中 2222、2223、2224 为内部端口，不可使用。

显示 properties

port

string

必填

HTTP 端口。

policy

object

必填

弹性策略。取值范围通过参数限制范围接口动态获取。

显示 properties

type

string

必填

弹性策略类型。可选值：

queue：队列延迟策略，表示根据队列中请求的等待时间调整 Worker 的数量。
concurrency：队列请求策略，表示根据队列中的请求数，自动调整 Worker 的数量。

value

integer

必填

根据 type 的取值，value 表示不同。

type = queue 时，value 表示队列等待时间，单位为秒。
type = concurrency 时，value 表示队列最大请求数。

image

object

必填

镜像信息。

显示 properties

image

string

必填

镜像地址。字符串，长度限制：0-511 字符。

authId

string

私有镜像凭证 ID（公共镜像或者本平台用户镜像可以不用填）。字符串，长度限制：0-255 字符。

command

string

容器启动命令。字符串，长度限制：0-2047 字符。

volumeMounts

object[]

存储信息（GB）。

显示 properties

type

string

必填

存储类型。可选值：

local：本地存储。
network：网络存储。

size

integer

本地存储大小，当前填固定值 30，网络存储不需要填。

string

网络存储 ID，本地存储不需要填。

mountPath

string

必填

存储挂载路径。字符串，长度限制：0-255 字符。

envs

object[]

环境变量信息。

显示 properties

key

string

必填

环境变量名称。

value

string

必填

环境变量取值。

healthy

object

监控检查接口路径。

显示 properties

path

string

必填

健康检查的路径。

最后修改于 2026年6月16日

查询 Endpoint 详情删除 Endpoint

​接口说明

​请求头

​请求体

接口说明

请求头

请求体