华为云用户手册

URI GET /v3/{project_id}/vaults/external 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 cloud_type 否 String 云类型。取值为public和hybrid。 external_project_id 是 String 其他区域的项目ID limit 否 Integer 每页显示条目数 objcet_type 否 String 资源类型 offset 否 Integer 偏移值 protect_type 否 String 保护类型。取值为backup，replication和hybrid。 region_id 是 String 区域ID vault_id 否 String 存储库ID，指定存储ID时其他过滤条件不生效。

响应示例 状态码： 200 OK { "count" : 1, "vaults" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "name" : "vault-name", "billing" : { "status" : "available", "used" : 5588, "protect_type" : "replication", "object_type" : "server", "consistent_level" : "crash_consistent", "cloud_type" : "public", "allocated" : 0, "charging_mode" : "post_paid", "spec_code" : "vault.replication.server.normal", "size" : 10 }, "tags" : [ ], "created_at" : "2019-04-08T11:06:25.766+00:00", "enterprise_project_id" : "876ae48d-cfb3-4aff-bb55-83167abd3876", "project_id" : "68589cac08274b82b4e254268a3862d8", "id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "resources" : [ ] } ] }

响应参数 状态码： 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 排除目录列表，多个路径之间以英文逗号分隔

请求示例 注册客户端由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 表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 关联的存储库 表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或0-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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 vault 是 VaultBatchUpdate object 存储库修改参数体 表4 VaultBatchUpdate 参数 是否必选 参数类型 描述 smn_notify 否 Boolean 存储库smn 消息通知 开关 threshold 否 Integer 存储库容量阈值

请求示例 创建一个备份策略，周一到周天每天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" } } 创建复制策略成功。策略为周一到周天每天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" } }

响应参数 状态码： 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 关联的存储库 表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或0-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

请求参数 表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或0-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 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 表4 响应Body参数 参数 参数类型 描述 policies Array of OrganizationPolicy objects 组织策略列表 count Integer 组织策略数量 limit Integer 每页显示的条目数量 offset Integer 偏移量，表示从此偏移量开始查询 表5 OrganizationPolicy 参数 参数类型 描述 id String 组织策略ID name String 组织策略名称 description String 组织策略描述 operation_type String 组织策略类型 backup: 备份 replication: 复制 domain_id String 组织策略所属账号ID policy_name String 策略名称 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 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 max_backups Integer 单个备份对象自动备份的最大备份数。取值为-1或0-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 表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'。

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

