Querying an Automated Backup Policy
Function
This API is used to query an automated backup policy, including GeminiDB Cassandra databases and tables.
Constraints
This API supports the following instance types:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
URI
GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
instance_id |
Yes |
String |
Explanation: Instance ID To obtain the value, call the API by following Querying Instances and Details. If you do not have an instance, call the API by following Creating an Instance. Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
No |
String |
Explanation: Backup policy type This parameter is available only to GeminiDB Cassandra API. Constraints: N/A Values:
Default value: Instance |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token To obtain this value, call the IAM API for obtaining a user token. Constraints: N/A Values: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
backup_policy |
object |
Explanation: Backup policy objects, including the backup retention period (days) and start time. For details, see Table 5. Values: N/A |
Parameter |
Type |
Description |
---|---|---|
keep_days |
Integer |
Explanation: Backup retention days Values: N/A |
start_time |
String |
Explanation: Backup time window. Automated backups will be created during the backup time window. Values: N/A |
period |
String |
Explanation: Backup cycle. Automated backups will be created on the specified days every week. Values: N/A |
Example Request
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/764b8a2763d34414ad3f2d5495416cb5in06/backups/policy?type=DatabaseTable
Example Response
Status code: 200
Successful request
Enabling automated backup
{ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6" } }
Disabling automated backup
{ "backup_policy" : { "keep_days" : 0 } }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot