修改边缘服务--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

请输入

边缘服务

修改边缘服务

本接口用于修改边缘服务配置。

使用说明

修改边缘服务的配置后，该边缘服务中已有的边缘实例的配置不会受影响。后续当您向该边缘服务中添加边缘实例时，新增的边缘实例将会按照修改后的配置创建。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=UpdateCloudServer&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateCloudServer`	接口名称。当前 API 的名称为 `UpdateCloudServer`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
cloud_server_identity	String	是	`cloudserver-8bvl8r6xcng****`	边缘服务 ID。您可以通过 ListCloudServers 接口查询边缘服务 ID。
cloudserver_name	String	否	`cloud-test`	边缘服务名称。命名规则如下：允许 5~20 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。如果不指定该项参数值，代表不修改名称。
cloud_server_desc	String	否	`cloud-test-desc`	边缘服务的描述信息。最多可输入 80 个字符。如果不指定该项参数值，代表不修改描述信息。
image_identity	String	否	`image87uiy8****`	镜像 ID。您可以通过 ListImages 接口查询镜像 ID。
storage_config	Object	否	`-`	存储配置，包括系统盘和数据盘的类型和容量信息。
secret_config	Object	否	`-`	边缘实例的登录密码设置，支持自定义类型和 SSH Key 类型的密码。如果不指定该项参数值，代表不修改登录密码设置。
network_config	Object	否	`-`	网络配置。
custom_data	Object	否	`-`	自定义数据。
instance_project	String	否	`default`	新增的边缘实例所属的项目。如果不设置该参数，将保留原来的取值。如果参数值为空字符串，采用默认值 default。
disable_vga	Boolean	否	`false`	是否禁用 VGA。取值范围： true：禁用 VGA。 false：开启 VGA。如果不设置该参数，将保留原来的取值。
advanced_configuration	Object	否	`-`	高级配置，用于自定义边缘实例名称、实例描述信息、主机名称。如果不设置相关参数，将保留原来的取值。
billing_config	Object	否	`-`	计费方式，包括算力和带宽的计费方式。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=UpdateCloudServer&Version=2021-04-30
&<其他公共参数>
{
    "cloud_server_identity": "cloudserver-hgvbfwkpnsq****",
    "cloud_server_name": "cloud-test",
    "cloud_server_desc": "cloud-test-desc",
    "image_identity": "imagepnjk4y****",
    "storage_config": {
        "system_disk": {
            "storage_type": "CloudBlockSSD",
            "capacity": "50"
        },
        "data_disk": {
            "storage_type": "CloudBlockSSD",
            "capacity": "20"
        }
    },
    "secret_config": {
        "secret_type": 2,
        "secret_data":"My_password"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025070414162310014717005147EF08",
        "Action": "UpdateCloudServer",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。

最近更新时间：2025.12.22 17:43:06

这个页面对您有帮助吗？

有用

无用