tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyImageAttribute

Last updated: 2024-10-22 19:33:22

    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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: ModifyImageAttribute.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. 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 ID in the following ways:
  • Call the DescribeImages API and find the value of ImageId in the response.
  • Obtain it in the Image console.
    		•
    ImageName No String New image name, which should meet the following requirements:
  • It should not exceed 60 characters.
  • It should be unique.
    		•
    ImageDescription No String New image description, which should meet the following requirement:
  • It should not exceed 256 characters.
    		•
    ImageFamily No String Sets the image family;
    ImageDeprecated No Boolean Sets whether the image is deprecated;

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying image name

    This example shows you how to rename the image 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

    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.
    InvalidParameterValue.InvalidAppIdFormat Invalid AppID
    InvalidParameterValue.InvalidImageFamily Invalid format of image family name
    InvalidParameterValue.TooLarge The parameter value exceeds the maximum limit.
    UnauthorizedOperation.InvalidToken Check if the token is valid.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy