# 查询备份策略列表 #### 功能介绍 查询备份策略列表，支持过滤参数查询。 #### URI - URI GET https://{endpoint}/v1/{project_id}/policies - 参数说明 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-csbs/zh-cn_topic_0136033750.html)。 | #### 请求 - 查询参数说明 表2查询参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页显示的条目数量，正整数，默认值1000 | | marker | 否 | String | 分页查询场景中上一次查询最后一条的ID | | sort | 否 | String | sort的内容为一组由逗号分隔的属性及可选排序方向组成，形如\\[:\\],\\[:\\],其中direction的取值为asc (升序) 或 desc (降序),如没有传入direction参数，默认以时间降序，sort内容的长度限制为255个字符。 | | name | 否 | String | 支持根据name字段查询,只支持精确匹配 | | all_tenants | 否 | Boolean | 是否查询所有租户的备份策略，仅管理员可使用。 | | offset | 否 | Integer | 偏移值，正整数 | - 要素说明 无 - 请求样例 ``` 查询所有备份策略: GET https://{endpoint}/v1/{project_id}/policies 带条件查询备份策略: GET https://{endpoint}/v1/{project_id}/policies?sort=created_at%3Aasc&limit=3&offset=3 ``` #### 响应 - 要素说明 表3要素说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policies | List\ | 请参照policy_resp 字段数据结构说明 | - policy_resp 字段数据结构说明 表4policy_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | created_at | String | 创建时间,如:"2017-04-18T01:21:52.701973" | | description | String | 备份策略描述，长度限制：0- 255，除了"\<"、"\>"不能输入，其它字符均可。 | | id | String | 备份策略ID | | name | String | 备份策略名称，长度限制：1- 255，只能由中文、字母、数字、"_"、"-"组成。 | | parameters | policy_param | 备份策略参数 | | project_id | String | 项目ID | | provider_id | String | 备份提供商ID，当前取值固定值：fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。 | | resources | List\ | 备份对象列表 | | scheduled_operations | List\ | 调度周期列表 | | status | String | 备份策略状态 | - policy_param 字段数据结构说明 表5policy_param 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | common | common_param | 备份策略通用参数，此处默认为空。 | - common_param 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_consistency | Integer | 是否对备份策略中的备份对象做应用一致性备份；0代表不做应用一致性备份；1代表做应用一致性备份且应用一致性备份失败后，不继续做崩溃一致性备份；2代表做应用一致性备份且应用一致性备份失败后，继续做崩溃一致性备份。未输入app_consistency参数时，不做应用一致性备份。 | - resource 字段数据结构说明 表6resource 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 待备份对象ID | | type | String | 备份对象的实体对象类型。 当前支持的取值包含两个：OS::Nova::Server，该值代表备份的对象为云服务器，OS::Ironic::BareMetalServer，该值代表备份的对象为裸金属服务器。 | | name | String | 备份对象名称 | | extra_info | Dict | 备份对象的附加信息 | - extra_info参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | exclude_volumes | List\ | 磁盘的ID列表，如果备份对象为云服务器或者裸金属服务器，代表备份时不对该服务器下指定的磁盘进行备份。 | - scheduled_operation_resp 字段数据结构说明 表7scheduled_operation_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | description | String | 调度周期描述，长度限制：0- 255，除了"\<"、"\>"不能输入，其它字符均可。 | | enabled | Boolean | 是否启用该调度周期，默认为true， 不启用时策略不会自动调度，可以手工调度 | | name | String | 调度周期名称，长度限制：1- 255，只能由中文、字母、数字、"_"、"-"组成。 | | operation_type | String | 操作类型，备份，复制 Enum:\[ backup，replication\] | | operation_definition | operation_definition | 调度周期参数 | | trigger | trigger_resp | 调度策略 | | id | String | 调度周期ID | - operation_definition 字段数据结构说明 表8operation_definition 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | max_backups | Integer | 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。 | | retention_duration_days | Integer | 备份保留时长，单位天。取值为-1或0-99999。-1代表不按时间清理。 | | permanent | Boolean | 是否永久保留。 | | plan_id | String | 备份策略ID。 | | provider_id | String | 备份提供商ID，当前取值固定值：fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。 | | destination_region | String | 复制的目标区域。 | | destination_project_id | String | 复制的目标项目ID。 | | enable_acceleration | String | 跨区域复制时，是否启用加速从而缩减复制的时间。 | | day_backups | Integer | 保留日备个数，正整数 | | week_backups | Integer | 保留周备个数，正整数 | | month_backups | Integer | 保留月备个数，正整数 | | year_backups | Integer | 保留年备个数，正整数 | | timezone | String | 用户在console修改、添加策略时所在时区，格式形如UTC+08:00 | - trigger_resp 字段数据结构说明 表9trigger_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | properties | trigger_properties_resp | 调度器属性 | | id | String | 调度器ID | | name | String | 调度器名称 | | type | String | 调度类型 | - trigger_properties_resp 字段数据结构说明 表10trigger_properties_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pattern | String | 调度器的调度策略，长度限制为10240个字符，参照iCalendar RFC 2445规范，但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE四个参数，其中FREQ仅支持WEEKLY和DAILY，BYDAY支持一周七天（MO、TU、WE、TH、FR、SA、SU），BYHOUR支持0-23小时，BYMINUTE支持0-59分钟，并且间隔不能小于一小时，一天最大24个时间点。 | | start_time | String | 调度器开始时间，如"2017-03-07 09:31:08" | | format | String | 调度器类型 | - 响应样例 ``` { "policies" : [ { "created_at" : "2017-03-07T09:31:08.265000", "description" : "My plan", "id" : "27b11f3f-578d-4464-89d1-7c6d5894f753", "name" : "my-plan", "parameters" : { "common" : { "app_consistency": 1 } }, "project_id" : "tenant", "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec", "resources" : [ { "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55", "name" : "resource1", "type" : "OS::Nova::Server", "extra_info" : { "exclude_volumes": ["8a8ccde2-0b9a-4450-a5f3-150816635f46"] } }, { "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "name" : "resource2", "type" : "OS::Nova::Server", "extra_info" : { } } ], "scheduled_operations" : [ { "description" : "My backup policy", "enabled" : true, "id" : "3b2fdf8c-2cc2-4887-9605-a8443922f6f2", "name" : "my-backup-policy", "operation_definition" : { "max_backups" : "20", "plan_id" : "27b11f3f-578d-4464-89d1-7c6d5894f753", "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec" }, "operation_type" : "backup", "trigger" : { "id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9", "name" : "default", "properties" : { "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", "start_time" : "2017-03-07 09:31:08", "format": "ical" }, "type" : "time" }, "trigger_id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9" } ], "status" : "disabled" } ] } ``` #### 状态码 - 正常 | 状态码 | 说明 | |:---|:---| | 200 | OK | - 异常 | 状态码 | 说明 | |:---|:---| | 400 | 请求参数不合法 | | 401 | 鉴权失败 | | 403 | 没有操作权限 | | 404 | 请求对象不存在 | | 500 | 服务内部错误 | | 503 | 服务不可用 | #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-csbs/zh-cn_topic_0071888297.html)。