响应示例 状态码： 200 OK { "backup" : { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664", "enterprise_project_id" : 0, "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "resource_az" : "az1.dc1", "image_type" : "backup", "resource_id" : "94eba8b2-acc9-4d82-badc-127144cc5526", "resource_size" : 40, "children" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664", "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235", "image_type" : "backup", "resource_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376", "resource_size" : 40, "children" : [ ], "parent_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "extend_info" : { "auto_trigger" : true, "snapshot_id" : "5230a977-1a94-4092-8edd-519303a44cda", "bootable" : true, "encrypted" : true }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "status" : "available", "resource_name" : "ecs-1f0f-0002", "name" : "autobk_a843_ecs-1f0f-0002", "created_at" : "2019-05-10T07:59:59.451+00:00", "resource_type" : "OS::Cinder::Volume" } ], "extend_info" : { "auto_trigger" : true, "supported_restore_mode" : "backup", "contain_system_disk" : true, "support_lld" : true }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "status" : "available", "resource_name" : "ecs-1f0f-0002", "description" : "backup_description", "name" : "backup_name", "created_at" : "2019-05-10T07:59:12.085+00:00", "resource_type" : "OS::Nova::Server" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 backup BackupResp object 备份副本 表4 BackupResp 参数 参数类型 描述 checkpoint_id String 还原点ID created_at String 创建时间，例如:"2020-02-05T10:38:34.209782" description String 备份描述 expired_at String 过期时间，例如:"2020-02-05T10:38:34.209782" extend_info BackupExtendInfo object 扩展信息 id String 备份ID image_type String 备份类型。取值为backup和replication。 name String 备份名称 parent_id String 父备份ID project_id String 项目ID protected_at String 备份时间 resource_az String 资源可用区 resource_id String 资源ID resource_name String 资源名称 resource_size Integer 资源大小，单位为GB resource_type String 资源类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 status String 备份状态 available: 可用 protecting: 保护中 deleting: 删除中 restoring: 恢复中 error: 异常 waiting_protect: 等待保护 waiting_delete: 等待删除 waiting_restore: 等待恢复 updated_at String 更新时间，例如:"2020-02-05T10:38:34.209782" vault_id String 存储库ID replication_records Array of ReplicationRecordGet objects 复制记录 enterprise_project_id String 企业项目id,默认为‘0’。 provider_id String 备份提供商ID，用于区分备份对象。当前取值包含： 0daac4c5-6707-4851-97ba-169e36266b66，该值代表备份对象为云服务器。d1603440-187d-4516-af25-121250c7cc97，该值代表备份对象为云硬盘。3f3c3220-245c-4805-b811-758870015881， 该值代表备份对象为SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2，该值代表备份对象为混合云VMware备份。 children Array of BackupResp objects 子副本列表 incremental Boolean 是否是增备 version Integer 备份副本快照类型 表5 BackupExtendInfo 参数 参数类型 描述 auto_trigger Boolean 是否是自动生成的备份副本 bootable Boolean 是否系统盘备份 snapshot_id String 卷备份副本的快照id support_lld Boolean 是否支持lazyloading快速恢复 supported_restore_mode String 备份支持恢复的方式 na: 备份不支持直接恢复，只支持备份创建新资源等操作。 backup: 备份支持通过云服务器上硬盘的备份进行恢复。 snapshot: 备份此时已经支持创建整机镜像。 os_images_data Array of ImageData objects 备份注册镜像ID列表 contain_system_disk Boolean 整机备份是否包含系统盘 encrypted Boolean 是否加密 system_disk Boolean 是否是系统盘 is_multi_az Boolean 备份类型是否为多AZ 表6 ImageData 参数 参数类型 描述 image_id String 镜像ID 表7 ReplicationRecordGet 参数 参数类型 描述 created_at String 复制的开始时间 destination_backup_id String 复制的目的备份ID destination_checkpoint_id String 复制的目的备份记录ID destination_project_id String 复制的目标项目ID destination_region String 复制的目标区域 destination_vault_id String 目标存储库ID extra_info ReplicationRecordsExtraInfo object 复制附加信息 id String 复制记录ID source_backup_id String 复制的源备份ID source_checkpoint_id String 复制的源备份记录ID source_project_id String 复制的源项目ID source_region String 复制的源区域 status String 复制的状态 replicating: 复制中 success: 成功 fail: 失败 skip: 跳过 waiting_replicate: 等待复制 vault_id String 备份所在的存储库ID 表8 ReplicationRecordsExtraInfo 参数 参数类型 描述 progress Integer 复制进度 fail_code String 失败错误码，成功时为空 fail_reason String 错误原因 auto_trigger Boolean 是否为自动调度复制 destinatio_vault_id String 目标端的存储库id

响应示例 状态码： 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" } ], "count" : 10 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policies Array of Policy objects 策略列表 count Integer 策略总数 表5 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 关联的存储库 表6 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或0-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 表7 PolicyTriggerResp 参数 参数类型 描述 id String 调度器id name String 调度器名称 properties PolicyTriggerPropertiesResp object 调度器属性 type String 调度器类型,目前只支持 time: 定时调度。 表8 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" 表9 PolicyAssociateVault 参数 参数类型 描述 destination_vault_id String 关联的远端存储库ID vault_id String 存储库ID

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of TagsResp objects 标签列表 表3 TagsResp 参数 参数类型 描述 key String 键。 key最大长度36个字符。 key不能为空字符串。 key只能由中文，字母，数字，“-”，“_”组成。 values String 值列表。 value最大长度43个字符。 value可以为空字符串。 key只能由中文，字母，数字，“-”，“_”组成。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 请参见错误码。 error_msg String 错误信息

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 agent Agent object 客户端详情 表4 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 客户端的备份路径 表5 Path 参数 参数类型 描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔

