华为云用户手册

响应参数 状态码：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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 PolicyUpdate object 修改策略body 表4 PolicyUpdate 参数 是否必选 参数类型 描述 enabled 否 Boolean 是否启用策略 name 否 String 策略名称 operation_definition 否 PolicyoODCreate object 调度参数 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'。

请求示例 按需存储库转包周期 https://{endpoint}/v3/{project_id}/orders/change-to-period { "vault_ids" : [ "9dd8f8db-a926-440b-9af5-81b643618898" ], "charging_mode" : "pre_paid", "period_type" : "year", "period_num" : 2, "is_auto_renew" : true, "is_auto_pay" : true, "console_url" : "https://www.{endpoint}/v3/" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 charging_mode 否 String 付费模式，当前仅可选择：pre_paid period_type 是 String 创建类型，按年(year)或者按月(month) period_num 是 Integer 创建类型的数量，按年或按月的个数 is_auto_renew 否 Boolean 到期后是否自动续期，默认不续期 is_auto_pay 否 Boolean 是否自动付费，默认为不自动付费 console_url 否 String 跳转URL vault_ids 是 Array of strings 资源列表

URI GET /v3/{project_id}/protectables/{protectable_type}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID protectable_type 是 String 对象类型 server： 云服务器类型 disk：云硬盘类型 turbo：turbo类型 workspace：workspace类型 workspace_v2：workspace_v2类型 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 根据资源id过滤 limit 否 Integer 每页显示的条目数量，每页最多支持50条 marker 否 String 上一次查询最后一条的ID name 否 String 按名称过滤 offset 否 Integer 偏移值 server_id 否 String 根据该id过滤属于该服务器的所有磁盘，支持企业多项目的用户才能传入此参数 status 否 String 资源的状态，如available，error 等 enterprise_project_id 否 String 企业项目ID

