查询策略列表 - ListPolicies
功能介绍
查询策略列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/{project_id}/policies
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,默认取值不涉及。 获取方法请参见"获取项目ID"。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
operation_type | 否 | String | 策略类型,默认取值不涉及。 备份(backup),复制(replication) |
vault_id | 否 | String | 存储库ID,默认取值不涉及。 获取方法请参见"获取存储库ID"。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。默认取值不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
policies | Array of Policy objects | 策略列表 |
count | Integer | 策略总数,取值范围不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
enabled | Boolean | 功能说明:策略是否启用。 取值范围: |
id | String | 策略ID,取值范围不涉及。 |
name | String | 策略名称,长度限制:1-64,只能由中文、字母、数字、“_”、“-”组成。 |
operation_definition | PolicyoODCreate object | 策略属性信息 |
operation_type | String | 保护类型:取值范围如下:备份(backup)、复制(replication)。 |
trigger | PolicyTriggerResp object | 策略时间调度规则 |
associated_vaults | Array of PolicyAssociateVault objects | 关联的存储库 |
policy_type | String | 策略类型,取值范围如下: |
参数 | 参数类型 | 描述 |
|---|---|---|
day_backups | Integer | 保留日备个数,该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数,则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 |
destination_project_id | String | 复制的目标区域项目ID,仅在跨区域复制时才会使用并且必须指定。默认取值不涉及。 获取方法请参见"获取项目ID"。 |
destination_region | String | 复制的目标区域,仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制:0- 255,只能由字母、数字、“_”、“-”组成。默认取值不涉及。 获取方法请参见"地区和终端节点查询"。 |
enable_acceleration | Boolean | 跨region复制时,是否启用加速从而缩短复制的时间,如果不指定,默认不启用加速。如果启用加速,会额外收取加速的费用。 |
max_backups | Integer | 单个备份对象自动备份的最大备份数。取值为-1或1-99999。默认取值不涉及。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空,备份会永久保留。该字段与retention_duration_days字段不能同时设置。 |
month_backups | Integer | 保留月备个数,该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数,则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 |
retention_duration_days | Integer | 备份保留时长,单位天。最长支持99999天。默认取值不涉及。-1代表不按时间清理。如果该字段和max_backups 参数同时为空,备份会永久保留。该字段与max_backups、day_backups、week_backups、month_backups和year_backups字段不能同时设置。 |
timezone | String | 用户所在时区,格式形如UTC+08:00,默认取值不涉及。如果选择年备,月备,周备,日备中任一参数,则该参数不能为空。 |
week_backups | Integer | 保留周备个数,该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数,则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 |
year_backups | Integer | 保留年备个数,该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数,则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 |
full_backup_interval | Integer | 每间隔多少次执行一次全量备份,当取值为 -1 时,不执行全量备份。取值范围[-1, 100],默认取值不涉及。 |
cross_account_urn | String | 跨账户复制策略所关联的跨账户复制存储库标识 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 调度器id,取值范围不涉及。 |
name | String | 调度器名称,取值范围不涉及。 |
properties | PolicyTriggerPropertiesResp object | 策略调度器属性 |
type | String | 调度器类型,目前只支持 time: 定时调度。 |
参数 | 参数类型 | 描述 |
|---|---|---|
pattern | Array of strings | 调度规则。限制24条规则。调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天UTC时间的14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如:某个地区的时间为 UTC+8,如果在该地区每天14:00调度,则在14点基础上减8,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。 |
start_time | String | 调度器开始时间,例如:"2020-01-08 09:59:49"。 |
请求示例
查询指定备份策略列表
GET https://{endpoint}/v3/{project_id}/policies 响应示例
状态码:200
OK
{
"policies" : [ {
"name" : "policy001",
"associated_vaults" : [ ],
"enabled" : true,
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
"start_time" : "2019-05-08T06:57:05.000+00:00"
},
"type" : "time",
"id" : "d67269a6-5369-42d7-8150-5254bd446328",
"name" : "default"
},
"operation_definition" : {
"retention_duration_days" : 1,
"year_backups" : 0,
"day_backups" : 0,
"month_backups" : 0,
"week_backups" : 0,
"timezone" : "UTC+08:00"
},
"operation_type" : "backup",
"id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff",
"policy_type" : "custom_policy"
} ],
"count" : 10
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
错误码
请参见错误码。

