Perkembangan dan Pengumuman

Perkembangan Produk

Perkembangan Pembaruan Image Publik

Pengumuman Produk

Pengantar Produk

Ikhtisar Cloud Virtual Machine (CVM)

Keunggulan Produk

Konsep Dasar

Wilayah dan Zona

Tutorial

Service Regions and Service Providers

Penagihan Produk

Ikhtisar Penagihan

Metode Penagihan

Item penagihan

Ikhtisar Konversi Metode Penagihan

Instans Pembelian

Panduan Penagihan Penyesuaian Konfigurasi

Penjelasan Tunggakan

Mulai Cepat

Pembelian CVM Linux yang Kustom

Pembelian CVM Windows yang Kustom

Panduan Pengguna

Ikhtisar Panduan Operasi

Ikhtisar Batas Penggunaan

Instance

Spot Instance

Instance Cadangan

Image

Penyimpanan

Pencadangan dan Pemulihan

Jaringan

Keamanan

Kata Sandi/Kunci Sandi

Pemantauan dan Alarm

Manajemen Operasi

Migrasi Server

Migrasi Online

Migrasi Offline

Konsultasi Migrasi

Penanganan Masalah

Masalah Terkait Login Instance Windows

Masalah Login Instance Linux

Masalah Lain Terkait Login Instance

Masalah Operasional Instance

Masalah Memori Instance Linux

Gangguan Jaringan

Tutorial Praktis

Saranan Pemilihan CVM

Membangun Lingkungan

Membangun Aplikasi

Membangun Halaman Visual

Mengunggah File Lokal ke CVM

Uji Kinerja Jaringan

Tutorial Praktis Lainnya

Keamanan dan Kesesuaian

Manajemen Akses

Jaringan

Pertanyaan Umum

Wilayah dan Zona

Tentang Tagihan

Instance

Penyimpanan

Terkait Image

Terkait Migrasi Server

Terkait Jaringan

Terkait Keamanan

Terkait Operasi dan Pemantauan

Terkait Manajemen Akses

Terkait Layanan NTP

Terkait Skenario Aplikasi

Agreements

CVM Service Level Agreements

Red Hat Enterprise Linux Image Service Agreement

Public IP Service Level Agreement

Glosarium

ModifyImageAttribute

Mode fokus

Ukuran font

Terakhir diperbarui: 2025-11-21 11:59:33

1. API Description

Domain name for API request: cvm.intl.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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
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 NewImageName.

Input Example

POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageAttribute
<Common request parameters>

{
    "ImageId": "img-6pb6lrmy",
    "ImageName": "NewImageName"
}

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

Tencent Cloud CLI 3.0

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.
UnsupportedOperation.SharedImageModifyUnsupported

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Cloud Virtual Machine