响应示例 状态码：200 OK { "instances" : [ { "status" : "ACTIVE", "children" : [ { "status" : "in-use", "name" : "no_delete_for_cbr_interface-volume-0000", "detail" : { "attachments" : [ { "server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "attachment_id" : "e16631fa-0522-4ac8-8f78-19db435caf68", "volume_id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "attached_at" : "2019-05-08T06:55:26.564+00:00", "device" : "/dev/vda", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a" } ], "links" : [ { "href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a", "rel" : "self" }, { "href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a", "rel" : "bookmark" } ], "availability_zone" : "AZ1", "os-vol-host-attr:host" : "AZ1.xxxxxx#kvm_fusionstorage", "encrypted" : false, "updated_at" : "2019-05-08T08:33:07.855+00:00", "replication_status" : "disabled", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "size" : 40, "user_id" : "3204777a731c4ebea330350c04f41b92", "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "metadata" : { "policy" : "2ecbcffd-08ba-43f7-bf8d-95daba753464", "readonly" : "False", "attached_mode" : "rw" }, "status" : "in-use", "volume_image_metadata" : { "container_format" : "bare", "min_ram" : 0, "__account_code" : "", "__os_bit" : 64, "size" : 2, "__os_version" : "CentOS 7.2 64bit", "__backup_id" : "", "__description" : "", "__support_diskintensive" : "true", "disk_format" : "vhd", "__isregistered" : "true", "__image_size" : 3295645696, "__platform" : "CentOS", "__root_origin" : "file", "__originalimagename" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "__quick_start" : "true", "image_name" : "CentOS7.2-cloudinit", "image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "__os_type" : "Linux", "__image_location" : "172.100.45.130:443:pcsimsf8bd00bf6c304d2e8cf4e2beb0aed702:703eb90a-a65f-4c72-b4c1-f070a55d068b", "min_disk" : 40, "__data_origin" : "file,jingxiang:CentOS-7.2-64bit.zvhd2", "__support_kvm" : "true", "virtual_env_type" : "FusionCompute", "__image_source_type" : "uds", "__support_xen" : "true", "checksum" : "99914b932bd37a50b983c5e7c90ae93b", "__imagetype" : "gold", "__productcode" : "" }, "multiattach" : false, "name" : "no_delete_for_cbr_interface-volume-0000", "bootable" : "true", "created_at" : "2019-05-08T06:54:58.478+00:00", "volume_type" : "SATA", "shareable" : false }, "children" : [ ], "type" : "OS::Cinder::Volume", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "size" : 40 }, { "status" : "in-use", "name" : "volume-f926-0001", "detail" : { "attachments" : [ { "server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "attachment_id" : "3b32cb75-bd96-493b-8fb2-13f063c876d5", "volume_id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "attached_at" : "2019-05-08T06:56:25.892+00:00", "device" : "/dev/vdb", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99" } ], "links" : [ { "href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "rel" : "self" }, { "href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "rel" : "bookmark" } ], "availability_zone" : "AZ1", "os-vol-host-attr:host" : "AZ1.xxxxxx#FusionStorage", "encrypted" : false, "updated_at" : "2019-05-08T06:56:26.207+00:00", "replication_status" : "disabled", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "size" : 10, "user_id" : "f3d66502790d4ddaadef5056059ed8f4", "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "metadata" : { "policy" : "cf3274fc-d23e-4c12-8be7-1e41b3c2faea", "readonly" : "False", "attached_mode" : "rw" }, "status" : "in-use", "multiattach" : false, "name" : "volume-f926-0001", "bootable" : "false", "created_at" : "2019-03-26T09:30:46.784+00:00", "volume_type" : "SATA", "shareable" : false }, "children" : [ ], "type" : "OS::Cinder::Volume", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "size" : 10 } ], "protectable" : { "reason" : "", "code" : "", "result" : true }, "name" : "no_delete_for_cbr_interface", "detail" : { "addresses" : { "94b88790-c906-4450-b7c2-1c2b1ea639bf" : [ { "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af", "version" : 4, "OS-EXT-IPS:port_id" : "f22f531a-d38a-480b-b59e-f7e5db0dcdcc", "addr" : "192.168.1.44", "OS-EXT-IPS:type" : "fixed" }, { "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af", "version" : 4, "OS-EXT-IPS:port_id" : "f22f531a-d38a-480b-b59e-f7e5db0dcdcc", "addr" : "100.78.0.199", "OS-EXT-IPS:type" : "floating" } ] }, "OS-EXT-SRV-ATTR:ramdisk_id" : "", "image" : "", "enterprise_project_id" : 0, "updated" : "2019-05-08T06:57:02.000+00:00", "OS-EXT-SRV-ATTR:user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQ5c1FaeXIkdnk5N1pGYXg5WUpRTUpPRElGdGdjYnovTUdEZ1dad3E4VTM1dWE4MjQxTmtDTG1GRjJUUm1BdnZSQnNCLy93VER0aFVRNUt0Z1p6dUlrenp2NmQwYTAnIHwgY2hwYXNzd2QgLWU7", "OS-EXT-STS:vm_state" : "active", "OS-EXT-SRV-ATTR:instance_name" : "instance-0004456e", "OS-EXT-SRV-ATTR:root_device_name" : "/dev/vda", "OS-SRV-USG:launched_at" : "2019-05-08T06:55:38.000+00:00", "flavor" : { "vcpus" : 1, "disk" : 0, "ram" : 1024, "id" : "s3.small.1", "name" : "s3.small.1" }, "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "security_groups" : [ { "name" : "default" } ], "os-extended-volumes:volumes_attached" : [ { "device" : "/dev/vda", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "delete_on_termination" : false, "bootIndex" : 0 }, { "device" : "/dev/vdb", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "delete_on_termination" : false } ], "user_id" : "f3d66502790d4ddaadef5056059ed8f4", "OS-EXT-SRV-ATTR:hostname" : "no-delete-for-cbr-interface", "OS-DCF:diskConfig" : "MANUAL", "accessIPv4" : "", "accessIPv6" : "", "OS-EXT-SRV-ATTR:reservation_id" : "r-kpb5xckf", "progress" : 0, "OS-EXT-STS:power_state" : 1, "OS-EXT-AZ:availability_zone" : "AZ1", "metadata" : { "metering.image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "metering.imagetype" : "gold", "metering.resourcespeccode" : "s3.small.1.linux", "metering.cloudServiceType" : "sys.service.type.ec2", "virtual_env_type" : "FusionCompute", "image_name" : "CentOS7.2-cloudinit", "metering.resourcetype" : 1, "vpc_id" : "94b88790-c906-4450-b7c2-1c2b1ea639bf", "os_bit" : 64, "cascaded.instance_extrainfo" : "", "os_type" : "Linux", "charging_mode" : 0 }, "status" : "ACTIVE", "sys_tags" : [ { "value" : 0, "key" : "_sys_enterprise_project_id" } ], "os:scheduler_hints" : { }, "hostId" : "179f22cafe6b951921bd6deb3b13a978df620427fb37bbb7c619de98", "OS-EXT-SRV-ATTR:host" : "AZ1.xxxxxx", "description" : "", "tags" : [ ], "OS-EXT-SRV-ATTR:kernel_id" : "", "locked" : false, "OS-EXT-SRV-ATTR:hypervisor_hostname" : "nova003@36", "name" : "no_delete_for_cbr_interface", "OS-EXT-SRV-ATTR:launch_index" : 0, "created" : "2019-05-08T06:55:22.000+00:00", "tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "host_status" : "UP", "config_drive" : "" }, "type" : "OS::Nova::Server", "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "size" : 50 } ] }

功能介绍 为指定实例批量添加或删除标签 标签管理服务需要使用该接口批量管理实例的标签。 一个资源上最多有10个标签（支持landingzone的region支持20个）。 此接口为幂等接口： 创建时如果请求体中存在重复key则报错。 创建时，不允许重复key，如果数据库存在就覆盖。 删除时，允许重复key。 删除时，如果删除的标签不存在，默认处理成功,删除时不对标签字符集范围做校验。key长度127个字符，value为255个字符。删除时tags结构体不能缺失，key不能为空，或者空字符串。

请求示例 批量创建tag POST https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags/action { "tags" : [ { "key" : "string", "value" : "string" }, { "key" : "string1", "value" : "string2" } ], "action" : "create" }

请求示例 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d/add-path { "add_path" : [ "/home/hcp", "/opt/workspace/" ], "exclude_path" : [ { "path_name" : "/home/hcp", "exclude_path_name" : [ "/home/hcp/1", "/home/hcp/2" ] }, { "path_name" : "/opt/workspace/", "exclude_path_name" : [ "/opt/workspace/1", "/opt/workspace/2" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 add_path 是 Array of strings 增加备份路径详情 exclude_path 否 Array of ExcludePath objects 增加排除目录。 说明： 该特性目前处于公测阶段，部分region可能无法使用。 表4 ExcludePath 参数 是否必选 参数类型 描述 path_name 否 String 备份目录 exclude_path_name 否 Array of strings 排除目录列表

响应示例 状态码：200 OK { "policy" : { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_update_test", "description" : "", "operation_type" : "backup", "domain_id" : "0ae13f008700d53f0fb4c01200e79660", "policy_name" : "policy_update_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" } }

请求示例 更新组织策略。 PUT https://{endpoint}/v3/{project_id}/organization-policies { "policy" : { "policy_enabled" : false, "policy_name" : "policy_update_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" ] } }, "name" : "organization-policies_update_test", "description" : "", "effective_scope" : "" } }

响应参数 状态码：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 组织策略所属账号 effective_scope 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 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'。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 OrganizationPolicyUpdate object 表4 OrganizationPolicyUpdate 参数 是否必选 参数类型 描述 name 否 String 组织策略名称 description 否 String 组织策略描述 policy_name 否 String 策略名称 policy_enabled 否 Boolean 策略是否开启 policy_operation_definition 否 PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger 否 PolicyTriggerReq object 策略执行时间规则 effective_scope 否 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 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 表3 响应Body参数 参数 参数类型 描述 alarm_data_list Array of AlarmDataVO objects 告警列表。 total_count Integer 消息总数。 表4 AlarmDataVO 参数 参数类型 描述 id Long 告警通知id。 gmt_create String 创建时间。 gmt_create_timestamp Long 创建的时间戳。 region_alarm_event_id Long region中事件的id。 business_name String 应用名称。 app_name String 组件名称。 version_number Integer 版本。 alarm_rule_type String 告警规则类别。 gmt_modify String 修改时间。 process_unit String 处理单元。 region String 区 域名 称。 instance_id Long 实例id。 ip_address String 实例ip地址。 instance_name String 实例名称。 env_id Long 环境id。 business_id Long 应用id。 template_id Long 模板id。 alarm_rule_id Long 告警规则id。 monitor_item_id Long 监控项id。 collector_id Integer 采集器id。 collector_name String 采集器名称。 alarm_rule_name String 告警规则名称。 alarm_rule_expression String 告警表达式。 alarm_first_time String 开始报警时间。 alarm_last_time String 最后一次报警时间。 alarm_level String 告警级别。 restrain_key String 唯一告警标识符。 status String 告警状态。 alarm_source String 告警来源。 alarm_content String 告警内容。 alarm_data_type String 告警数据类型。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-business-id 是 Long 应用id。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表2 请求Body参数 参数 是否必选 参数类型 描述 page 否 Integer 页码。 page_size 否 Integer 每页数量。 region 否 String region英文名称。 app_name 否 String 组件环境名称。 business_id 是 Long 应用id。 monitor_item_id 否 Long 监控项id。 status 否 String 告警状态 RECOVER：已恢复 ABNORMAL：异常 ALERT：告警中。 alarm_level 否 String 告警级别 COMMON：轻微； CRITICAL：严重。 keyword 否 String 关键字。 alarm_start_time 否 String 告警开始时间。 alarm_end_time 否 String 告警结束时间。 collector_id 否 Integer 采集器id。 ip_address 否 String 实例ip地址。 env_list 否 Array of integers 环境集合。

请求示例 查询目标环境ID为4394，开始时间戳为1667465258000，结束时间戳为1667466458000的环境级别全局拓扑图信息。 /v1/apm2/openapi/topology/env-search { "direction" : "", "end_time" : 1667466458000, "start_time" : 1667465258000, "filter_user" : false, "target_env_id" : 4394 }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 x-business-id 是 Long 应用id。 表2 请求Body参数 参数 是否必选 参数类型 描述 target_env_id 是 Long 环境id。 direction 否 String 方向，可为空。 end_time 是 String 结束时间。 start_time 是 String 开始时间。 filter_user 否 Boolean 过滤。

响应示例 状态码： 200 OK，请求响应成功。 { "node_list" : [ { "node_type" : "Env", "node_name" : "apm-archive:xx-xxx-xxx", "node_id" : "4394", "env_id" : 4394 }, { "node_type" : "Kafka", "node_name" : "Kafka", "node_id" : "Kafka", "env_id" : null }, { "node_type" : "Env", "node_name" : "config-web:xx-xxxx-204", "node_id" : "1927", "env_id" : 1927 }, { "node_type" : "Env", "node_name" : "config-web:xx-xxxx-xxx", "node_id" : "51", "env_id" : 51 }, { "node_type" : "Env", "node_name" : "user", "node_id" : "user", "env_id" : null } ], "line_list" : [ { "from_node" : "user", "to_node" : "4394", "direction" : "in", "collector" : "Url", "target_env_id" : 4394, "hints" : { "rt" : "0.09", "count" : "680", "error" : "0" }, "filter_value" : "user" }, { "from_node" : "4394", "to_node" : "51", "direction" : "out", "collector" : "HttpClient", "target_env_id" : 4394, "hints" : { "rt" : "33.27", "count" : "668", "error" : "0" }, "filter_value" : "51" }, { "from_node" : "Kafka", "to_node" : "4394", "direction" : "in", "collector" : "KafkaConsumer", "target_env_id" : 4394, "hints" : { "bytes" : "-1448635860", "count" : "4163226" }, "filter_value" : "Kafka" }, { "from_node" : "4394", "to_node" : "Kafka", "direction" : "out", "collector" : "KafkaProducer", "target_env_id" : 4394, "hints" : { "bytes" : "0", "count" : "0" }, "filter_value" : "Kafka" }, { "from_node" : "4394", "to_node" : "1927", "direction" : "out", "collector" : "HttpClient", "target_env_id" : 4394, "hints" : { "rt" : "41.64", "count" : "170", "error" : "0" }, "filter_value" : "1927" } ], "collector_config" : { "KafkaProducer" : { "line_view_config" : { "metric_set" : "total", "filter_prefix" : null, "line_view_item_list" : [ { "function" : "SUM(recordSendTotal)", "as" : "count" }, { "function" : "SUM(byteTotal)", "as" : "bytes" } ] }, "detail_view_config" : { "metric_set" : "topic", "group_by" : "topic", "detail_view_item_list" : [ { "function" : "SUM(recordSendTotal)", "as" : "count" }, { "function" : "SUM(byteTotal)", "as" : "bytes" } ] } }, "HttpClient" : { "line_view_config" : { "metric_set" : "hostInvocation", "filter_prefix" : "envId=", "line_view_item_list" : [ { "function" : "SUM(invokeCount)", "as" : "count" }, { "function" : "SUM(totalTime)/SUM(invokeCount)", "as" : "rt" }, { "function" : "SUM(errorCount)", "as" : "errorCount" } ] }, "detail_view_config" : null }, "KafkaConsumer" : { "line_view_config" : { "metric_set" : "total", "filter_prefix" : null, "line_view_item_list" : [ { "function" : "SUM(recordConsumedTotal)", "as" : "count" }, { "function" : "SUM(bytesConsumedTotal)", "as" : "bytes" } ] }, "detail_view_config" : { "metric_set" : "topic", "group_by" : "topic", "detail_view_item_list" : [ { "function" : "SUM(recordConsumedTotal)", "as" : "count" }, { "function" : "SUM(bytesConsumedTotal)", "as" : "bytes" } ] } }, "Url" : { "line_view_config" : { "metric_set" : "user", "filter_prefix" : "clusterId=", "line_view_item_list" : [ { "function" : "SUM(invokeCount)", "as" : "count" }, { "function" : "SUM(totalTime)/SUM(invokeCount)", "as" : "rt" }, { "function" : "SUM(errorCount)", "as" : "errorCount" } ] }, "detail_view_config" : null } }, "real_start_time" : 1667465258000, "real_end_time" : 1667466458000 }

响应示例 状态码： 200 OK，请求响应成功。 { "tx_node_list" : [ { "tx_node_id" : "48", "tx_node_name" : "apm-api:xx-xxxx-xxx-az1", "tx_node_type" : "env", "tx_env_id" : 48 }, { "tx_node_id" : "11.108.243.78:3306:apm2_cmdb", "tx_node_name" : "11.108.243.78:3306:apm2_cmdb", "tx_node_type" : "Mysql", "tx_env_id" : null }, { "tx_node_id" : "user", "tx_node_name" : "user", "tx_node_type" : "user", "tx_env_id" : null }, { "tx_node_id" : "295", "tx_node_name" : "lubanops-api:xx-xxxx-xxx", "tx_node_type" : "env", "tx_env_id" : 295 }, { "tx_node_id" : "11.108.242.168:3306:apm2_region", "tx_node_name" : "11.108.242.168:3306:apm2_region", "tx_node_type" : "Mysql", "tx_env_id" : null }, { "tx_node_id" : "54", "tx_node_name" : "apm-front:xx-xxxx-xxx", "tx_node_type" : "env", "tx_env_id" : 54 }, { "tx_node_id" : "Elasticsearch:11.108.246.171:9200,11.108.246.24:9200,11.108.246.47:9200", "tx_node_name" : "Elasticsearch:11.108.246.171:9200,11.108.246.24:9200,11.108.246.47:9200", "tx_node_type" : "EsRestClient", "tx_env_id" : null } ], "tx_line_list" : [ { "tx_from_node" : "54", "tx_to_node" : "48", "invoke_count" : 364, "rt" : 28.065934065934066, "error_count" : 0, "type" : "HttpClient", "direction" : "out" }, { "tx_from_node" : "48", "tx_to_node" : "Elasticsearch:11.108.246.171:9200,11.108.246.24:9200,11.108.246.47:9200", "invoke_count" : 359, "rt" : 18.08635097493036, "error_count" : 0, "type" : "EsRestClient", "direction" : "out" }, { "tx_from_node" : "295", "tx_to_node" : "54", "invoke_count" : 365, "rt" : 49.87123287671233, "error_count" : 0, "type" : "HttpClient", "direction" : "out" }, { "tx_from_node" : "54", "tx_to_node" : "11.108.242.168:3306:apm2_region", "invoke_count" : 48, "rt" : 2.3541666666666665, "error_count" : 0, "type" : "Mysql", "direction" : "out" }, { "tx_from_node" : "54", "tx_to_node" : "48", "invoke_count" : 359, "rt" : 19.220055710306408, "error_count" : 0, "type" : "Url", "direction" : "in" }, { "tx_from_node" : "user", "tx_to_node" : "295", "invoke_count" : 365, "rt" : 50.92876712328767, "error_count" : 0, "type" : "Url", "direction" : "in" }, { "tx_from_node" : "295", "tx_to_node" : "54", "invoke_count" : 364, "rt" : 29.354395604395606, "error_count" : 0, "type" : "Url", "direction" : "in" }, { "tx_from_node" : "295", "tx_to_node" : "11.108.243.78:3306:apm2_cmdb", "invoke_count" : 58, "rt" : 0.5862068965517241, "error_count" : 0, "type" : "Mysql", "direction" : "out" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tx_node_list Array of TxNode objects 组件节点列表。 tx_line_list Array of TxLine objects 组件之间调用指向线列表。 表4 TxNode 参数 参数类型 描述 tx_node_id String 节点id。 tx_node_name String 节点名称。 tx_node_type String 节点类型。如user、HttpClient(网络节点)、env(环境)、Mysql(数据库节点)等。 tx_env_id Long 环境节点id。 表5 TxLine 参数 参数类型 描述 tx_from_node String 开始节点。 tx_to_node String 结束节点。 invoke_count Long 调用次数。 rt Double 组件间调用耗时，单位毫秒(ms)。 error_count Long 错误数。 type String 目标节点类型。如user、HttpClient(网络节点)、env(环境)、Mysql(数据库节点)等。 direction String 指向。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 x-business-id 是 Long 应用id。 表2 请求Body参数 参数 是否必选 参数类型 描述 tx_name 是 String 事务名称。 start_time 是 String 开始时间的毫秒级戳。 end_time 是 String 结束时间的毫秒级戳。

概述 欢迎使用 应用性能管理 （Application Performance Management，简称 APM ），APM是实时监控并管理云应用性能和故障的云服务，提供专业的分布式应用性能分析能力，可以帮助运维人员快速解决应用在分布式架构下的问题定位和性能瓶颈等难题，为用户体验保驾护航。 您可以使用本文档提供API对应用性能管理进行相关操作，如查询应用列表。 在调用应用性能管理的API之前，请确保已经充分了解应用性能管理的相关概念与功能。 父主题： 使用前必读

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 monitor_item_list Array of MonitorItem objects 监控项列表。 total_count Integer 总数。 total_page Integer 总页数。 表4 MonitorItem 参数 参数类型 描述 id Long 监控项id。 env_id Long 环境id。 collector_id Integer 采集器id。 collector_name String 采集器名称。 display_name String 采集器展示名称。 collect_interval Integer 采集间隔。 disabled Boolean 是否禁用。 status_change_user_id String 最后一次修改监控项启停的用户id。 status_change_user_name String 最后一次修改监控项启停的用户名称。 status_change_time String 最后一次修改监控项启停的日期。 config_change_user_id String 最后一次修改监控项配置的用户id。 config_change_user_name String 最后一次修改监控项配置的用户名称。 config_change_time String 最后一次修改监控项配置的时间。

响应示例 状态码： 200 OK，请求响应成功。 { "monitor_item_list" : [ { "id" : 55150, "env_id" : 913, "collector_id" : 61, "collector_name" : "Thread", "display_name" : "线程", "collect_interval" : 60, "disabled" : false, "status_change_user_id" : null, "status_change_user_name" : null, "status_change_time" : null, "config_change_user_id" : null, "config_change_user_name" : null, "config_change_time" : "2022-05-28 20:35:13" }, { "id" : 10509, "env_id" : 913, "collector_id" : 19, "collector_name" : "KafkaConsumer", "display_name" : "KafkaConsumer监控", "collect_interval" : 60, "disabled" : false, "status_change_user_id" : null, "status_change_user_name" : null, "status_change_time" : null, "config_change_user_id" : null, "config_change_user_name" : null, "config_change_time" : "2021-10-20 15:06:51" } ], "total_count" : 2, "total_page" : 1 }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 access_ak_sk_models Array of AccessAkskVO objects ak/sk模型具体信息。 表3 AccessAkskVO 参数 参数类型 描述 id Integer ak/sk的id。 gmt_create String ak/sk的生成时间。 gmt_modify String ak/sk的修改时间。 inner_domain_id Integer 内部租户id。 ak String 生成的ak。 sk String 生成的sk。 status String ak/sk的状态。 descp String ak/sk的描述信息。 gmt_create_timestamp Integer ak/sk的生成时间戳。 gmt_modify_timestamp Integer ak/sk的修改时间戳。

响应示例 状态码： 200 OK，请求响应成功。 { "access_ak_sk_models" : [ { "ak" : "vca******04j", "sk" : "ktns******6iq6t9m", "status" : "enable", "descp" : "auto create", "id" : 1, "gmt_create" : "2024-02-28 09:42:02", "gmt_modify" : "2024-02-28 09:42:02", "inner_domain_id" : 1, "gmt_create_timestamp" : 1709084522000, "gmt_modify_timestamp" : 1709084522000 } ] }

响应消息 表4 响应参数 参数 是否必选 参数类型 取值范围 描述 error_code M String 16 结果码。 error_msg M String 1024 结果消息。 成功响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "error_code": "92020000", "error_msg": "success" } 失败响应示例 HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time { "error_code": "92020001", "error_msg": "Unauthorized" }

获取访问密钥（AK/SK） IAM用户若希望使用AK/SK访问SFS，必须要账号为其开启“编程访问”。开启方法请参见查看或修改IAM用户信息。 在调用接口的时候，需要使用AK/SK进行签名验证。AK/SK获取步骤如下： 登录控制台。 鼠标指向界面右上角的登录用户名，在下拉列表中单击“我的凭证”。 单击“管理访问密钥”。 在左侧导航栏单击“访问密钥”。 单击“新增访问密钥”，进入“新增访问密钥”页面。 输入描述（可选），单击“确定”。 通过邮箱、手机或者虚拟MFA进行验证，输入对应的验证码。如果没有开启敏感操作保护，请跳过该步骤。 单击“立即下载”，浏览器自动下载访问密钥。 为防止访问密钥泄露，建议您将其保存到安全的位置。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }