ModifyImageAttribute - 修改镜像信息--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

ModifyImageAttribute - 修改镜像信息

最近更新时间：2024.05.21 10:26:16首次发布时间：2022.07.01 09:24:19

调用 ModifyImageAttribute 接口，修改自定义镜像的名称、描述、启动模式等信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyImageAttribute	要执行的操作，取值：ModifyImageAttribute。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
BootMode	String	否	UEFI	镜像的启动模式，不填则保持原有配置。取值： BIOS：BIOS启动模式 UEFI：UEFI启动模式说明弹性裸金属实例只支持`UEFI`启动模式。 ARM镜像默认值为`UEFI`，且只能设置为`UEFI`。
Description	String	否	This is my first image	镜像描述。必须以字母、汉字开头。只能包含中文，字母，数字，下划线“_”，中划线“-”，等号“=”，英文逗号“,”和英文句号“.”，中文逗号“，”和中文句号“。”和空格。长度限制为0 ~ 255个字符。说明不填则保持原有配置。传入空字符串时，将清空原有描述信息。
ImageId	String	是	image-ebgy1og99tfct0gw****	您可以调用DescribeImages接口并传入`Visibility=private`参数，查询获取自定义镜像ID。
ImageName	String	否	image-1	镜像名称。必须以字母、汉字开头。只能包含中文，字母，数字，下划线“_”，中划线“-”，英文句号“.”。长度限制为1 ~ 128个字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=ModifyImageAttribute&Version=2020-04-01&ImageId=image-ebgy1og99tfct0gw****&ImageName=image1&Description= HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "ModifyImageAttribute",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidBootMode.Malformed	The specified BootMode is malformed.	指定的启动方式不合法。
400	InvalidDescription.Malformed	The specified Description is malformed.	指定的描述不合法。
400	InvalidImageName.Malformed	The specified ImageName is malformed.	指定的镜像名称不合法。
400	InvalidImageStatus	The specified image is not in the correct status for the request.	当前镜像的状态不支持此操作。
400	MissingParameter.ImageId	The required parameter ImageId is not supplied.	镜像ID不能为空。
404	InvalidImage.NotFound	The specified image does not exist.	指定的镜像不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。