1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口（ModifyImageAttribute）用于修改镜像属性。
- 已分享的镜像无法修改属性。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyImageAttribute。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ImageId | 是 | String | 镜像ID，形如img-gvbnzy6f。镜像ID可以通过如下方式获取：ImageId获取。示例值：img-6pb6lrmy |
| ImageName | 否 | String | 设置新的镜像名称；必须满足下列限制 示例值：sample |
| ImageDescription | 否 | String | 设置新的镜像描述；必须满足下列限制： 示例值：sample |
| ImageFamily | 否 | String | 设置镜像族； 示例值：business-daily-update |
| ImageDeprecated | 否 | Boolean | 设置镜像是否废弃； 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改镜像名称
修改镜像img-6pb6lrmy的名称为sample
输入示例
GET https://cvm.tencentcloudapi.com/?Action=ModifyImageAttribute
&ImageId=img-6pb6lrmy
&ImageName=sample
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidImageId.IncorrectState | 镜像状态不合法。 |
| InvalidImageId.Malformed | 错误的镜像Id格式。 |
| InvalidImageId.NotFound | 未找到该镜像。 |
| InvalidImageName.Duplicate | 镜像名称与原有镜像重复。 |
| InvalidParameterValue.InvalidAppIdFormat | 无效的appid。 |
| InvalidParameterValue.InvalidImageFamily | 错误格式的镜像族名称 |
| InvalidParameterValue.TooLarge | 参数值超过最大限制。 |
| UnauthorizedOperation.InvalidToken | 请确认Token是否有效。 |
