You need to enable JavaScript to run this app.
导航
修改边缘服务
最近更新时间:2024.02.29 14:34:34首次发布时间:2022.11.10 11:44:59

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

接口说明

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

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

UpdateCloudServer

公共参数。该参数表示接口名称。取值:UpdateCloudServer。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

cloud_server_identity

String

cloudserver-8bvl8r6xcng****

边缘服务 ID。您可以通过 ListCloudServers 接口查询边缘服务 ID。

cloud_server_name

String

cloud-test

边缘服务名称。命名规则如下:

  • 允许 5~20 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

如果不指定该项参数值,代表不修改名称。

cloud_server_desc

String

cloud-test-desc

边缘服务的描述信息,最多可输入 80 个字符。
如果不指定该项参数值,代表不修改描述信息。

image_identity

String

image87uiy8****

镜像 ID。您可以通过 ListImages 接口查询镜像 ID。

storage_config

StorageConfig

{
  "system_disk": {
    "capacity": "40",
    "storage_type": "CloudBlockSSD"
  }
}

存储配置,包括系统盘和数据盘的类型和容量信息。
详情请参见 StorageConfig

secret_config

SecretConfig

{
  "secret_type": 2,
  "secret_data": "My_password"
}

边缘实例的登录密码设置,支持自定义类型和 SSH Key 类型的密码。
详情请参见 SecretConfig
如果不指定该项参数值,代表不修改登录密码设置。

network_config

NetworkConfigUpdateReq

{
  "custom_external_interface_name": "eth3",
  "custom_internal_interface_name": "eht4"
}

网络配置。
详情请参见 NetworkConfigUpdateReq

custom_data

CustomData

{
  "data": ""
}

自定义数据。自定义数据为边缘实例的定制信息。最大可输入 16 KB 的自定义数据。
如果不指定该项参数值,代表不修改自定义数据。

说明

自定义数据只支持Shell脚本。您需要使用明文方式输入脚本,平台将自动对脚本进行Base64编码。请勿直接输入Base64编码后的脚本。对于Linux系统,脚本通常以 !/bin/bash 开头;对于Windows系统,脚本可以直接输入。
输入的脚本将在边缘实例首次启动时执行。

instance_project

String

default

新增的边缘实例所属的项目。如果不设置该参数,将保留原来的取值。如果参数值为空字符串,采用默认值 default

disable_vga

Boolean

false

是否禁用 VGA。取值范围:

  • true:禁用 VGA。
  • false:开启 VGA。

如果不设置该参数,将保留原来的取值。

advanced_configuration

AdvancedConfiguration

{
  "instance_name":"aaaaa",
  "instance_desc":"test",
  "instance_host_name":"bbbbb",
}

高级配置,用于自定义边缘实例名称、实例描述信息、主机名称。
如果不设置相关参数,将保留原来的取值。

billing_config

CloudServerBillingConfigs

{
  "computing_billing_method": "MonthlyPeak",
  "bandwidth_billing_method": "MonthlyP95"
}

计费方式,包括算力和带宽的计费方式。

说明

不支持预付费方式和后付费方式的相互转换。

tags

[]Tag

{
  {
      "key": "test_key1",
      "value": "test_value1"
  },
  {
      "key": "test_key2",
      "value": "test_value2"
  }
}

边缘实例的标签。标签(Tag)由一个标签键(Key)和一个标签值(Value)组成。
使用标签功能时,请您注意以下事项:

  • 只能创建自定义标签。
  • 如果您修改了标签,后续新增的边缘实例会绑定新的标签。
  • 如果一个边缘实例需要绑定多个标签,标签键不能相同。
  • 同一边缘服务下设置的标签键必须唯一。如果设置的标签键已经存在,新的标签值将会覆盖旧的标签值。
  • 一次最多可以设置50个标签。
  • 更多关于标签的说明,请参见Tag

返回数据


请求示例

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": "20230519195449492786DC85FA4D75****",
        "Action": "UpdateCloudServer",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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