Querying the Policy for Restoring Redis Data to a Specified Time Point
Function
This API is used to query the policy for restoring Redis data to a specified time point.
Constraints
- This API supports only GeminiDB Redis instances in a proxy cluster.
- Some instances of earlier versions need to be upgraded to use this API.
URI
GET https://{Endpoint}/v3/{project_id}/redis/instances/{instance_id}/pitr/policy
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. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
enabled |
Boolean |
Specifies whether to enable point-in-time restoration for a Redis instance.
|
interval |
Integer |
Interval for backing up data. This parameter is returned only when restoring Redis data to a specified time point is enabled. |
keep_days |
Integer |
Days to retain the generated backups. This parameter is returned only when restoring Redis data to a specified time point is enabled. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy
Example Response
Status code: 200
Success
{ "enabled" : true, "interval" : 20, "keep_days" : 7 }
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