修改镜像属性

最近更新时间:2018-11-15 19:13:39

查看pdf

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(ModifyImageAttribute)用于修改镜像属性。

  • 已分享的镜像无法修改属性。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyImageAttribute
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
ImageId String 镜像ID,形如img-gvbnzy6f。镜像ID可以通过如下方式获取:
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过镜像控制台获取。
  • ImageName String 设置新的镜像名称;必须满足下列限制:
  • 不得超过20个字符。
  • 镜像名称不能与已有镜像重复。
  • ImageDescription String 设置新的镜像描述;必须满足下列限制:
  • 不得超过60个字符。
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改镜像名称

    输入示例

    https://cvm.tencentcloudapi.com/?Action=ModifyImageAttribute
    &ImageId=img-6pb6lrmy
    &ImageName=sample
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidImageId.IncorrectState 镜像状态不合法。
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidImageName.Duplicate 镜像名称与原有镜像重复。
    InvalidParameter.ValueTooLarge 参数长度超过限制。