Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Backup Management/ Checking Whether Encrypted Backup Is Enabled
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Checking Whether Encrypted Backup Is Enabled

Function

This API is used to check whether encrypted backup is enabled. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/backups/encryption

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

encryption_status

String

Whether encrypted backup is enabled or disabled.

Values:

  • on: Encrypted backup is enabled.
  • off: Encrypted backup is disabled.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Checking whether encrypted backup is enabled

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption

Example Response

Status code: 200

Success.

{
  "encryption_status" : "on"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management