华为云计算 云知识 查询可保护资源ListProtectable
查询可保护资源ListProtectable

 

功能介绍

查询可保护性资源列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

protectable_type

String

对象类型

枚举值:

  • server

  • disk

表2 Query参数

参数

是否必选

参数类型

描述

id

String

根据资源id过滤

limit

Integer

每页显示的条目数量,每页最多支持50条

marker

String

上一次查询最后一条的ID

name

String

按名称过滤

offset

Integer

偏移值

server_id

String

根据该id过滤属于该服务器的所有磁盘,支持企业多项目的用户才能传入此参数

status

String

资源的状态,如available,error 等

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

instances

Array of ProtectablesResp objects

可保护性查询实例

表4 ProtectablesResp

参数

参数类型

描述

children

Array of objects

子资源

detail

Object

资源详情

id

String

id

name

String

名称

protectable

ProtectableResult object

是否可备份

size

Integer

大小,单位GB

status

String

资源状态

枚举值:

  • active

  • deleted

  • error

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::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

存储库自定义描述信息。

最小长度:0

最大长度:255

id

String

存储库ID

name

String

存储库名称

最小长度:1

最大长度:64

project_id

String

项目ID

provider_id

String

存储库资源类型id

resources

Array of ResourceResp objects

资源

tags

Array of Tag objects

存储库标签

enterprise_project_id

String

企业项目id,默认为‘0’。

auto_bind

Boolean

是否自动绑定,默认为false,不支持。

bind_rules

VaultBindRules object

绑定规则

user_id

String

用户id

created_at

String

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

auto_expand

Boolean

是否开启存储库自动扩容能力(只支持按需存储库)。

smn_notify

Boolean

存储库smn 消息通知 开关

缺省值:true

threshold

Integer

存储库容量阈值,已用容量占总容量达到此百分比即发送相关通知

最小值:1

最大值:100

缺省值:80

updated_at

String

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

version

String

版本

表7 Billing

参数

参数类型

描述

allocated

Integer

已分配容量,单位GB

charging_mode

String

创建模式,按需:post_paid,包周期:pre_paid,默认为post_paid

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

规格,崩溃一致性(crash_consistent)或应用一致性(app_consistent)

object_type

String

对象类型: 云服务器 (server), 云硬盘 (disk),文件系统(turbo), 云桌面 (workspace),VMware(vmware),关系型 数据库 (rds),文件(file)。

order_id

String

订单ID

product_id

String

产品ID

protect_type

String

保护类型:备份(backup)、复制(replication)。

size

Integer

容量,单位GB

最小值:1

最大值: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

冻结场景

表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::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2

backup_size

Integer

副本大小

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

数组长度: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

响应示例

状态码: 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",
          "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" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDok
NiQ5c1FaeXIkdnk5N1pGYXg5WUpRTUpPRElGdGdjYnovTUdEZ1dad3E4VTM1dWE4MjQxTmtDTG1
GRjJUUm1BdnZSQnNCLy93VER0aFVRNUt0Z1p6dUlrenp2NmQwYTAnIHwgY2hwYXNzd2QgLWU7", "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 } ] }

状态码

状态码

描述

200

OK

错误码

请参见错误码

 

上一篇:查询所有备份ListBackups 下一篇:CloudIDE

虚拟私有云 VPC 资源

虚拟私有云 VPC 资源

隔离的、私密的虚拟网络环境,基于VPC构建独立的云上网络空间,实现与Internet、云内私网、跨云私网互通

隔离的、私密的虚拟网络环境,基于VPC构建独立的云上网络空间,实现与Internet、云内私网、跨云私网互通