Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify image attributes.
A maximum of 10 requests can be initiated per second for this API.
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:ImageId in the response. |
ImageName | No | String | New image name, which should meet the following requirements: |
ImageDescription | No | String | New image description, which should meet the following requirement: |
ImageFamily | No | String | Sets the image family; |
ImageDeprecated | No | Boolean | Sets whether the image is deprecated; |
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. |
This example shows you how to rename the image img-6pb6lrmy
to sample
.
GET https://cvm.tencentcloudapi.com/?Action=ModifyImageAttribute
&ImageId=img-6pb6lrmy
&ImageName=sample
&<Common request parameters>
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?