华为云用户手册

  • 响应参数 状态码: 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}" ] }
  • 响应示例 状态码: 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 } ] }
  • URI GET /v3/{project_id}/protectables/{protectable_type}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID protectable_type 是 String 对象类型 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 根据资源id过滤 limit 否 Integer 每页显示的条目数量,每页最多支持50条 marker 否 String 上一次查询最后一条的ID name 否 String 按名称过滤 offset 否 Integer 偏移值 server_id 否 String 根据该id过滤属于该服务器的所有磁盘,支持企业多项目的用户才能传入此参数 status 否 String 资源的状态,如available,error 等
  • 功能介绍 为指定实例批量添加或删除标签 标签管理服务需要使用该接口批量管理实例的标签。 一个资源上最多有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" }
  • 响应示例 状态码: 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" } }
  • 请求示例 更新组织策略。 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" : "" } }
  • 响应参数 状态码: 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'。
  • 请求参数 表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 策略执行时间规则 表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 { "count" : 1, "operation_logs" : [ { "status" : "success", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6", "updated_at" : "2019-05-23T14:35:23.584+00:00", "error_info" : { "message" : "", "code" : "" }, "started_at" : "2019-05-23T14:31:36.007+00:00", "id" : "4827f2da-b008-4507-ab7d-42d0df5ed912", "extra_info" : { "resource" : { "type" : "OS::Nova::Server", "id" : "1dab32fa-ebf2-415a-ab0b-eabe6353bc86", "name" : "E CS -0001" }, "backup" : { "backup_name" : "manualbk_backup", "backup_id" : "0e5d0ef6-7f0a-4890-b98c-cb12490e31c1" }, "common" : { "progress" : 100, "request_id" : "req-cdb98cc4-e87b-4f40-9b4a-57ec036620bc" } }, "ended_at" : "2019-05-23T14:35:23.511+00:00", "created_at" : "2019-05-23T14:31:36.039+00:00", "operation_type" : "backup", "project_id" : "04f1829c788037ac2fb8c01eb2b04b95" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 operation_logs Array of OperationLog objects 任务列表 count Integer 任务个数 limit Integer 每页显示的条目数量 offset Integer 偏移量,表示从此偏移量开始查询 表5 OperationLog 参数 参数类型 描述 checkpoint_id String 备份记录id created_at String 创建时间,例如: "2020-02-23T01:00:32Z" ended_at String 任务结束时间,例如: "2020-02-23T01:00:32Z" error_info OpErrorInfo object 任务错误信息 extra_info OpExtraInfo object 任务扩展信息 id String 任务id operation_type String 任务类型 backup: 备份 copy: 复制 replication: 跨Region复制 restore: 恢复 delete: 删除 sync: 同步 vault_delete: 删除存储库 remove_resource: 移除资源 policy_id String 策略ID project_id String 项目ID provider_id String 备份提供商ID。用于区分备份对象。 started_at String 任务开始时间,例如: "2020-02-23T01:00:32Z" status String 任务状态 success: 成功 skipped: 跳过 failed: 失败 running: 运行中 timeout: 超时 waiting: 等待中 updated_at String 修改时间,例如: "2020-02-23T01:00:32Z" vault_id String 任务操作资源所属存储库ID vault_name String 任务操作资源所属存储库名称 表6 OpErrorInfo 参数 参数类型 描述 code String 请参见错误码。 message String 错误信息 表7 OpExtraInfo 参数 参数类型 描述 backup OpExtendInfoBckup object 备份扩展参数 common OpExtendInfoCommon object 公共参数 delete OpExtendInfoDelete object 删除扩展参数 sync OpExtendInfoSync object 扩展同步信息 remove_resources OpExtendInfoRemoveResources object 移除Vault的资源 replication OpExtendInfoReplication object 扩展复制信息 resource Resource object 资源信息 restore OpExtendInfoRestore object 扩展恢复信息 vault_delete OpExtendInfoVaultDelete object 删除vault 表8 OpExtendInfoBckup 参数 参数类型 描述 app_consistency_error_code String 应用一致性备份失败错误码。请参见错误码。 app_consistency_error_message String 应用一致性备份错误信息 app_consistency_status String 应用一致性备份状态 0: 非应用一致性 1: 应用一致性备份 backup_id String 备份副本ID backup_name String 备份名称 incremental String 是否增备 "true" "false" 表9 OpExtendInfoCommon 参数 参数类型 描述 progress Integer 进度,取值为0-100 request_id String 请求id task_id String 备份任务id 表10 OpExtendInfoDelete 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 表11 OpExtendInfoSync 参数 参数类型 描述 sync_backup_num Integer 同步备份副本数 delete_backup_num Integer 删除的备份副本数 err_sync_backup_num Integer 同步失败备份副本数 表12 OpExtendInfoRemoveResources 参数 参数类型 描述 fail_count Integer 删除失败的资源数量 total_count Integer 删除的备份数量 resources Array of Resource objects 资源信息 表13 Resource 参数 参数类型 描述 extra_info ResourceExtraInfo object 资源附加信息 id String 待备份资源id name String 待备份资源名称,长度限制:0-255 type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 表14 OpExtendInfoReplication 参数 参数类型 描述 destination_backup_id String 目标副本ID destination_checkpoint_id String 目标还原点ID destination_project_id String 目标project_id destination_region String 目标区域 source_backup_id String 源副本ID source_checkpoint_id String 源还原点ID source_project_id String 源project_id source_region String 源区域 source_backup_name String 源备份名称 destination_backup_name String 目标备份名称 表15 ResourceExtraInfo 参数 参数类型 描述 exclude_volumes Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 表16 OpExtendInfoRestore 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 target_resource_id String 恢复目标资源ID target_resource_name String 恢复目标资源名称 表17 OpExtendInfoVaultDelete 参数 参数类型 描述 fail_count Integer 本次任务删除失败的资源数量 total_count Integer 本次任务删除的备份总数 状态码: 404 表18 响应Body参数 参数 参数类型 描述 operation_logs Array of OperationLog objects 任务列表 count Integer 任务个数 limit Integer 每页显示的条目数量 offset Integer 偏移量,表示从此偏移量开始查询 表19 OperationLog 参数 参数类型 描述 checkpoint_id String 备份记录id created_at String 创建时间,例如: "2020-02-23T01:00:32Z" ended_at String 任务结束时间,例如: "2020-02-23T01:00:32Z" error_info OpErrorInfo object 任务错误信息 extra_info OpExtraInfo object 任务扩展信息 id String 任务id operation_type String 任务类型 backup: 备份 copy: 复制 replication: 跨Region复制 restore: 恢复 delete: 删除 sync: 同步 vault_delete: 删除存储库 remove_resource: 移除资源 policy_id String 策略ID project_id String 项目ID provider_id String 备份提供商ID。用于区分备份对象。 started_at String 任务开始时间,例如: "2020-02-23T01:00:32Z" status String 任务状态 success: 成功 skipped: 跳过 failed: 失败 running: 运行中 timeout: 超时 waiting: 等待中 updated_at String 修改时间,例如: "2020-02-23T01:00:32Z" vault_id String 任务操作资源所属存储库ID vault_name String 任务操作资源所属存储库名称 表20 OpErrorInfo 参数 参数类型 描述 code String 请参见错误码。 message String 错误信息 表21 OpExtraInfo 参数 参数类型 描述 backup OpExtendInfoBckup object 备份扩展参数 common OpExtendInfoCommon object 公共参数 delete OpExtendInfoDelete object 删除扩展参数 sync OpExtendInfoSync object 扩展同步信息 remove_resources OpExtendInfoRemoveResources object 移除Vault的资源 replication OpExtendInfoReplication object 扩展复制信息 resource Resource object 资源信息 restore OpExtendInfoRestore object 扩展恢复信息 vault_delete OpExtendInfoVaultDelete object 删除vault 表22 OpExtendInfoBckup 参数 参数类型 描述 app_consistency_error_code String 应用一致性备份失败错误码。请参见错误码。 app_consistency_error_message String 应用一致性备份错误信息 app_consistency_status String 应用一致性备份状态 0: 非应用一致性 1: 应用一致性备份 backup_id String 备份副本ID backup_name String 备份名称 incremental String 是否增备 "true" "false" 表23 OpExtendInfoCommon 参数 参数类型 描述 progress Integer 进度,取值为0-100 request_id String 请求id task_id String 备份任务id 表24 OpExtendInfoDelete 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 表25 OpExtendInfoSync 参数 参数类型 描述 sync_backup_num Integer 同步备份副本数 delete_backup_num Integer 删除的备份副本数 err_sync_backup_num Integer 同步失败备份副本数 表26 OpExtendInfoRemoveResources 参数 参数类型 描述 fail_count Integer 删除失败的资源数量 total_count Integer 删除的备份数量 resources Array of Resource objects 资源信息 表27 Resource 参数 参数类型 描述 extra_info ResourceExtraInfo object 资源附加信息 id String 待备份资源id name String 待备份资源名称,长度限制:0-255 type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 表28 OpExtendInfoReplication 参数 参数类型 描述 destination_backup_id String 目标副本ID destination_checkpoint_id String 目标还原点ID destination_project_id String 目标project_id destination_region String 目标区域 source_backup_id String 源副本ID source_checkpoint_id String 源还原点ID source_project_id String 源project_id source_region String 源区域 source_backup_name String 源备份名称 destination_backup_name String 目标备份名称 表29 ResourceExtraInfo 参数 参数类型 描述 exclude_volumes Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 表30 OpExtendInfoRestore 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 target_resource_id String 恢复目标资源ID target_resource_name String 恢复目标资源名称 表31 OpExtendInfoVaultDelete 参数 参数类型 描述 fail_count Integer 本次任务删除失败的资源数量 total_count Integer 本次任务删除的备份总数
  • URI GET /v3/{project_id}/operation-logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 end_time 否 String 任务结束时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-02-01T12:00:00Z enterprise_project_id 否 String 企业项目id或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id limit 否 Integer 每页显示的条目数量,正整数,建议显式指定该参数值 offset 否 Integer 偏移值,正整数 operation_type 否 String 任务类型 provider_id 否 String 备份提供商ID resource_id 否 String 该任务操作的资源ID resource_name 否 String 该任务操作的资源名称 start_time 否 String 任务开始时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-01-01T12:00:00Z status 否 String 任务状态 vault_id 否 String 存储库ID,该任务操作的资源所属绑定的存储库。 vault_name 否 String 存储库名称,该任务操作资源所绑定的存储库名称。
  • 响应示例 状态码: 200 OK { "count" : 2, "backups" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99", "updated_at" : "2020-02-21T07:07:25.114+00:00", "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515", "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "supported_restore_mode" : "backup", "contain_system_disk" : true, "support_lld" : true, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "test001-02", "description" : "", "expired_at" : "2020-05-21T07:00:54.060+00:00", "name" : "autobk_b629", "created_at" : "2020-02-21T07:00:54.065+00:00", "resource_type" : "OS::Nova::Server" }, { "provider_id" : "d1603440-187d-4516-af25-121250c7cc97", "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12", "updated_at" : "2020-02-21T07:09:37.767+00:00", "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d", "id" : "5606aab5-2dc2-4498-8144-dc848d099af5", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f", "bootable" : true, "support_lld" : true, "encrypted" : false, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "qsy_000", "description" : "", "expired_at" : "2020-03-22T07:00:34.878+00:00", "name" : "autobk_6809", "created_at" : "2020-02-21T07:00:34.882+00:00", "resource_type" : "OS::Cinder::Volume" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 backups Array of BackupResp objects 备份列表 count Integer 备份个数 offset Integer 偏移量,表示从此偏移量开始查询 limit Integer 每页显示的条目数量 表5 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 备份副本快照类型 表6 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 表7 ImageData 参数 参数类型 描述 image_id String 镜像ID 表8 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 表9 ReplicationRecordsExtraInfo 参数 参数类型 描述 progress Integer 复制进度 fail_code String 失败错误码,成功时为空 fail_reason String 错误原因 auto_trigger Boolean 是否为自动调度复制 destinatio_vault_id String 目标端的存储库id
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_ids 是 Array of strings 要移除的资源ID列表 最小长度:1 最大长度:256
  • 请求示例 移除存储库中的指定资源,并删除该资源在存储库中的备份。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/removeresources { "resource_ids" : [ "97595625-198e-4e4d-879b-9d53f68ba551" ] }
  • 请求示例 创建一个云服务器存储库,存储库容量为100G,按需计费,且同时绑定资源和添加标签。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults { "vault" : { "backup_policy_id" : "6dd81d7d-a4cb-443e-b8ed-1af0bd3a261b", "billing" : { "cloud_type" : "public", "consistent_level" : "crash_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 100, "charging_mode" : "post_paid", "is_auto_renew" : false, "is_auto_pay" : false, "console_url" : "https://console.demo.com/cbr/?agencyId=97fcd896b7914cb98f553a087232e243®ion=testregion/cbr/manager/csbs/vaultList" }, "description" : "vault_description", "name" : "vault_name", "resources" : [ { "extra_info" : { "exclude_volumes" : [ "43a320a5-3efd-4568-b1aa-8dd9183cc64b" ] }, "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "type" : "OS::Nova::Server" } ], "tags" : [ { "key" : "key01", "value" : "value01" } ], "enterprise_project_id" : "0" } } 创建一个云硬盘备份存储库,存储库容量为40G,按需计费。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults { "vault" : { "billing" : { "consistent_level" : "crash_consistent", "object_type" : "disk", "protect_type" : "backup", "size" : 40, "charging_mode" : "post_paid", "is_auto_renew" : false, "is_auto_pay" : false }, "name" : "test", "resources" : [ ] } }
  • 响应示例 状态码: 200 OK { "vault" : { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "description" : "vault_description", "tags" : [ { "value" : "value01", "key" : "key01" } ], "enterprise_project_id" : 0, "auto_bind" : false, "id" : "ad7627ae-5b0b-492e-b6bd-cd809b745197", "user_id" : "38d65be2ecd840d19046e239e841a734", "name" : "vault_name", "billing" : { "status" : "available", "used" : 0, "protect_type" : "backup", "object_type" : "server", "allocated" : 40, "spec_code" : "vault.backup.server.normal", "size" : 100, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "post_paid" }, "created_at" : "2019-05-23T12:51:10.071+00:00", "project_id" : "fc347bc64ccd4589ae52e4f44b7433c7", "resources" : [ { "name" : "ecs-b977-0002", "backup_size" : 0, "protect_status" : "available", "backup_count" : 0, "extra_info" : { "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243", "5a51e8b3-2f65-4045-896f-f8ffae14b064" ] }, "type" : "OS::Nova::Server", "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "size" : 40 } ] } }
  • 请求示例 恢复指定备份数据到虚拟机。 POST https://{endpoint}/v3/{f841e01fd2b14e7fa41b6ae7aa6b0594}/backups/a5200268-74a5-4806-acc6-95793ab0228b/restore { "restore" : { "mappings" : [ { "backup_id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235", "volume_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376" } ], "power_on" : true, "server_id" : "94eba8b2-acc9-4d82-badc-127144cc5526" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 restore 是 BackupRestore object 恢复请求参数体 表4 BackupRestore 参数 是否必选 参数类型 描述 mappings 否 Array of BackupRestoreServerMapping objects 恢复的映射关系(整机恢复时必填,卷恢复时可选但是不会用到填写的值) power_on 否 Boolean 恢复后是否开始,默认开机。 server_id 否 String 恢复的目标虚拟机ID(整机恢复时必填) volume_id 否 String 恢复的目标卷ID(卷恢复时必填) resource_id 否 String 待恢复的目标资源ID details 否 RestoreDetails object 恢复详情 表5 BackupRestoreServerMapping 参数 是否必选 参数类型 描述 backup_id 是 String 卷备份ID,可以通过控制台查看云服务器备份详情中磁盘级备份的ID;或“查询指定备份”接口,获取备份中children内的磁盘级备份的ID。 volume_id 是 String 待恢复目标卷ID 表6 RestoreDetails 参数 是否必选 参数类型 描述 destination_path 是 String 目的路径
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 cloud_service_console_url 否 String 云服务ConsoleURL。订单支付完成后,客户可以通过此URL跳转到云服务Console页面查看信息 product_info 是 CbcProductInfoOrderChange object 产品信息 resource_id 是 String 待变更的资源ID is_auto_pay 否 Boolean 是否自动支付,默认非自动支付:false promotion_info 否 String 购买折扣 表3 CbcProductInfoOrderChange 参数 是否必选 参数类型 描述 product_id 是 String 产品标识,通过订购询价接口获得,长度限制:1-64,只能由字母、数字、“_”、“-”组成。。 resource_size 是 Integer 资源容量大小,取值范围:10-10485760 resource_size_measure_id 否 Integer 资源容量度量标识,枚举值17:GB resource_spec_code 是 String 用户购买云服务产品的资源规格 Enum: [vault.backup.server.normal,vault.backup.turbo.normal, vault.backup.database.normal,vault.backup.volume.normal,vault.backup.rds.normal,vault.replication.server.normal,vault.hybrid.server.normal]
  • 请求示例 变更包周期存储库大小到 50 GB https://{endpoint}/v3/{project_id}/orders/change { "resourceId" : "9dd8f8db-a926-440b-9af5-81b643618898", "productInfo" : { "productId" : "00301-231147-0--0", "resourceSpecCode" : "vault.backup.server.normal", "resourceSize" : 50, "resourceSizeMeasureId" : 17 } }
  • 响应示例 状态码: 200 OK { "agent" : { "created_at" : "2022-01-30T09:28:09.334+00:00", "updated_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "agent_version" : "1.0.0", "agent_type" : "native", "host_name" : "ecs-0001", "host_nickname" : "", "host_ip" : "192.168.10.144", "host_os" : "linux", "status" : "uninstall", "last_active_time" : "2022-01-30T09:28:08.960+00:00", "paths" : [ { "id" : "5684b0fb-44c8-4c70-bb59-b03ec2738360", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/huaweicloud/cbragent/lib", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" }, { "id" : "1ad949d5-c955-4995-8c28-60fc8b110a21", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/backup", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" } ] } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 agent 是 AgentUpdate object 待更新的agent参数 表4 AgentUpdate 参数 是否必选 参数类型 描述 status 是 String 客户端状态,当前只支持卸载,由客户端被卸载时自动触发 uninstall
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 agent Agent object 客户端详情 表6 Agent 参数 参数类型 描述 created_at String 客户端创建时间 updated_at String 客户端更新时间 agent_id String 客户端ID agent_version String 客户端版本号 agent_type String 客户端类型 host_name String 客户端所在的主机名 host_nickname String 客户端所在的主机昵称 host_ip String 客户端所在主机的IP host_os String 客户端主机所在的操作系统 status String 客户端状态 last_active_time String 客户端上次激活时间 paths Array of Path objects 客户端的备份路径 表7 Path 参数 参数类型 描述 id String 路径ID status String 路径状态,有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表,多个路径之间以英文逗号分隔
  • 响应示例 状态码: 200 OK { "operation_log" : { "status" : "success", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6", "updated_at" : "2019-05-23T14:35:23.584+00:00", "error_info" : { "message" : "", "code" : "" }, "started_at" : "2019-05-23T14:31:36.007+00:00", "id" : "4827f2da-b008-4507-ab7d-42d0df5ed912", "extra_info" : { "resource" : { "type" : "OS::Nova::Server", "id" : "1dab32fa-ebf2-415a-ab0b-eabe6353bc86", "name" : "ECS-0001" }, "backup" : { "backup_name" : "manualbk_1234", "backup_id" : "0e5d0ef6-7f0a-4890-b98c-cb12490e31c1" }, "common" : { "progress" : 100, "request_id" : "req-cdb98cc4-e87b-4f40-9b4a-57ec036620bc" } }, "ended_at" : "2019-05-23T14:35:23.511+00:00", "created_at" : "2019-05-23T14:31:36.039+00:00", "operation_type" : "backup", "project_id" : "04f1829c788037ac2fb8c01eb2b04b95" } } 状态码: 404 任务ID不存在 { "error_code" : "BackupService.6500", "error_msg" : "Operation log does not exist." }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 operation_log OperationLog object 任务信息 表4 OperationLog 参数 参数类型 描述 checkpoint_id String 备份记录id created_at String 创建时间,例如: "2020-02-23T01:00:32Z" ended_at String 任务结束时间,例如: "2020-02-23T01:00:32Z" error_info OpErrorInfo object 任务错误信息 extra_info OpExtraInfo object 任务扩展信息 id String 任务id operation_type String 任务类型 backup: 备份 copy: 复制 replication: 跨Region复制 restore: 恢复 delete: 删除 sync: 同步 vault_delete: 删除存储库 remove_resource: 移除资源 policy_id String 策略ID project_id String 项目ID provider_id String 备份提供商ID。用于区分备份对象。 started_at String 任务开始时间,例如: "2020-02-23T01:00:32Z" status String 任务状态 success: 成功 skipped: 跳过 failed: 失败 running: 运行中 timeout: 超时 waiting: 等待中 updated_at String 修改时间,例如: "2020-02-23T01:00:32Z" vault_id String 任务操作资源所属存储库ID vault_name String 任务操作资源所属存储库名称 表5 OpErrorInfo 参数 参数类型 描述 code String 请参见错误码。 message String 错误信息 表6 OpExtraInfo 参数 参数类型 描述 backup OpExtendInfoBckup object 备份扩展参数 common OpExtendInfoCommon object 公共参数 delete OpExtendInfoDelete object 删除扩展参数 sync OpExtendInfoSync object 扩展同步信息 remove_resources OpExtendInfoRemoveResources object 移除Vault的资源 replication OpExtendInfoReplication object 扩展复制信息 resource Resource object 资源信息 restore OpExtendInfoRestore object 扩展恢复信息 vault_delete OpExtendInfoVaultDelete object 删除vault 表7 OpExtendInfoBckup 参数 参数类型 描述 app_consistency_error_code String 应用一致性备份失败错误码。请参见错误码。 app_consistency_error_message String 应用一致性备份错误信息 app_consistency_status String 应用一致性备份状态 0: 非应用一致性 1: 应用一致性备份 backup_id String 备份副本ID backup_name String 备份名称 incremental String 是否增备 "true" "false" 表8 OpExtendInfoCommon 参数 参数类型 描述 progress Integer 进度,取值为0-100 request_id String 请求id task_id String 备份任务id 表9 OpExtendInfoDelete 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 表10 OpExtendInfoSync 参数 参数类型 描述 sync_backup_num Integer 同步备份副本数 delete_backup_num Integer 删除的备份副本数 err_sync_backup_num Integer 同步失败备份副本数 表11 OpExtendInfoRemoveResources 参数 参数类型 描述 fail_count Integer 删除失败的资源数量 total_count Integer 删除的备份数量 resources Array of Resource objects 资源信息 表12 Resource 参数 参数类型 描述 extra_info ResourceExtraInfo object 资源附加信息 id String 待备份资源id name String 待备份资源名称,长度限制:0-255 type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 表13 OpExtendInfoReplication 参数 参数类型 描述 destination_backup_id String 目标副本ID destination_checkpoint_id String 目标还原点ID destination_project_id String 目标project_id destination_region String 目标区域 source_backup_id String 源副本ID source_checkpoint_id String 源还原点ID source_project_id String 源project_id source_region String 源区域 source_backup_name String 源备份名称 destination_backup_name String 目标备份名称 表14 ResourceExtraInfo 参数 参数类型 描述 exclude_volumes Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 表15 OpExtendInfoRestore 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 target_resource_id String 恢复目标资源ID target_resource_name String 恢复目标资源名称 表16 OpExtendInfoVaultDelete 参数 参数类型 描述 fail_count Integer 本次任务删除失败的资源数量 total_count Integer 本次任务删除的备份总数 状态码: 404 表17 响应Body参数 参数 参数类型 描述 error_code String 请参见错误码。 error_msg String 错误信息
  • 请求示例 同步线下混合云VMware备份副本。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/sync { "sync" : [ { "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025", "resource_id" : "96f7512d-239d-3f31-80cf-d1ce041df9a6", "resource_name" : "resource_name", "resource_type" : "OS::Native::Server", "bucket_name" : "1555230361623e4ce4700dab84b7d8169a5eaec05227d", "image_path" : "6abec15e-7baf-4d79-b5a9-6b98a2da7020/cfe0295c-5939-4b31-96cd-161b4725e7ad/cfe0295c-5939-4b31-96cd-161b4725e7ad", "created_at" : 1553587260, "backup_name" : "backup_name" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 sync 是 Array of BackupSync objects 待同步备份副本列表 表4 BackupSync 参数 是否必选 参数类型 描述 backup_id 是 String 备份副本ID backup_name 是 String 备份名称 bucket_name 是 String 桶名 image_path 是 String 备份链在存储单元上的路径 resource_id 是 String 备份对象ID resource_name 是 String 备份对象名称 resource_type 是 String 备份对象资源类型 created_at 是 Integer 备份时间戳,例如1548898428
共100000条