说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (ModifyImageAttributes) 用于修改镜像的名称和描述等信息。
接口请求域名:image.api.qcloud.com
- 不支持修改共享镜像。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
imageId | 是 | String | 镜像ID,可通过 DescribeImages 接口返回字段中的 unImgId 获取。 |
imageName | 否 | String | 镜像的名称,名称不能重复。如果不修改则传空值或者不传。规则:1-16个英文、数字、连接线“-”。 |
imageDescription | 否 | String | 镜像的描述,如果不修改则传空值或者不传。规则:0-64个中文、英文、数字、连接线"-"、下划线"_"。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。 |
message | String | 模块错误信息描述,与接口相关。 |
4. 示例
输入
https://image.api.qcloud.com/v2/index.php?Action=ModifyImageAttributes &imageId=img-12345678 &imageName=testName &imageDescription=descrip &<公共请求参数>
输出
{
"code" : 0,
"message" : ""
}