Tutorial Pengguna

Pengenalan Produk

Ikhtisar

Keunggulan

Kasus Penggunaan

Database Architecture

Kebijakan Isolasi Sumber Daya

Database Instance

Ketersediaan Tinggi (Beberapa AZ)

Wilayah dan AZ

Panduan Pembelian

Ikhtisar Penagihan

Metode Pembelian

Pembayaran Jatuh Tempo

Pengembalian Dana

Biaya Penyesuaian Instans

Penagihan Ruang Cadangan

Memulai

Ikhtisar

Membuat Instans MySQL

Panduan Operasi

Batas Penggunaan

Ikhtisar Operasi

Manajemen dan Pemeliharaan Instans

Peningkatan Versi

Memperluas Instans

Proksi Database

Manajemen Akun

Konfigurasi Parameter

Pencadangan dan Pengembalian

Migrasi data

Jaringan dan Keamanan

Pemantauan dan Alarm

Pusat Log

Tag

Laporan Resmi

Laporan Resmi Keamanan

Service Agreement

Service Level Agreement

DescribeBackupEncryptionStatus

Focus Mode

Font Size

Last updated: 2025-10-28 22:19:49

1. API Description

Domain name for API request: cdb.intl.tencentcloudapi.com.

This API is used to query the default encryption status of an instance backup.

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: DescribeBackupEncryptionStatus.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID in the format of cdb-XXXX, which is the same as that displayed in the TencentDB console.

3. Output Parameters

Parameter Name	Type	Description
EncryptionStatus	String	Whether the physical cold backup is enabled for the instance. Valid values: `on`, `off`.
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 Querying the encryption status of an instance backup

This example shows you how to query the encryption status of an instance backup.

Input Example

POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBackupDecryptionKey<Common request parameters>{    "InstanceId": "cdb-XXXX"}

Output Example

{
    "Response": {
        "EncryptionStatus": "on",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

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
FailedOperation.InstanceQueryError	Query failed.
InternalError.UnknownError	Unknown error

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

TencentDB for MySQL