修改云盘信息--边缘计算节点-火山引擎

文档中心

导航

边缘计算节点

修改云盘信息

最近更新时间：2024.07.02 10:27:10首次发布时间：2024.03.12 19:08:29

本接口用于修改云盘的信息，包括名称、描述、“随实例删除”配置。

使用说明

前提条件：
如果您需要为云盘开启“随实例删除”功能，需确保该云盘已挂载到了边缘实例。挂载操作，请参见挂载云盘。
注意事项：
如果您将“随实例删除”功能关闭，云盘的生命周期将完全独立于其挂载到的边缘实例。当该边缘实例被删除时，云盘从边缘实例卸载、但是不会被删除。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateEbsInstance	公共参数。该参数表示接口名称。取值：UpdateEbsInstance。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
ebs_id	String	是	disk-tvs2gmln****	云盘的 ID。
new_ebs_name	String	否	new-name	新的云盘名称。命名规则如下：允许 5~80 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
new_desc	String	否	new-desc	新的云盘描述。描述须符合以下要求：允许 0~255 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
delete_with_res	Boolean	否	false	是否随挂载的边缘实例删除。取值范围： true：边缘实例被删除时，云盘也会一起被删除。 false：边缘实例被删除时，云盘会被保留。如果不设置该参数，代表保留原来的配置。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=UpdateEbsInstance&Version=2021-04-30
&<其他公共参数>
{
    "ebs_id": "disk-dfr29n996bl****",
    "new_ebs_name": "new-name",
    "new_desc": "new-desc",
    "delete_with_res": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024012520032124242B240FEFBE68****",
        "Action": "UpdateEbsInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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