华为云用户手册

  • 响应参数 状态码: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版本号
  • 请求示例 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/members/f841e01fd2b14e7fa41b6ae7aa6b0594 { "status" : "accepted", "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0" }
  • 响应示例 状态码:200 OK { "member" : { "status" : "accepted", "backup_id" : "17c9acd8-3af3-4401-bab9-ff1cfac15561", "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0", "dest_project_id" : "0761021b8900d2622f38c0115db0b331", "created_at" : "2020-02-24T09:36:00.479+00:00", "id" : "824a90b3-c562-448b-ab04-60ea4a97cf60" } }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 member Member object 查询备份共享成员详情响应信息 表5 Member 参数 参数类型 描述 status String 共享状态 pending: 等待处理 accepted: 已接收 rejected: 已拒绝 created_at String 共享时间,例如:"2020-02-05T10:38:34.209782" updated_at String 更新时间,例如:"2020-02-05T10:38:34.209782" backup_id String 备份副本id image_id String 接受的共享备份副本注册的镜像id dest_project_id String 接受备份共享的项目id vault_id String 目标端接受共享备份的存储库id id String 共享记录id
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 status 是 String 备份共享状态 accepted: 已接收 pending: 处理中 rejected: 已拒绝 vault_id 否 String 共享的备份将存入的存储库,仅支持uuid 更新member状态的时候,如果是接受,必须传入vault_id,如果是拒绝,则无需
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 policy OrganizationPolicy object 组织策略详情 表4 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 组织策略所属账号 表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 { "policy" : { "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" } }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 member Member object 查询备份共享成员详情响应信息 表4 Member 参数 参数类型 描述 status String 共享状态 pending: 等待处理 accepted: 已接收 rejected: 已拒绝 created_at String 共享时间,例如:"2020-02-05T10:38:34.209782" updated_at String 更新时间,例如:"2020-02-05T10:38:34.209782" backup_id String 备份副本id image_id String 接受的共享备份副本注册的镜像id dest_project_id String 接受备份共享的项目id vault_id String 目标端接受共享备份的存储库id id String 共享记录id
  • 响应示例 状态码:200 OK { "member" : { "status" : "accepted", "backup_id" : "17c9acd8-3af3-4401-bab9-ff1cfac15561", "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0", "dest_project_id" : "0761021b8900d2622f38c0115db0b331", "created_at" : "2020-02-24T09:36:00.479+00:00", "id" : "824a90b3-c562-448b-ab04-60ea4a97cf60" } }
  • 请求示例 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/addresources { "resources" : [ { "extra_info" : { "exclude_volumes" : [ "bdef09bb-293f-446a-88a4-86e9f14408c4" ] }, "id" : "97595625-198e-4e4d-879b-9d53f68ba551", "type" : "OS::Nova::Server" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of ResourceCreate objects 资源列表 最小长度:1 最大长度:256 表4 ResourceCreate 参数 是否必选 参数类型 描述 extra_info 否 ResourceExtraInfo object 资源附加信息 id 是 String 待备份资源id type 是 String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 name 否 String 名称 表5 ResourceExtraInfo 参数 是否必选 参数类型 描述 exclude_volumes 否 Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。
  • 响应示例 状态码:200 OK { "replication" : { "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "destination_region" : "region2", "source_region" : "region1", "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "replication_record_id" : "1579a71e-8d8d-41e6-85dc-d77f5ce8d91a" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 replicate 是 BackupReplicateReqBody object 复制参数 表4 BackupReplicateReqBody 参数 是否必选 参数类型 描述 description 否 String 复制的描述 destination_project_id 是 String 复制的目标项目ID destination_region 是 String 复制的目标区域 destination_vault_id 是 String 复制的目标区域的存储库ID enable_acceleration 否 Boolean 跨区域复制时,是否启用加速从而缩短复制的时间,如果不指定,默认不启用加速。 name 否 String 复制名称
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 replication BackupReplicateRespBody object 复制返回参数 表6 BackupReplicateRespBody 参数 参数类型 描述 backup_id String 待复制的备份ID destination_project_id String 复制的目标项目ID destination_region String 复制的目标区域 destination_vault_id String 复制的目标区域存储库ID project_id String 执行复制的项目ID provider_id String 资源类型id replication_record_id String 复制记录ID source_region String 复制的源区域
  • 请求示例 复制一个备份从源备份存储库到目标备份存储库。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/replicate { "replicate" : { "description" : "backup_description", "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "destination_region" : "region2", "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "enable_acceleration" : false, "name" : "backup_name" } }
  • 响应示例 状态码:200 OK { "instance" : { "status" : "ACTIVE", "children" : [ { "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 }, { "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 } ], "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, "addr" : "192.168.1.44", "OS-EXT-IPS:type" : "fixed" }, { "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af", "version" : 4, "addr" : "100.78.0.199", "OS-EXT-IPS:type" : "floating" } ] }, "links" : [ { "href" : "https://compute.region1.com/v2.1/3aec9116a6a5487ca14987121d2818fe/servers/55ecd8b8-1457-4a2a-a9df-53756a690082", "rel" : "self" }, { "href" : "https://compute.region1.com/3aec9116a6a5487ca14987121d2818fe/servers/55ecd8b8-1457-4a2a-a9df-53756a690082", "rel" : "bookmark" } ], "image" : "", "OS-EXT-STS:vm_state" : "active", "OS-EXT-SRV-ATTR:instance_name" : "instance-0004456e", "OS-SRV-USG:launched_at" : "2019-05-08T06:55:38.000+00:00", "flavor" : { "id" : "s3.small.1", "links" : [ { "href" : "https://compute.region1.com/3aec9116a6a5487ca14987121d2818fe/flavors/s3.small.1", "rel" : "bookmark" } ] }, "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "security_groups" : [ { "name" : "default" } ], "user_id" : "f3d66502790d4ddaadef5056059ed8f4", "OS-DCF:diskConfig" : "MANUAL", "accessIPv4" : "", "accessIPv6" : "", "progress" : 0, "OS-EXT-STS:power_state" : 1, "OS-EXT-AZ:availability_zone" : "AZ1", "config_drive" : "", "status" : "ACTIVE", "updated" : "2019-05-08T06:57:02.000+00:00", "hostId" : "179f22cafe6b951921bd6deb3b13a978df620427fb37bbb7c619de98", "OS-EXT-SRV-ATTR:host" : "AZ1.xxxxxx", "OS-EXT-SRV-ATTR:hypervisor_hostname" : "nova003@36", "name" : "no_delete_for_cbr_interface", "created" : "2019-05-08T06:55:22.000+00:00", "tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "os-extended-volumes:volumes_attached" : [ { "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99" }, { "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a" } ], "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 } }, "type" : "OS::Nova::Server", "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "size" : 50 } }
  • 请求示例 设置存储库资源自动备份 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/2b076f26-391f-40fa-bf71-a798940faccf/set_resource { "resource_ids" : [ "2b076f26-391f-40fa-bf71-a798940facbb", "dfx76f26-391f-40fa-bf71-a798940facaa" ], "action" : "suspend" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 regions Array of ProtectableReplicationCapabilitiesRespRegion objects 支持复制的区域列表 表4 ProtectableReplicationCapabilitiesRespRegion 参数 参数类型 描述 name String 云服务所在的区域 replication_destinations Array of strings 支持复制的目标区域列表
  • 响应参数 状态码:200 表1 响应Body参数 参数 参数类型 描述 projects Array of ProjectsListInfo objects 项目信息 links SelfLinksInfo object 连接地址 表2 ProjectsListInfo 参数 参数类型 描述 domain_id String 域 ID is_domain Boolean 是否是域级 parent_id String 父项目 ID name String 名称 description String 描述信息 id String 项目ID enabled Boolean 是否开启 links SelfLinksInfo object 连接地址 表3 SelfLinksInfo 参数 参数类型 描述 self String 连接地址
  • 响应示例 状态码:200 OK { "projects" : [ { "description" : "", "domain_id" : "5ba348512fd541c3a57c9bb2196108f8", "enabled" : true, "id" : "45a3afcc926f47d08b9375694b062193", "is_domain" : false, "links" : { "self" : "https://iam.huaweicloud.com:31943/v3/projects/45a3afcc926f47d08b9375694b062193" }, "name" : "cn-hk1_yyx2", "parent_id" : "" }, { "description" : "", "domain_id" : "5ba348512fd541c3a57c9bb2196108f8", "enabled" : true, "id" : "438fe051ccb04aeabc0c8112a276a0dc", "is_domain" : false, "links" : { "self" : "https://iam.huaweicloud.com:31943/v3/projects/438fe051ccb04aeabc0c8112a276a0dc" }, "name" : "cn-xianhz-1", "parent_id" : "" } ], "links" : { "self" : "https://iam.huaweicloud.com:31943/v3/auth/projects" } }
  • 响应示例 状态码:200 OK { "checkpoint" : { "status" : "available", "created_at" : "2019-05-10T07:59:12.037+00:00", "vault" : { "id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "resources" : [ { "name" : "ecs-1f0f-0002", "resource_size" : 40, "protect_status" : "available", "type" : "OS::Nova::Server", "id" : "94eba8b2-acc9-4d82-badc-127144cc5526" } ], "name" : "vault-be94" }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664" } }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 checkpoint CheckpointCreate object 还原点信息 表4 CheckpointCreate 参数 参数类型 描述 created_at String 创建时间,例如:"2020-02-05T10:38:34.209782" id String 还原点ID project_id String 项目ID status String 状态 available: 可用 deleting: 删除中 protecting: 保护中 deleted: 已删除 error-deleting:删除异常 error: 异常 vault CheckpointPlanCreate object 存储库信息 extra_info CheckpointExtraInfoResp object 扩展信息 表5 CheckpointPlanCreate 参数 参数类型 描述 id String 存储库id name String 存储库名称 resources Array of CheckpointResourceResp objects 备份对象 skipped_resources Array of CheckpointCreateSkippedResource objects 备份时跳过的资源列表 表6 CheckpointResourceResp 参数 参数类型 描述 extra_info String 资源附加信息 id String 待备份资源id name String 待备份资源名称 protect_status String 保护状态 available: 可用 error: 异常 protecting: 保护中 restoring: 恢复中 removing: 删除中 resource_size String 资源已分配容量,单位为GB type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 backup_size String 副本大小 backup_count String 副本数量 表7 CheckpointCreateSkippedResource 参数 参数类型 描述 id String 资源ID type String 资源类型 name String 资源名称 code String 请参见错误码。 reason String 跳过原因,例如:该资源正在备份中。 表8 CheckpointExtraInfoResp 参数 参数类型 描述 name String 备份名称 description String 备份描述 retention_duration Integer 备份保留天数
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 policies Array of OrganizationPolicyStatus objects 组织策略部署状态列表 count Integer 组织策略状态成员数量 limit Integer 每页显示的条目数量 offset Integer 偏移量,表示从此偏移量开始查询 表4 OrganizationPolicyStatus 参数 参数类型 描述 policy_id String 策略ID domain_id String 账号ID project_id String 项目ID status String 状态
  • 请求示例 查询组织策略每个账号下策略部署状态列表。 GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail
  • 响应示例 状态码:200 OK { "policies" : [ { "policy_id" : "680032b4-493f-4486-81ab-1d068c92da6b", "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60", "project_id" : "ab994a04599c4c46a1e946c328b55ee2", "status" : "available", "error_msg" : null }, { "policy_id" : "556d25b7-f3c7-4f61-a096-be74bb797056", "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60", "project_id" : "c5a1f68f1c664c9189c2cc2956138b9a", "status" : "available", "error_msg" : null } ], "count" : 2, "limit" : 1000, "offset" : 0 }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 members Array of Member objects 添加备份共享成员响应信息 count Integer 备份共享成员数量 表5 Member 参数 参数类型 描述 status String 共享状态 pending: 等待处理 accepted: 已接收 rejected: 已拒绝 created_at String 共享时间,例如:"2020-02-05T10:38:34.209782" updated_at String 更新时间,例如:"2020-02-05T10:38:34.209782" backup_id String 备份副本id image_id String 接受的共享备份副本注册的镜像id dest_project_id String 接受备份共享的项目id vault_id String 目标端接受共享备份的存储库id id String 共享记录id
  • 响应示例 状态码:200 OK { "members" : [ { "status" : "pending", "backup_id" : "0b07081e-3ec7-4e77-8571-54e2947da422", "dest_project_id" : "075e6035d300d48c2fd0c00b78b71ebf", "created_at" : "2020-02-05T10:38:34.210+00:00", "id" : "3c5a3015-c3a0-4dc6-a1e2-917b90f62319" } ], "count" : 50 }
  • 响应参数 状态码:200 表2 响应Body参数 参数 参数类型 描述 backup_id String 备份ID backups String 云服务器备份信息 flavor String 云服务器规格信息 floatingips Array of strings 云服务器浮动IP信息 interface String 云服务器接口信息 ports Array of strings 云服务器端口信息 server String 云服务器信息 volumes Array of strings 云服务器卷信息
  • 响应示例 状态码:200 OK { "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "backups" : "{\"provider_id\": \"0daac4c5-6707-4851-97ba-169e36266b66\", \"checkpoint_id\": \"8b0851a8-adf3-4f4c-a914-dead08bf9664\", \"updated_at\": null, \"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\": [], \"parent_id\": null, \"extend_info\": {\"auto_trigger\": true, \"supported_restore_mode\": \"backup\", \"os_images_data\": null, \"contain_system_disk\": true, \"snapshot_id\": null, \"bootable\": null, \"progress\": null, \"support_lld\": true, \"app_consistency\": {\"app_consistency_error_code\": \"0\", \"app_consistency_status\": \"0\", \"app_consistency_error_message\": \"\", \"app_consistency\": \"0\"}}, \"project_id\": \"4229d7a45436489f8c3dc2b1d35d4987\", \"status\": \"available\", \"resource_name\": \"ecs-1f0f-0002\", \"description\": \"backup_description\", \"expired_at\": null, \"replication_records\": [], \"name\": \"backup_name\", \"created_at\": \"2019-05-10T07:59:12.084695\", \"protected_at\": null, \"resource_type\": \"OS::Nova::Server\"}", "server" : "{\"server\":{\"tags\":[\"key_01\",\"key_02\"],\"progress\":0,\"links\":[{\"rel\":\"self\",\"href\":\"https://compute.region.dc1.domainname.com/v2.1/4229d7a45436489f8c3dc2b1d35d4987/servers/94eba8b2-acc9-4d82-badc-127144cc5526\"},{\"rel\":\"bookmark\",\"href\":\"https://compute.region.dc1.domainname.com/4229d7a45436489f8c3dc2b1d35d4987/servers/94eba8b2-acc9-4d82-badc-127144cc5526\"}],\"id\":\"94eba8b2-acc9-4d82-badc-127144cc5526\",\"name\":\"ecs-1f0f-0002\",\"status\":\"ACTIVE\",\"OS-EXT-STS:vm_state\":\"active\",\"OS-EXT-STS:power_state\":1,\"OS-EXT-STS:task_state\":null,\"flavor\":{\"links\":[{\"rel\":\"bookmark\",\"href\":\"https://compute.region.dc1.domainname.com/4229d7a45436489f8c3dc2b1d35d4987/flavors/s2.small.1\"}],\"id\":\"s2.small.1\"},\"accessIPv4\":\"\",\"accessIPv6\":\"\",\"image\":\"\",\"OS-EXT-SRV-ATTR:hostname\":\"ecs-1f0f-0002\",\"OS-EXT-SRV-ATTR:host\":\"az1.dc1\",\"tenant_id\":\"4229d7a45436489f8c3dc2b1d35d4987\",\"user_id\":\"38d65be2ecd840d19046e239e841a734\",\"OS-EXT-AZ:availability_zone\":\"az1.dc1\",\"OS-EXT-SRV-ATTR:hypervisor_hostname\":\"nova001@248\",\"OS-EXT-SRV-ATTR:launch_index\":0,\"OS-EXT-SRV-ATTR:user_data\":\"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQ2OUNsYVckUFNka1pZa2RicGFsTFJGRnNLejhJVGp4eUlLSjNya1M3UURaMlRmT0J3Nk9ndUVhRm8xdGh MRS 43aWpvc3RFZTlzVkYuQjBGNm1UQURxZEhWbTkxTDEnIHwgY2hwYXNzd2QgLWU7\",\"OS-SRV-USG:launched_at\":\"2019-05-08T08:53:07.000000\",\"OS-SRV-USG:terminated_at\":null,\"config_drive\":\"\",\"created\":\"2019-05-08T08:52:22Z\",\"description\":\"\",\"key_name\":null,\"locked\":false,\"updated\":\"2019-05-08T08:53:12Z\",\"metadata\":{\"charging_mode\":\"0\",\"image_name\":\"Public CentOS 7.6 64bit for Test\",\"metering.cloudServiceType\":\"hws.service.type.ec2\",\"metering.image_id\":\"79bee4ee-0025-4645-b004-23d2a66f6eec\",\"metering.imagetype\":\"gold\",\"metering.resourcespeccode\":\"s2.small.1.linux\",\"metering.resourcetype\":\"1\",\"os_bit\":\"64\",\"os_type\":\"Linux\",\"vpc_id\":\"df963ec6-561c-4c69-9787-0456a55f8fd0\"},\"hostId\":\"bfced2732a5c5f974a1882616828d31d32c0d79964d26b1f3d8694e3\",\"OS-EXT-SRV-ATTR:kernel_id\":\"\",\"OS-EXT-SRV-ATTR:ramdisk_id\":\"\",\"OS-EXT-SRV-ATTR:root_device_name\":\"/dev/vda\",\"os-extended-volumes:volumes_attached\":[{\"id\":\"eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\",\"delete_on_termination\":true}],\"OS-DCF:diskConfig\":\"MANUAL\",\"security_groups\":[{\"name\":\"sg-a924\"}],\"OS-EXT-SRV-ATTR:reservation_id\":\"r-y43be5p0\",\"addresses\":{\"df963ec6-561c-4c69-9787-0456a55f8fd0\":[{\"OS-EXT-IPS-MAC:mac_addr\":\"fa:16:3e:ef:d5:fb\",\"version\":4,\"addr\":\"192.168.1.128\",\"OS-EXT-IPS:type\":\"fixed\"},{\"OS-EXT-IPS-MAC:mac_addr\":\"fa:16:3e:ef:d5:fb\",\"version\":4,\"addr\":\"100.64.1.29\",\"OS-EXT-IPS:type\":\"floating\"}]},\"host_status\":\"UP\",\"OS-EXT-SRV-ATTR:instance_name\":\"instance-00260179\"}}", "volumes" : [ "{\"volume\":{\"attachments\":[{\"attached_at\":\"2019-05-08T08:52:48.810938\",\"attachment_id\":\"8cbc141a-9403-48e2-9323-6c05683e7e50\",\"device\":\"/dev/vda\",\"host_name\":null,\"id\":\"eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\",\"server_id\":\"94eba8b2-acc9-4d82-badc-127144cc5526\",\"volume_id\":\"eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\"}],\"availability_zone\":\"az1.dc1\",\"backup_id\":null,\"bootable\":\"true\",\"consistencygroup_id\":null,\"created_at\":\"2019-05-08T08:52:26.824375\",\"dedicated_storage_id\":null,\"dedicated_storage_name\":null,\"description\":\"\",\"encrypted\":false,\"enterprise_project_id\":\"0\",\"id\":\"eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\",\"lifecycle\":0,\"links\":[{\"href\":\"https://evs.cn-north-1.myhuaweicloud.com/v2/4229d7a45436489f8c3dc2b1d35d4987/os-vendor-volumes/eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\",\"rel\":\"self\"},{\"href\":\"https://evs.cn-north-1.myhuaweicloud.com/4229d7a45436489f8c3dc2b1d35d4987/os-vendor-volumes/eccbcfdd-f843-4bbb-b2c0-a5ce861f9376\",\"rel\":\"bookmark\"}],\"metadata\":{\"__openstack_region_name\":\"az1.dc1\",\"__system__volume_name\":\"ecs-1f0f-0002\",\"attached_mode\":\"rw\",\"readonly\":\"False\"},\"migration_status\":null,\"multiattach\":false,\"name\":\"ecs-1f0f-0002\",\"os-vol-host-attr:host\":\"az1.dc1#2\",\"os-vol-mig-status-attr:migstat\":null,\"os-vol-mig-status-attr:name_id\":null,\"os-vol-tenant-attr:tenant_id\":\"4229d7a45436489f8c3dc2b1d35d4987\",\"os-volume-replication:extended_status\":null,\"plan_delete_at\":null,\"pre_deleted_at\":null,\"provider_location\":\"{\"storage_type\": \"FC_DSWARE\", \"vol_name\": \"eccbcfddf8434bbbb2c0a5ce861f9376\", \"offset\": 4, \"ip\": \"192.144.44.120\", \"urn\": \"urn:sites:4D760908:volumes:3975388\", \"uri\": \"/service/sites/4D760908/volumes/3975388\", \"pool\": \"2\"}\",\"replication_status\":\"disabled\",\"restored_from_recycle_bin_at\":null,\"service_type\":\"EVS\",\"shareable\":false,\"size\":40,\"snapshot_id\":null,\"source_volid\":null,\"status\":\"in-use\",\"storage_cluster_id\":\"0\",\"sys_tags\":{\"_sys_enterprise_project_id\":\"0\"},\"tags\":{},\"updated_at\":\"2019-05-10T03:52:41.053912\",\"user_id\":\"38d65be2ecd840d19046e239e841a734\",\"volume_image_metadata\":{\"__account_code\":\"\",\"__backup_id\":\"\",\"__data_origin\":\"\",\"__description\":\"\",\"__image_location\":\"192.149.48.66:443:pcsimssouthchina:79bee4ee-0025-4645-b004-23d2a66f6eec\",\"__image_size\":\"647303168\",\"__image_source_type\":\"uds\",\"__imagetype\":\"gold\",\"__isregistered\":\"true\",\"__lazyloading\":\"true\",\"__originalimagename\":\"79bee4ee-0025-4645-b004-23d2a66f6eec\",\"__os_bit\":\"64\",\"__os_type\":\"Linux\",\"__os_version\":\"CentOS 7.6 64bit\",\"__platform\":\"CentOS\",\"__productcode\":\"\",\"__support_kvm\":\"true\",\"__support_xen\":\"true\",\"checksum\":\"99914b932bd37a50b983c5e7c90ae93b\",\"container_format\":\"bare\",\"disk_format\":\"zvhd2\",\"image_id\":\"79bee4ee-0025-4645-b004-23d2a66f6eec\",\"image_name\":\"Public CentOS 7.6 64bit for Test\",\"min_disk\":\"40\",\"min_ram\":\"0\",\"size\":\"2\",\"virtual_env_type\":\"FusionCompute\"},\"volume_qos_specs\":null,\"volume_type\":\"SATA\"}}" ], "interface" : "{\"interfaceAttachments\": [{\"port_state\": \"ACTIVE\", \"fixed_ips\": [{\"subnet_id\": \"63b881a8-daf0-45b1-90d8-e0c01a9e5275\", \"ip_address\": \"192.168.1.128\"}], \"port_id\": \"76a45e6e-8f02-4de2-9358-0110280ed000\", \"net_id\": \"0756f84d-03b3-44a0-95d8-c1ac70058f9d\", \"mac_addr\": \"fa:16:3e:ef:d5:fb\"}]}", "flavor" : "{\"flavor\": {\"name\": \"s2.small.1\", \"links\": [{\"href\": \"https://compute.Region.dc1.domainname.com/v2/4229d7a45436489f8c3dc2b1d35d4987/flavors/s2.small.1\", \"rel\": \"self\"}, {\"href\": \"https://compute.Region.dc1.domainname.com/4229d7a45436489f8c3dc2b1d35d4987/flavors/s2.small.1\", \"rel\": \"bookmark\"}], \"ram\": 1024, \"OS-FLV-DISABLED:disabled\": false, \"vcpus\": 1, \"swap\": \"\", \"os-flavor-access:is_public\": true, \"rxtx_factor\": 1.0, \"OS-FLV-EXT-DATA:ephemeral\": 0, \"disk\": 0, \"id\": \"s2.small.1\"}}", "ports" : [ "{\"port\":{\"id\":\"76a45e6e-8f02-4de2-9358-0110280ed000\",\"name\":\"\",\"admin_state_up\":true,\"status\":\"ACTIVE\",\"network_id\":\"0756f84d-03b3-44a0-95d8-c1ac70058f9d\",\"tenant_id\":\"4229d7a45436489f8c3dc2b1d35d4987\",\"project_id\":\"4229d7a45436489f8c3dc2b1d35d4987\",\"device_id\":\"94eba8b2-acc9-4d82-badc-127144cc5526\",\"mac_address\":\"fa:16:3e:ef:d5:fb\",\"device_owner\":\"compute:az1.dc1\",\"description\":\"\",\"created_at\":\"2019-05-08T08:52:25\",\"updated_at\":\"2019-05-08T08:52:25\",\"port_security_enabled\":true,\"tags\":[],\"security_groups\":[\"a27d2564-b40c-41ec-9eb6-6eca3ff5aeee\"],\"allowed_address_pairs\":[],\"extra_dhcp_opts\":[],\"fixed_ips\":[{\"subnet_id\":\"63b881a8-daf0-45b1-90d8-e0c01a9e5275\",\"ip_address\":\"192.168.1.128\"}],\"dns_assignment\":[{\"ip_address\":\"192.168.1.128\",\"hostname\":\"ip-192-168-1-128\",\"fqdn\":\"ip-192-168-1-128.southchina.compute.internal.\"}],\"qos_policy_id\":null,\"dns_name\":\"ip-192-168-1-128\",\"dns_domain\":\"southchina.compute.internal.\",\"instance_id\":\"\",\"instance_type\":\"\",\"ecs_flavor\":\"\",\"binding:host_id\":\"az1.dc1\",\"binding:vif_type\":\"cascading\",\"binding:vnic_type\":\"normal\",\"binding:vif_details\":{\"primary_interface\":true},\"binding:profile\":{}}}" ], "floatingips" : [ "{\"floatingips\":null}" ] }
  • 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 等
共99354条