文档首页> 云备份 CBR> API参考> API> 组织策略> 查询组织策略列表
更新时间：2024-05-11 GMT+08:00
在线调试
CLI示例
查看PDF

查询组织策略列表

功能介绍

查询组织策略列表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/organization-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

operation_type

是

String

组织策略类型

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

缺省值：MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

policies

Array of OrganizationPolicy objects

组织策略列表

count

Integer

组织策略数量

limit

Integer

每页显示的条目数量

offset

Integer

偏移量，表示从此偏移量开始查询
表5 OrganizationPolicy

参数

参数类型

描述

id

String

组织策略ID

name

String

组织策略名称

最小长度：1

最大长度：64

description

String

组织策略描述

最小长度：0

最大长度：255

operation_type

String

组织策略类型

  • backup: 备份

  • replication: 复制

domain_id

String

组织策略所属账号ID

policy_name

String

策略名称

最小长度：1

最大长度：64

policy_enabled

Boolean

策略是否开启

policy_operation_definition

PolicyoODCreate object

策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致

policy_trigger

PolicyTriggerReq object

策略执行时间规则

status

String

组织策略状态

domain_name

String

组织策略所属账号
表6 PolicyoODCreate

参数

参数类型

描述

day_backups

Integer

保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。

最小值：0

最大值：100

destination_project_id

String

复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。

destination_region

String

复制的目标区域，仅在跨区域复制时才会使用并且必须指定。长度限制：0- 255，只能由字母、数字、“_”、“-”组成

enable_acceleration

Boolean

跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。

max_backups

Integer

单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。

最小值：1

最大值：99999

缺省值：-1

month_backups

Integer

保留月备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。

最小值：0

最大值：100

retention_duration_days

Integer

备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。

最小值：1

最大值：99999

缺省值：-1

timezone

String

用户所在时区,格式形如UTC+08:00, 如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。

week_backups

Integer

保留周备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。

year_backups

Integer

保留年备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。

最小值：0

最大值：100

full_backup_interval

Integer

每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份 最小值：-1 最大值：100

最小值：-1

最大值：100
表7 PolicyTriggerReq

参数

参数类型

描述

properties

PolicyTriggerPropertiesReq object

调度器属性
表8 PolicyTriggerPropertiesReq

参数

参数类型

描述

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'。

请求示例

查询组织策略列表。

GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup

响应示例

状态码： 200

OK

{
  "policies" : [ {
    "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696",
    "name" : "organization-policies_create_test",
    "operation_type" : "backup",
    "domain_id" : "0ae13f008700d53f0fb4c01200e79660",
    "policy_name" : "policy_create_test",
    "policy_operation_definition" : {
      "max_backups" : -1,
      "retention_duration_days" : 30,
      "day_backups" : 0,
      "week_backups" : 0,
      "month_backups" : 0,
      "year_backups" : 0,
      "timezone" : "UTC+08:00",
      "full_backup_interval" : -1
    },
    "policy_enabled" : false,
    "policy_trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    },
    "status" : "syncing"
  } ],
  "count" : 4,
  "limit" : 1000,
  "offset" : 0
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 组织策略