本接口用于修改边缘服务配置。
修改边缘服务的配置后,该边缘服务中已有的边缘实例的配置不会受影响。后续当您向该边缘服务中添加边缘实例时,新增的边缘实例将会按照修改后的配置创建。
下表列出了接口特定的请求参数以及公共请求参数 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 | 边缘服务名称。命名规则如下:
如果不指定该项参数值,代表不修改名称。 |
cloud_server_desc | String | 否 | cloud-test-desc | 边缘服务的描述信息,最多可输入 80 个字符。 |
image_identity | String | 否 | image87uiy8**** | 镜像 ID。您可以通过 ListImages 接口查询镜像 ID。 |
storage_config | 否 |
| 存储配置,包括系统盘和数据盘的类型和容量信息。 | |
secret_config | 否 |
| 边缘实例的登录密码设置,支持自定义类型和 SSH Key 类型的密码。 | |
network_config | 否 |
| 网络配置。 | |
custom_data | 否 |
| 自定义数据。自定义数据为边缘实例的定制信息。最大可输入 16 KB 的自定义数据。 说明 自定义数据只支持Shell脚本。您需要使用明文方式输入脚本,平台将自动对脚本进行Base64编码。请勿直接输入Base64编码后的脚本。对于Linux系统,脚本通常以 | |
instance_project | String | 否 | default | 新增的边缘实例所属的项目。如果不设置该参数,将保留原来的取值。如果参数值为空字符串,采用默认值 default。 |
disable_vga | Boolean | 否 | false | 是否禁用 VGA。取值范围:
如果不设置该参数,将保留原来的取值。 |
advanced_configuration | 否 |
| 高级配置,用于自定义边缘实例名称、实例描述信息、主机名称。 | |
billing_config | 否 |
| 计费方式,包括算力和带宽的计费方式。 说明 不支持预付费方式和后付费方式的相互转换。 | |
tags | []Tag | 否 |
| 边缘实例的标签。标签(Tag)由一个标签键(Key)和一个标签值(Value)组成。
|
该接口无特有的返回参数。
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 请求失败。关于错误码的更多信息,参见错误码。