Querying a Specified Protectable Resource
Function
This API is used to query a specified resource that can be protected by its ID.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v3/{project_id}/protectables/{protectable_type}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Resource ID |
project_id |
Yes |
String |
Project ID |
protectable_type |
Yes |
String |
Protection type Enumeration values:
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instance |
ProtectablesResp object |
Resources that can be protected |
Parameter |
Type |
Description |
---|---|---|
children |
Array of objects |
Child resource |
detail |
Object |
Resource details |
id |
String |
id |
name |
String |
Backup name |
protectable |
ProtectableResult object |
Whether backup is supported |
size |
Integer |
Size of the resource, in GB |
status |
String |
Resource status Enumeration values:
|
type |
String |
Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2 |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code returned indicating backup is not supported |
reason |
String |
Reason why backup is not supported |
result |
Boolean |
Whether backup is supported |
vault |
VaultGet object |
Associated vault |
message |
String |
Reason why the resource cannot be backed up. This field is returned only if the resource protectability check fails. |
Parameter |
Type |
Description |
---|---|---|
billing |
Billing object |
Operation info |
description |
String |
User-defined vault description Minimum: 0 Maximum: 255 |
id |
String |
Vault ID |
name |
String |
Vault name Minimum: 1 Maximum: 64 |
project_id |
String |
Project ID |
provider_id |
String |
ID of the vault resource type |
resources |
Array of ResourceResp objects |
Resource |
tags |
Array of Tag objects |
Vault tags |
enterprise_project_id |
String |
Enterprise project ID. Its default value is 0. |
auto_bind |
Boolean |
Indicates whether automatic association is enabled. Its default value is false (not enabled). |
bind_rules |
VaultBindRules object |
Association rule |
user_id |
String |
User ID |
created_at |
String |
Creation time, for example, 2020-02-05T10:38:34.209782 |
auto_expand |
Boolean |
Whether to enable auto capacity expansion for the vault. Only pay-per-use vaults support auto capacity expansion. |
smn_notify |
Boolean |
Exception notification function Default: true |
threshold |
Integer |
Vault capacity threshold. If the vault capacity usage exceeds this threshold, an exception notification is sent. Minimum: 1 Maximum: 100 Default: 80 |
sys_lock_source_service |
String |
Used to identify the SMB service. You can set it to SMB or leave it empty. Minimum: 0 Maximum: 32 Enumeration values:
|
updated_at |
String |
Update time, for example, 2020-02-05T10:38:34.209782 |
version |
String |
Version |
Parameter |
Type |
Description |
---|---|---|
allocated |
Integer |
Allocated capacity, in GB. |
charging_mode |
String |
Billing mode, which can be post_paid (pay-per-use) or pre_paid (yearly/monthly). The default value is post_paid. |
cloud_type |
String |
Cloud type, which can be public or hybrid |
consistent_level |
String |
Vault specification, which can be crash_consistent (crash consistent backup) or app_consistent (application consistency backup) |
object_type |
String |
Object type, which can be server, disk, turbo, workspace, vmware, rds, or file |
order_id |
String |
Order ID |
product_id |
String |
Product ID |
protect_type |
String |
Protection type, which can be backup or replication |
size |
Integer |
Capacity, in GB Minimum: 1 Maximum: 10485760 |
spec_code |
String |
Specification codeServer backup vault: vault.backup.server.normal; Disk backup vault: vault.backup.volume.normal; File system backup vault: vault.backup.turbo.normal |
status |
String |
Vault status Enumeration values:
|
storage_unit |
String |
Name of the bucket for the vault |
used |
Integer |
Used capacity, in MB. |
frozen_scene |
String |
Scenario when an account is frozen |
is_multi_az |
Boolean |
Multi-AZ attribute of a vault Default: false |
Parameter |
Type |
Description |
---|---|---|
extra_info |
ResourceExtraInfo object |
Extra information of the resource |
id |
String |
ID of the resource to be backed up |
name |
String |
Name of the resource to be backed up Minimum: 0 Maximum: 255 |
protect_status |
String |
Protection status Enumeration values:
|
size |
Integer |
Allocated capacity for the associated resource, in GB |
type |
String |
Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2 |
backup_size |
Integer |
Backup size |
backup_count |
Integer |
Number of backups |
Parameter |
Type |
Description |
---|---|---|
exclude_volumes |
Array of strings |
IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key It can contain a maximum of 36 characters. It cannot be an empty string. Spaces before and after a key will be discarded. It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/ It can contain only letters, digits, hyphens (-), and underscores (_). |
value |
String |
Value It is mandatory when a tag is added and optional when a tag is deleted. It can contain a maximum of 43 characters. It can be an empty string. Spaces before and after a value will be discarded. It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/ It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). |
Parameter |
Type |
Description |
---|---|---|
tags |
Array of BindRulesTags objects |
Filters automatically associated resources by tag. Minimum length: 0 characters Maximum length: 5 characters Array Length: 0 - 5 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/ The key can contain only letters, digits, hyphens (-), and underscores (_). |
value |
String |
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/ The value can contain only letters, digits, periods (.), hyphens (-), and underscores (_). |
Example Requests
Querying a specified protectable resource
GET https://{endpoint}/v3/{project_id}/protectables/{protectable_type}/instances/{instance_id}
Example Responses
Status code: 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 } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot