tencent cloud

Feedback

ModifyImageAttribute

Last updated: 2023-08-18 14:28:10

1. API Description

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

This API is used to modify the attributes of an image.

A maximum of 20 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: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
ImageId Yes String Image ID, such as img-gvbnzy6f
ImageName No String Image name, which must meet the following requirements:
It can contain up to 20 characters.
- The image name cannot be the same as existing image names.
ImageDescription No String Image description, which must meet the following requirements:
- It cannot exceed 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 attributes

Input Example

https://ecm.tencentcloudapi.com/?Action=ModifyImageAttribute
&ImageId=img-gvbnzy6f
&ImageName=test_name
&ImageDescription=test_description
&<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
FailedOperation.InternalOperationFailure Internal error.
FailedOperation.OperationNotAllow The current operation is not allowed.
InvalidParameter The parameter is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.ImageNameDuplicate The image name is duplicate.
MissingParameter The parameter is missing.
MissingParameter.MissingImageParameter The image operation parameters are incomplete.
ResourceNotFound The resource does not exist.