文档首页/ 云备份 CBR/ API参考/ API/ 可保护性/ 查询可保护资源 - ListProtectable
更新时间：2026-07-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询可保护资源 - ListProtectable

功能介绍

查询可保护性资源列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

protectable_type

是

String

参数解释：

对象类型

约束限制：

不涉及

取值范围：

  • server： 云服务器类型

  • disk：云硬盘类型

  • turbo：turbo类型

  • workspace：workspace类型

  • workspace_v2：workspace_v2类型

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

根据资源ID过滤

约束限制：

资源类型需要与protectable_type一致

取值范围：

资源ID为UUID

默认取值：

不涉及

limit

否

Integer

参数解释：

每页显示的条目数量

约束限制：

不涉及

取值范围：

1-50

默认取值：

不涉及

marker

否

String

参数解释：

上一次查询最后一条的ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

否

String

参数解释：

按名称过滤

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

offset

否

Integer

参数解释：

查询的偏移值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

server_id

否

String

参数解释：

根据该id过滤属于该服务器的所有磁盘

约束限制：

支持企业多项目的用户才能传入此参数

取值范围：

不涉及

默认取值：

不涉及

status

否

String

参数解释：

资源的状态

约束限制：

不涉及

取值范围：

分为available，error ，protecting，deleting，deleted，restoring状态

-available：可用的资源

-error：发生错误的资源

-protecting：保护中的资源

-deleting：删除中的资源

-deleted：已经删除的资源

-restoring：恢复中的资源

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目ID，获取企业项目ID请参考查询企业项目列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

instances

Array of ProtectablesResp objects

可保护性查询实例
表4 ProtectablesResp

参数

参数类型

描述

children

Array of objects

子资源

detail

Object

资源详情

id

String

参数解释：

资源ID

取值范围：

资源ID为UUID

name

String

名称

protectable

ProtectableResult object

是否可备份

size

Integer

参数解释：

大小，单位GB

取值范围：

不涉及

status

String

参数解释：

资源状态，详细状态请参见资源状态

取值范围：

不涉及

type

String

待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。默认取值不涉及。
表5 ProtectableResult

参数

参数类型

描述

code

String

参数解释：

不支持备份的错误码，详细信息可参考错误码

取值范围：

不涉及

reason

String

不支持备份的原因

result

Boolean

是否可备份

vault

VaultGet object

绑定的存储库

message

String

资源不可备份的原因信息，当资源可保护性检验失败时才有该字段。
表6 VaultGet

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息，不能包含“<”，“>”，最大支持255个字符。

id

String

参数解释：

存储库id，获取方法可参考查询存储库列表

取值范围：

UUID，形式为32个十六进制数字

name

String

存储库名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。

project_id

String

参数解释：

项目ID，获取方法请参见获取项目ID

取值范围：

不涉及

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备份。

resources

Array of ResourceResp objects

资源

tags

Array of Tag objects

存储库标签

enterprise_project_id

String

参数解释：

云备份企业项目ID，获取方法可参考企业管理用户指南

取值范围：

不涉及

auto_bind

Boolean

功能说明：是否支持自动挂载。

取值范围：

  • true：支持自动挂载

  • false：不支持自动挂载

bind_rules

VaultBindRules object

绑定规则

user_id

String

参数解释：

用户id

取值范围：

不涉及

created_at

String

创建时间,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

功能说明：是否开启存储库自动扩容能力（只支持按需存储库），取值范围：true：支持自动扩容；false：不支持自动扩容。

smn_notify

Boolean

功能说明：是否发送smn通知开关。

取值范围：

  • true：发送smn通知

  • false：不发送smn通知

threshold

Integer

功能说明：存储库容量阈值，存储库已用容量和总容量的百分比超过该值，如果smn_notify为开，将发送相关通知。

取值范围：[1, 100]。

sys_lock_source_service

String

用于标识SMB服务，支持传入SMB和空。

SMB：标识为SMB服务调用

空字符串：表示为普通服务调用

locked

Boolean

功能说明：用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。

关于备份锁定的详细信息，请参考"开启备份锁定"。

取值范围：

  • true：锁定存储库

  • false：不锁定存储库

availability_zone

String

存储库可用区信息，最大支持32字符。

updated_at

String

更新时间,例如:"2020-02-05T10:38:34.209782"

version

String

参数解释：

存储库版本

取值范围：

不涉及
表7 Billing

参数

参数类型

描述

allocated

Integer

已分配容量，单位GB。取值范围：10-10485760。

charging_mode

String

功能说明：计费模式。取值范围：post_paid：按需，pre_paid：包年包月

cloud_type

String

云类型，支持类型如下。

public：公有云; hybrid: 混合云

consistent_level

String

功能描述：存储库规格。取值范围：app_consistent: 应用一致性，crash_consistent: 崩溃一致性。

object_type

String

对象类型，支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server：云服务器，disk：云硬盘，turbo：文件系统，workspace：云桌面，vmware：VMware，rds：关系型数据库，file：文件。

order_id

String

订单ID，UUID格式。

product_id

String

产品ID，UUID格式。

protect_type

String

保护类型，取值范围如下：

backup：备份，replication：复制

size

Integer

参数解释：

容量，单位MB

取值范围：

10-10485760

spec_code

String

规格编码，取值范围如下：

云服务备份存储库：vault.backup.server.normal；云硬盘备份存储库：vault.backup.volume.normal；文件备份存储库：vault.backup.turbo.normal

status

String

存储库状态，取值范围如下：

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

storage_unit

String

参数解释：

存储库桶名

取值范围：

不涉及

used

Integer

参数解释：

已使用容量，单位MB

取值范围：

不涉及

frozen_scene

String

冻结场景，取值范围如下：

  • POLICE：公安冻结场景

  • ARREAR：欠费场景

  • ILLEGAL：违规冻结场景

  • VERIFY：客户未实名认证冻结场景

  • DELETE_ACCOUNT：退订删除场景

is_multi_az

Boolean

功能说明：存储库是否具有多AZ属性，即底层备份是否为多AZ备份。

取值范围：

  • true：存储库具有多AZ属性

  • false：存储库不具有多AZ属性
表8 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

参数解释：

待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

取值范围：

取值范围不涉及

name

String

待备份资源名称，长度限制：0-255字符。

protect_status

String

保护状态，取值范围如下：

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

size

Integer

资源已分配容量，单位为GB，取值范围不涉及。

type

String

待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

backup_size

Integer

参数解释：

备份副本大小。单位GB。

取值范围：

不涉及

backup_count

Integer

参数解释：

备份副本数量

取值范围：

不涉及
表9 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

参数解释：

需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷

取值范围：

不涉及
表10 Tag

参数

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，数字，“-”，“_”组成。

value

String

值。

添加标签时value值必选，删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表11 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5
表12 BindRulesTags

参数

参数类型

描述

key

String

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。默认取值不涉及。

key只能由中文，字母，数字，“-”，“_”组成。

value

String

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。默认取值不涉及。

value只能由中文，字母，数字，“-”，“_”，“.”组成。

请求示例

查询可保护资源

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

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

响应示例

状态码：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
    }
  ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 可保护性

相关文档