响应示例 状态码： 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", "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 OK { "policy" : { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_create_test", "description" : "", "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" } }

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 policy OrganizationPolicy object 组织策略详情 表9 OrganizationPolicy 参数 参数类型 描述 id String 组织策略ID name String 组织策略名称 description String 组织策略描述 operation_type String 组织策略类型 backup: 备份 replication: 复制 domain_id String 组织策略所属账号ID policy_name String 策略名称 policy_enabled Boolean 策略是否开启 policy_operation_definition PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger PolicyTriggerReq object 策略执行时间规则 status String 组织策略状态 domain_name 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或0-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 PolicyTriggerReq 参数 参数类型 描述 properties PolicyTriggerPropertiesReq object 调度器属性 表12 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'。

请求示例 创建组织策略。 POST https://{endpoint}/v3/{project_id}/organization-policies { "policy" : { "policy_enabled" : false, "policy_name" : "policy_create_test", "policy_operation_definition" : { "retention_duration_days" : 30, "max_backups" : -1, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "full_backup_interval" : -1 }, "policy_trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } }, "operation_type" : "backup", "name" : "organization-policies_create_test", "description" : "" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 OrganizationPolicyCreate object 表4 OrganizationPolicyCreate 参数 是否必选 参数类型 描述 name 是 String 组织策略名称 description 否 String 组织策略描述 operation_type 是 String 组织策略类型 backup: 备份 replication: 复制 policy_name 是 String 策略名称 policy_enabled 是 Boolean 策略是否开启 policy_operation_definition 是 PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_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或0-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 OK { "total_count" : 7, "resources" : [ { "resource_id" : "e54f7854-8de8-4f98-acf1-65f330bfe877", "resource_name" : "vault-7698-api-test", "resource_detail" : { "vault" : { "id" : "e54f7854-8de8-4f98-acf1-65f330bfe877", "name" : "vault-7698-api-test", "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2023-04-21T08:20:43.022+00:00", "project_id" : "667230ba418f48f1996329f174693053", "enterprise_project_id" : 0, "auto_bind" : false, "bind_rules" : { }, "auto_expand" : false, "smn_notify" : true, "threshold" : 80, "user_id" : "0ae13f012b80d2d81f11c0129285d34b", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "pre_paid", "order_id" : " CS 23042116192E6CZ", "product_id" : "00301-231151-0--0", "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "status" : "available", "size" : 100 }, "tags" : [ ] } }, "tags" : [ ] } ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of TagsReq objects 包含标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 tags中多个key之间是“与”的关系。 结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 tags_any 否 Array of TagsReq objects 包含任一标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回包含任一标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of TagsReq objects 不包含标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回不包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of TagsReq objects 不包含任一标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回不包含任一标签的资源列表，key之间是或的关系，key-value结构张value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of SysTags objects 仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key： _sys_enterprise_project_id values：企业项目id列表 目前TMS调用时，key下面只包含一个value，0表示默认企业项目。 sys_tags和租户标签过滤条件（tags、tags_any、not_tags、not_tags_any）不能同时使用。 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。 sys_tags不能为空列表 limit 否 String 查询记录数（action为count时无此参数）如果action为filter时，默认为1000，limit最小值为1，limit最大值为1000, 不在范围内报错。返回的结果中记录数不超过limit。 offset 否 String 索引位置（action为count时无此参数）如果action为filter时，默认为0，offset最小值为0。返回的结果中第一条记录为符合查询条件的第offset+1条记录。 action 是 String 操作标识取值范围为："filter", "count"。如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可 matches 否 Array of Match objects 资源本身支持的查询条件。 matches中key不允许重复。 数组长度最大值为 1，后续再扩展。 cloud_type 否 String 云类型 public: 公有云 hybrid: 混合云 object_type 否 String 资源类型 server: 云服务器 disk: 云硬盘 表3 TagsReq 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不允许为空字符串。 前后的空格会被丢弃。 values 是 Array of strings 值列表。 values中最多包含10个value。 每个value最大长度255个unicode字符。前后的空格会被丢弃。 values中value不允许重复。 values中多个value之间是"或"的关系。 values允许为空列表，value允许为空字符串。 values如果为空列表，表示任意值。 *为系统保留字符，如果value是以*开头表示按照*后面的值全模糊匹配，不能只传入“*”。 表4 SysTags 参数 是否必选 参数类型 描述 key 是 String 键。 系统标签的key，从白名单中取，不能随意定义。 目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。 values 是 Array of strings 值列表。 目前仅会用到企业项目ID，其中默 认的企业项目ID为“0”。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。 key取值范围为："resource_name"，资源名称 value 是 String 值。 最大长度255个字符。 key为"resource_name"时，value为空字符串时精确匹配，为非空字符串时模糊匹配。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 agent_status Array of ProtectableAgentStatus objects 状态列表 表5 ProtectableAgentStatus 参数 参数类型 描述 code Integer agent无法连接的错误码 installed Boolean agent是否安装 is_old Boolean agent是否为老版本 message String agent无法连接的错误信息 resource_id String 资源ID version String agent版本号