Querying Protectable Resources

Function

Protection

URI

GET /v3/{project_id}/protectables/{protectable_type}/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Protection
protectable_type	Yes	String	Object type Enumeration values: server disk

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	Filters by resource ID.
limit	No	Integer	Number of records displayed per page. A maximum of 50 records can be displayed on each page.
marker	No	String	ID of the last record displayed on the previous page
name	No	String	Filters by resource name.
offset	No	Integer	Offset value
server_id	No	String	Filters all disks that belong to the server based on the server ID. This parameter is mandatory only for users who have enabled enterprise multi-project.
status	No	String	Resource status

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instances	Array of ProtectablesResp objects	Instance of querying protectable resources

**Table 4** ProtectablesResp
Parameter	Type	Description
children	Array of objects	Child resource
detail	Object	Resource details
id	String	id
name	String	Resource name
protectable	ProtectableResult object	Whether backup is supported
size	Integer	Size of the resource, in GB
status	String	Resource status Enumeration values: active deleted error
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, or OS::Sfs::Turbo

**Table 5** ProtectableResult
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

**Table 6** VaultGet
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 TagsResp objects	Tag
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.
updated_at	String	Update time, for example, 2020-02-05T10:38:34.209782
version	String	Version

**Table 7** Billing
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, or turbo
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 code Server 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: available lock frozen deleting error
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

**Table 8** ResourceResp
Parameter	Type	Description
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: available error protecting restoring removing
size	Integer	Allocated capacity for the associated resources, 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, or OS::Sfs::Turbo
backup_size	Integer	Backup size
backup_count	Integer	Number of backups

**Table 9** TagsResp
Parameter	Type	Description
key	String	Key It consists of up to 36 characters. It cannot be an empty string. It can contain only Chinese characters, letters, digits, hyphens, and underscores.
values	String	List of values It consists of up to 43 characters. It can be an empty string. It can contain only Chinese characters, letters, digits, hyphens, and underscores.

**Table 10** VaultBindRules
Parameter	Type	Description
tags	Array of Tag objects	Filters automatically associated resources by tag.

**Table 11** Tag
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 the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/) It can contain only Chinese characters, 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 the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/) It can contain only Chinese characters, letters, digits, hyphens (-), underscores (_), and periods (.).

Example Requests

GET  https://{endpoint}/v3/{project_id}/protectables/{protectable_type}/instances

Example Responses

Status code: 200

{
  "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",
          "host_name" : null,
          "attached_at" : "2019-05-08T06:55:26.563986",
          "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.855484",
        "replication_status" : "disabled",
        "snapshot_id" : null,
        "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a",
        "size" : 40,
        "user_id" : "3204777a731c4ebea330350c04f41b92",
        "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
        "os-vol-mig-status-attr:migstat" : null,
        "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" : ""
        },
        "description" : null,
        "multiattach" : false,
        "source_volid" : null,
        "consistencygroup_id" : null,
        "os-vol-mig-status-attr:name_id" : null,
        "name" : "no_delete_for_cbr_interface-volume-0000",
        "bootable" : "true",
        "created_at" : "2019-05-08T06:54:58.477749",
        "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",
          "host_name" : null,
          "attached_at" : "2019-05-08T06:56:25.891730",
          "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.207240",
        "replication_status" : "disabled",
        "snapshot_id" : null,
        "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
        "size" : 10,
        "user_id" : "f3d66502790d4ddaadef5056059ed8f4",
        "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
        "os-vol-mig-status-attr:migstat" : null,
        "metadata" : {
          "policy" : "cf3274fc-d23e-4c12-8be7-1e41b3c2faea",
          "readonly" : "False",
          "attached_mode" : "rw"
        },
        "status" : "in-use",
        "description" : null,
        "multiattach" : false,
        "source_volid" : null,
        "consistencygroup_id" : null,
        "os-vol-mig-status-attr:name_id" : null,
        "name" : "volume-f926-0001",
        "bootable" : "false",
        "created_at" : "2019-03-26T09:30:46.783578",
        "volume_type" : "SATA",
        "shareable" : false
      },
      "children" : [ ],
      "type" : "OS::Cinder::Volume",
      "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99",
      "size" : 10
    } ],
    "protectable" : {
      "vault" : null,
      "reason" : "",
      "code" : "",
      "result" : true
    },
    "name" : "no_delete_for_cbr_interface",
    "detail" : {
      "OS-EXT-STS:task_state" : null,
      "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:02Z",
      "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.000000",
      "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-SRV-USG:terminated_at" : null,
      "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,
        "bootIndex" : null
      } ],
      "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" : [ ],
      "key_name" : null,
      "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:22Z",
      "tenant_id" : "3aec9116a6a5487ca14987121d2818fe",
      "host_status" : "UP",
      "config_drive" : ""
    },
    "type" : "OS::Nova::Server",
    "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082",
    "size" : 50
  } ]
}