华为云计算 云知识 查询单个策略ShowPolicy
查询单个策略ShowPolicy

 

功能介绍

查询单个策略

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/policies/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

policy_id

String

策略ID

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

缺省值:MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

policy

Policy object

创建响应

表4 Policy

参数

参数类型

描述

enabled

Boolean

策略是否启用

id

String

策略ID

name

String

策略名称

operation_definition

PolicyoODCreate object

策略属性

operation_type

String

保护类型:备份(backup)、复制(replication)。

枚举值:

  • backup

trigger

PolicyTriggerResp object

策略时间调度规则

associated_vaults

Array of PolicyAssociateVault objects

关联的存储库

表5 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

表6 PolicyTriggerResp

参数

参数类型

描述

id

String

调度器id

name

String

调度器名称

properties

PolicyTriggerPropertiesResp object

调度器属性

type

String

调度器类型,目前只支持 time: 定时调度。

枚举值:

  • time

表7 PolicyTriggerPropertiesResp

参数

参数类型

描述

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"

表8 PolicyAssociateVault

参数

参数类型

描述

destination_vault_id

String

关联的远端存储库ID

vault_id

String

存储库ID

请求示例

查询单个策略。

GET  https://{endpoint}/v3/{project_id}/policies/{policy_id}

响应示例

状态码: 200

OK

{
  "policy" : {
    "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-08 06:57:05"
      },
      "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"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

 

上一篇:什么是弹性负载均衡 下一篇:查询指定namespace下的PodslistCoreV1NamespacedPod

组织 Organizations

组织 Organizations

组织(Organizations)为企业用户提供多账号关系的管理能力。用户可以将多个华为云账号整合到创建的组织中,并可以在组织中设置治理策略

组织(Organizations)为企业用户提供多账号关系的管理能力。用户可以将多个华为云账号整合到创建的组织中,并可以在组织中设置治理策略

免费使用