Help & DocumentationCloud Virtual MachineAPI DocumentationImage APIsModifyImageAttribute

ModifyImageAttribute

Last updated: 2020-03-06 18:52:44

PDF

Contents：

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to modify image attributes.

  • Attributes of shared images cannot be modified.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyImageAttribute.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ImageId Yes String Image ID such as img-gvbnzy6f. You can obtain the image IDs in two ways:
  • Call DescribeImages and look for ImageId in the response.
  • Look for the information in the Image Console.
    		•
    ImageName No String New image name, which must meet the following requirements:
  • No more than 20 characters.
  • Must be unique.
    		•
    ImageDescription No String New image description, which must meet the following requirement:
  • No more than 60 characters.
    		•

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying image name

    This example shows you how to change the name of an image whose image ID is img-6pb6lrmy to "sample".

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ModifyImageAttribute
&ImageId=img-6pb6lrmy
&ImageName=sample
&<Common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidImageId.IncorrectState Invalid image status.
    InvalidImageId.Malformed Invalid image ID format.
    InvalidImageId.NotFound The image cannot be found.
    InvalidImageName.Duplicate The specified image name already exists.
    InvalidParameter.ValueTooLarge The length of parameter exceeds the limit.