Querying Backup Policies

Function

This API is used to query all backup policies of a tenant.

URI

• URI format

  GET /v2/{project_id}/backuppolicy

• Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	Project ID

Request

None

Response

• Parameter description

  Parameter	Type	Description
  backup_policies	list<dict>	List of backup policies
  backup_policy_name	string	Backup policy name
  scheduled_policy	dict	Details about the scheduling policy
  start_time	string	Backup execution time (on a full hour), which is expressed in the UTC format. If you want to set multiple execution times, separate them using commas (,).
  frequency	integer	Backup interval (1 to 14 days)
  week_frequency	list<string>	Week information list
  rentention_num	integer	Number of retained backups. The value must be an integer from 2 to 14.
  rentention_day	integer	Retention days of backups. The value is an integer ranging from 2 to 99999. If you enter a floating point number, the number will be rounded down to the nearest integer when you send the request.
  remain_first_backup_of_curMonth	string	Whether to retain the first backup in the current month Y N
  status	string	Backup policy status ON OFF
  backup_policy_id	string	Backup policy ID
  policy_resource_count	integer	Number of volumes associated with the backup policy
  message	string	Error message returned after an error occurs
  code	string	Error code returned after an error occurs For details about error codes, see Error Codes.
  time_zone	string	Time zone for the backup execution time

• Example response

  {
      "backup_policies" : [
      {
          "backup_policy_id" : "XX",
          "backup_policy_name": "plan01",
          "scheduled_policy" : {
              "remain_first_backup_of_curMonth" : "Y",
              "rentention_num" : 10,
              "frequency" : 1,
              "start_time" : "12:00",
              "status" : "ON"
          },
          "policy_resource_count": 0
      },
      {
          "backup_policy_id" : "YY",
          "backup_policy_name ": "plan02",
          "scheduled_policy" : {
              "remain_first_backup_of_curMonth" : "Y",
              "rentention_num" : 10,
              "frequency" : 1,
              "start_time" : "14:00",
              "status" : "ON"
          },
          "policy_resource_count": 10
      }]
  }
  

  or

  {
      "error": {
          "code": "XXXX",
          "message": "XXX"
      }
  }
  

Status Codes

• Normal

  200

• Abnormal

  Status Code	Description
  400 Bad Request	The server failed to process the request.
  401 Unauthorized	You must enter the username and password to access the requested page.
  403 Forbidden	You are forbidden to access the requested page.
  404 Not Found	The server could not find the requested page.
  405 Method Not Allowed	You are not allowed to use the method specified in the request.
  406 Not Acceptable	The response generated by the server could not be accepted by the client.
  407 Proxy Authentication Required	You must use the proxy server for authentication so that the request can be processed.
  408 Request Timeout	The request timed out.
  409 Conflict	The request could not be processed due to a conflict.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  501 Not Implemented	Failed to complete the request because the server does not support the requested function.
  502 Bad Gateway	Failed to complete the request because the request is invalid.
  503 Service Unavailable	Failed to complete the request because the service is unavailable.
  504 Gateway Timeout	A gateway timeout error occurred.

Error Codes

For details, see Error Codes.

last updated: 2024-12-11 13:40 UTC - commit: 7981e6e8154b8eff82959d20022277e8f49beca9