华为云用户手册

请求示例 创建目标连接 POST https://{endpoint}/v1/{project_id}/connections { "name" : "private-link", "description" : "", "vpc_id" : "ac14144e-8fec-53d6-bdfd-8f09b52c09iu", "subnet_id" : "bf14153e-5fec-67d6-b89d-5409b52c0op8", "type" : { } }

响应示例 状态码：200 Demo Information { "id" : "90e0b962-c6c1-438c-ba8a-3024fe592bda", "name" : "private-link", "description" : "", "status" : "CREATING", "error_info" : { }, "vpc_id" : "ac14144e-8fec-53d6-bdfd-8f09b52c09iu", "subnet_id" : "bf14153e-5fec-67d6-b89d-5409b52c0op8", "agency" : "EG_TRUST", "flavor" : { "name" : "default", "concurrency_type" : "exclusive", "concurrency" : 500, "bandwidth_type" : "exclusive" }, "type" : { }, "kafka_detail" : { }, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 目标连接名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须以字母或数字开头，不能为default description 否 String 目标连接描述 vpc_id 是 String 待连接的VPC ID subnet_id 是 String 待连接的子网ID type 否 String 目标连接类型。目前支持webhook：http连接；kafka：华为云官方kafka实例 kafka_detail 否 KafkaConnectionDetail object kafka连接参数 表4 KafkaConnectionDetail 参数 是否必选 参数类型 描述 instance_id 是 String kafka实例id。 addr 是 String kafka连接地址。 security_protocol 否 String 安全协议。 enable_sasl_ssl 是 Boolean kafka实例是否开启了SASL_SSL。 user_name 否 String kafka实例用户名。实例开启了SASL_SSL时必填 password 否 String kafka实例密码。实例开启了SASL_SSL时必填 acks 否 String 收到Server端确认信号个数，表示procuder需要收到多少个这样的确认信号，算消息发送成功。acks参数代表了数据备份的可用性。支持选项： acks=0：表示producer不需要等待任何确认收到的信息，副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据，同时重试配置不会发生作用（因为客户端不知道是否失败）回馈的offset会总是设置为-1。 acks=1：这意味着至少要等待leader已经成功将数据写入本地log，但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据，而此时leader又无法提供服务，则消息会丢失。 acks=all：这意味着leader需要等待ISR中所有备份都成功写入日志，只有任何一个备份存活，数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。

响应参数 状态码：200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 id String 事件源ID name String 目标连接名称，租户下唯一，由小写字母、数字、点、下划线和中划线组成，必须以字母或数字开头，不能为default description String 目标连接描述 status String 目标连接状态 error_info ErrorInfo object 错误信息 vpc_id String 待连接的VPC ID subnet_id String 待连接的子网ID agency String 私网目标连接使用的用户委托名称 flavor flavor object 规格 type String 目标连接类型。目前支持webhook：http连接；kafka：华为云官方kafka实例 kafka_detail KafkaConnectionDetail object kafka连接参数 created_time String 创建UTC时间 updated_time String 更新UTC时间 表7 ErrorInfo 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息 表8 flavor 参数 参数类型 描述 name String 规格名称 concurrency_type String 并发规格类型 concurrency Integer 并发数 bandwidth_type String 带宽类型 表9 KafkaConnectionDetail 参数 参数类型 描述 instance_id String kafka实例id。 addr String kafka连接地址。 security_protocol String 安全协议。 enable_sasl_ssl Boolean kafka实例是否开启了SASL_SSL。 user_name String kafka实例用户名。实例开启了SASL_SSL时必填 password String kafka实例密码。实例开启了SASL_SSL时必填 acks String 收到Server端确认信号个数，表示procuder需要收到多少个这样的确认信号，算消息发送成功。acks参数代表了数据备份的可用性。支持选项： acks=0：表示producer不需要等待任何确认收到的信息，副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据，同时重试配置不会发生作用（因为客户端不知道是否失败）回馈的offset会总是设置为-1。 acks=1：这意味着至少要等待leader已经成功将数据写入本地log，但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据，而此时leader又无法提供服务，则消息会丢失。 acks=all：这意味着leader需要等待ISR中所有备份都成功写入日志，只有任何一个备份存活，数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。

请求示例 创建自定义事件通道 POST https://{endpoint}/v1/{project_id}/channels { "name" : "channel", "description" : "first channel", "enterprise_project_id" : "string", "cross_account" : true, "policy" : { "additionalProp1" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" }, "additionalProp2" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" }, "additionalProp3" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" } } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 通道名称，租户下唯一，由字母，数字，点，下划线和中划线组成，必须字母或数字开头，不能是default description 否 String 通道描述 enterprise_project_id 否 String 企业项目id cross_account 否 Boolean 跨账号开关 policy 否 Object 策略

响应参数 状态码：200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 id String 通道ID name String 通道名称 description String 通道描述 provider_type String 通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道 created_time String 创建UTC时间 updated_time String 更新UTC时间 enterprise_project_id String 企业项目id

响应示例 状态码：200 Demo Information { "id" : "bd14144e-8f3c-43d6-bdfd-bf09b52c2b96", "name" : "channel", "description" : "first channel", "provider_type" : "CUSTOM", "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00", "enterprise_project_id" : "string" }

响应参数 状态码：200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 failed_count Integer 预校验发布事件失败的个数 sources Array of CheckPutEventsResult objects 事件源参数 表7 CheckPutEventsResult 参数 参数类型 描述 channel_id String 事件通道id source_name String 事件源名称 check_result Boolean 发送事件是否成功检查结果 check_detail String 发送事件是否成功检查明细

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 sources 否 Array of sources objects 事件源参数 表4 sources 参数 是否必选 参数类型 描述 channel_id 否 String 事件通道ID source_name 否 String 事件源名称

响应示例 状态码：200 OK { "count" : 2, "limit" : 1000, "offset" : 0, "agents" : [ { "created_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "host_name" : "eBackup", "host_ip" : "18.9.158.36", "status" : "normal", "last_active_time" : "2022-01-30T09:28:08.960+00:00" }, { "created_at" : "2022-01-14T06:47:17.524+00:00", "updated_at" : "2022-01-28T05:01:32.739+00:00", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "host_name" : "ecs-00001", "host_ip" : "10.10.0.1", "status" : "normal", "last_active_time" : "2022-01-28T05:01:32.000+00:00", "paths" : [ { "id" : "6c3d1ed6-b7d7-4e27-94ee-321431e84c5c", "dir_path" : "/home/hcp", "status" : "available", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" }, { "id" : "e2af0fdd-9644-4db8-986e-5a6a2395c390", "dir_path" : "/opt/workspace", "status" : "available", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" } ] } ] }

URI GET /v3/{project_id}/agents 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 agent_id 否 String 客户端ID limit 否 String 每页显示条目数，正整数 offset 否 Integer 偏移值,正整数 status 否 String 状态

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 agents Array of Agent objects 客户端实例列表 count Integer 客户端个数 limit Integer 每页显示的条目数量 offset Integer 偏移量，表示从此偏移量开始查询 表5 Agent 参数 参数类型 描述 created_at String 客户端创建时间 updated_at String 客户端更新时间 agent_id String 客户端ID agent_version String 客户端版本号 agent_type String 客户端类型 host_name String 客户端所在的主机名 host_nickname String 客户端所在的主机昵称 host_ip String 客户端所在主机的IP host_os String 客户端主机所在的操作系统 status String 客户端状态 last_active_time String 客户端上次激活时间 paths Array of Path objects 客户端的备份路径 表6 Path 参数 参数类型 描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。 说明： 该特性目前处于公测阶段,部分region可能无法使用。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 cloud_service_console_url 否 String 云服务ConsoleURL。订单支付完成后，客户可以通过此URL跳转到云服务Console页面查看信息 product_info 是 CbcProductInfoOrderChange object 产品信息 resource_id 是 String 待变更的资源ID is_auto_pay 否 Boolean 是否自动支付，默认非自动支付：false 说明： 该特性目前处于公测阶段，部分region可能无法使用或不生效。 promotion_info 否 String 购买折扣 表3 CbcProductInfoOrderChange 参数 是否必选 参数类型 描述 product_id 是 String 产品标识，通过订购询价接口获得，长度限制：1-64，只能由字母、数字、“_”、“-”组成。 resource_size 是 Integer 资源容量大小，取值范围：10-10485760 resource_size_measure_id 否 Integer 资源容量度量标识，枚举值17：GB resource_spec_code 是 String 用户购买云服务产品的资源规格 Enum: [vault.backup.server.normal，vault.backup.turbo.normal, vault.backup.database.normal，vault.backup.volume.normal，vault.backup.rds.normal，vault.replication.server.normal，vault.hybrid.server.normal]

请求示例 变更包周期存储库大小到 50 GB https://{endpoint}/v3/{project_id}/orders/change { "resource_id" : "9dd8f8db-a926-440b-9af5-81b643618898", "product_info" : { "product_id" : "00301-34090-0--0", "resource_size" : 200, "resource_spec_code" : "vault.backup.server.normal" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 agent 是 AgentUpdate object 待更新的agent参数 表4 AgentUpdate 参数 是否必选 参数类型 描述 status 是 String 客户端状态，当前只支持卸载，由客户端被卸载时自动触发 uninstall

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 agent Agent object 客户端详情 表6 Agent 参数 参数类型 描述 created_at String 客户端创建时间 updated_at String 客户端更新时间 agent_id String 客户端ID agent_version String 客户端版本号 agent_type String 客户端类型 host_name String 客户端所在的主机名 host_nickname String 客户端所在的主机昵称 host_ip String 客户端所在主机的IP host_os String 客户端主机所在的操作系统 status String 客户端状态 last_active_time String 客户端上次激活时间 paths Array of Path objects 客户端的备份路径 表7 Path 参数 参数类型 描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。 说明： 该特性目前处于公测阶段,部分region可能无法使用。

响应示例 状态码：200 OK { "agent" : { "created_at" : "2022-01-30T09:28:09.334+00:00", "updated_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "agent_version" : "1.0.0", "agent_type" : "native", "host_name" : "ecs-0001", "host_nickname" : "", "host_ip" : "192.168.10.144", "host_os" : "linux", "status" : "uninstall", "last_active_time" : "2022-01-30T09:28:08.960+00:00", "paths" : [ { "id" : "5684b0fb-44c8-4c70-bb59-b03ec2738360", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/huaweicloud/cbragent/lib", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" }, { "id" : "1ad949d5-c955-4995-8c28-60fc8b110a21", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/backup", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" } ] } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 agent Agent object 客户端详情 表6 Agent 参数 参数类型 描述 created_at String 客户端创建时间 updated_at String 客户端更新时间 agent_id String 客户端ID agent_version String 客户端版本号 agent_type String 客户端类型 host_name String 客户端所在的主机名 host_nickname String 客户端所在的主机昵称 host_ip String 客户端所在主机的IP host_os String 客户端主机所在的操作系统 status String 客户端状态 last_active_time String 客户端上次激活时间 paths Array of Path objects 客户端的备份路径 表7 Path 参数 参数类型 描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。 说明： 该特性目前处于公测阶段,部分region可能无法使用。

请求示例 注册客户端由agent安装时自动触发，无需客户手动调用。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents { "agent" : { "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "host_name" : "ecs-00002", "host_ip" : "10.10.0.2", "host_os" : "linux", "agent_version" : "1.0.0", "agent_type" : "native" } }

响应示例 状态码：200 OK { "agent" : { "created_at" : "2022-01-30T09:28:09.334+00:00", "updated_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "agent_version" : "1.0.0", "agent_type" : "native", "host_name" : "ecs-0001", "host_nickname" : "", "host_ip" : "192.168.10.144", "host_os" : "linux", "status" : "normal", "last_active_time" : "2022-01-30T09:28:08.960+00:00" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用。 表3 请求Body参数 参数 是否必选 参数类型 描述 agent 是 AgentRegister object 客户端注册参数 表4 AgentRegister 参数 是否必选 参数类型 描述 agent_id 是 String 客户端ID host_name 是 String 客户端所在的主机名 host_ip 是 String 客户端所在主机的IP host_os 是 String 客户端所在主机的操作系统 host_nickname 否 String 客户端所在主机的主机别名 agent_version 否 String 客户端版本 agent_type 否 String 客户端类型，分本地客户端和云上客户端(cloud/native)

响应示例 状态码：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-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" } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 policy Policy object 创建响应 表4 Policy 参数 参数类型 描述 enabled Boolean 策略是否启用 id String 策略ID name String 策略名称 operation_definition PolicyoODCreate object 策略属性 operation_type String 保护类型：备份（backup）、复制(replication)。 trigger PolicyTriggerResp object 策略时间调度规则 associated_vaults Array of PolicyAssociateVault objects 关联的存储库 policy_type String 策略类型 表5 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerResp 参数 参数类型 描述 id String 调度器id name String 调度器名称 properties PolicyTriggerPropertiesResp object 调度器属性 type String 调度器类型,目前只支持 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

请求示例 创建一个备份策略，周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies { "policy" : { "enabled" : true, "name" : "policy001", "operation_definition" : { "day_backups" : 0, "month_backups" : 0, "retention_duration_days" : 1, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "operation_type" : "backup", "trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } } } } 创建一个复制策略，周一到周天每天14:00执行复制，保留策略按备份保留时长，保留一天。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies { "policy" : { "enabled" : true, "name" : "policy002", "operation_definition" : { "retention_duration_days" : 1, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "destination_region" : "cn-southwest-247", "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4" }, "operation_type" : "replication", "trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } } } }

响应示例 状态码：200 OK 创建备份策略成功。策略为周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。 { "policy" : { "name" : "policy001", "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" } } 创建复制策略成功。策略为周一到周天每天14:00执行复制，保留策略按备份保留时长，保留一天。 { "policy" : { "name" : "policy002", "enabled" : true, "trigger" : { "id" : "b37cf79e-5cfa-4a84-99a3-91d60a314c46", "name" : "default", "type" : "time", "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ], "start_time" : "2019-05-08T06:58:05.000+00:00" } }, "operation_definition" : { "retention_duration_days" : 1, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "destination_region" : "cn-southwest-247", "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4" }, "operation_type" : "replication", "id" : "e47e4916-481a-4d10-95a2-165bcfe598c5", "policy_type" : "custom_policy" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 PolicyCreate object 创建策略body 表4 PolicyCreate 参数 是否必选 参数类型 描述 enabled 否 Boolean 是否启用策略 name 是 String 策略名称，长度限制：1- 64，只能由中文、字母、数字、“_”、“-”组成。 operation_definition 是 PolicyoODCreate object 调度参数 operation_type 是 String 保护类型：备份（backup）、复制(replication)。 trigger 是 PolicyTriggerReq object 策略执行时间规则 表5 PolicyoODCreate 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id 否 String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region 否 String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerReq 参数 是否必选 参数类型 描述 properties 是 PolicyTriggerPropertiesReq object 调度器属性 表7 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'。

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 policy Policy object 创建响应 表9 Policy 参数 参数类型 描述 enabled Boolean 策略是否启用 id String 策略ID name String 策略名称 operation_definition PolicyoODCreate object 策略属性 operation_type String 保护类型：备份（backup）、复制(replication)。 trigger PolicyTriggerResp object 策略时间调度规则 associated_vaults Array of PolicyAssociateVault objects 关联的存储库 policy_type String 策略类型 表10 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表11 PolicyTriggerResp 参数 参数类型 描述 id String 调度器id name String 调度器名称 properties PolicyTriggerPropertiesResp object 调度器属性 type String 调度器类型,目前只支持 time: 定时调度。 表12 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" 表13 PolicyAssociateVault 参数 参数类型 描述 destination_vault_id String 关联的远端存储库ID vault_id String 存储库ID

响应示例 状态码：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", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } ], "count" : 4, "limit" : 1000, "offset" : 0 }

URI GET /v3/{project_id}/organization-policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 operation_type 是 String 组织策略类型 limit 否 Integer 每页显示的条目数量，正整数 offset 否 Integer 偏移值，正整数