Tenant Cloud Compute Cloud Virtual Machine Image APIs ModifyImageAttribute

ModifyImageAttribute

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ModifyImageAttribute) is used to modify image attributes.

  • Attributes of shared images cannot be modified.

Default interface request rate limit: 10 times per second.

Interface update time: 2018-04-04 09:23:06.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyImageAttribute
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ImageId Yes No String Image ID, in the format of img-gvbnzy6f. You can obtain the image ID in the following ways:
  • Through the ImageId returned by the API DescribeImages.
  • Through the DescribeImages.
    Example: img-6pb6lrmy
    		•
    ImageName No No String Set a new image name. It should meet the following restrictions:
     
  •  Should not exceed 20 characters.
     
  •  The image name should not be the same as the name of existing images.
    Example: sample
    		•
    ImageDescription No No String Set a new image description. It should meet the following restrictions:
     
  • Should not exceed 60 characters.
    Example: sample
    		•

    3. Output Parameters

    Parameter name Type Description
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameter.ValueTooLarge The parameter length exceeds the limit.
    InvalidImageName.Duplicate The image name is the same as the existing image.
    InvalidImageId.IncorrectState The image status is illegal.
    InvalidImageId.NotFound Image not found
    InvalidImageId.Malformed Invalid image ID