计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ 云备份 CBR/ API参考/ API/ 标签/ 查询存储库资源实例

查询存储库资源实例

更新时间:2025-02-13 GMT+08:00

功能介绍

使用标签过滤实例

标签管理服务需要提供按标签过滤各服务实例并汇总显示在列表中,需要各服务提供查询能力

URI

POST /v3/{project_id}/vault/resource_instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。

tags

Array of TagsReq objects

包含标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

tags中多个key之间是“与”的关系。

结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。

无过滤条件时返回全量数据。

tags_any

Array of TagsReq objects

包含任一标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

结果返回包含任一标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。

无过滤条件时返回全量数据。

not_tags

Array of TagsReq objects

不包含标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

结果返回不包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。

无过滤条件时返回全量数据。

not_tags_any

Array of TagsReq objects

不包含任一标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

结果返回不包含任一标签的资源列表,key之间是或的关系,key-value结构张value是或的关系。

无过滤条件时返回全量数据。

sys_tags

Array of SysTags objects

仅op_service权限可以使用此字段做资源实例过滤条件。

目前TMS调用时只包含一个tag结构体。

  • key: _sys_enterprise_project_id
  • values:企业项目id列表

目前TMS调用时,key下面只包含一个value,0表示默认企业项目。

sys_tags和租户标签过滤条件(tags、tags_any、not_tags、not_tags_any)不能同时使用。

无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。

sys_tags不能为空列表

limit

String

查询记录数(action为count时无此参数)如果action为filter时,默认为1000,limit最小值为1,limit最大值为1000, 不在范围内报错。返回的结果中记录数不超过limit。

offset

String

索引位置(action为count时无此参数)如果action为filter时,默认为0,offset最小值为0。返回的结果中第一条记录为符合查询条件的第offset+1条记录。

action

String

操作标识取值范围为:"filter", "count"。如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可

matches

Array of Match objects

资源本身支持的查询条件。

matches中key不允许重复。

数组长度最大值为 1,后续再扩展。

cloud_type

String

云类型

  • public: 公有云
  • hybrid: 混合云

object_type

String

资源类型

  • server: 云服务器
  • disk: 云硬盘
表3 TagsReq

参数

是否必选

参数类型

描述

key

String

键。

最大长度127个unicode字符。

不允许为空字符串。

前后的空格会被丢弃。

values

Array of strings

值列表。

values中最多包含10个value。

每个value最大长度255个unicode字符。前后的空格会被丢弃。

values中value不允许重复。

values中多个value之间是"或"的关系。

values允许为空列表,value允许为空字符串。

values如果为空列表,表示任意值。

*为系统保留字符,如果value是以*开头表示按照*后面的值全模糊匹配,不能只传入“*”。

表4 SysTags

参数

是否必选

参数类型

描述

key

String

键。

系统标签的key,从白名单中取,不能随意定义。

目前仅支持 _sys_enterprise_project_id字段,对应 的value为企业项目ID。

values

Array of strings

值列表。

目前仅会用到企业项目ID,其中默 认的企业项目ID为“0”。

表5 Match

参数

是否必选

参数类型

描述

key

String

键。

key取值范围为:"resource_name",资源名称

value

String

值。

最大长度255个字符。

key为"resource_name"时,value为空字符串时精确匹配,为非空字符串时模糊匹配。

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

resources

Array of TagResource objects

符合查询条件的资源列表(action为count时无此参数)。

total_count

Integer

符合查询条件的资源总个数

表7 TagResource

参数

参数类型

描述

resource_id

String

资源ID

resource_detail

InstancesResourceDetail object

资源详情

tags

Array of Tag objects

标签列表

没有标签默认为空数字。

resource_name

String

资源名称

sys_tags

Array of SysTag objects

仅op_service权限才可以获取此字段:

目前只包含一个resource_tag 结构体。

key:_sys_enterprise_project_id

value:企业项目id,0表示默认企业项目

非op_service场景不能返回此字段。

表8 InstancesResourceDetail

参数

参数类型

描述

vault

Vault object

存储库

表9 Vault

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息。

id

String

存储库ID

name

String

存储库名称

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消息通知开关

threshold

Integer

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

sys_lock_source_service

String

用于标识SMB服务,您可以设置为SMB或者空

locked

Boolean

用于标识当前存储库是否已锁定,锁定的存储库不支持解锁。

表10 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

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

冻结场景

is_multi_az

Boolean

存储库多az属性

表11 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称

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

副本数量

表12 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

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

表13 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度:0

最大长度:5

表14 BindRulesTags

参数

参数类型

描述

key

String

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

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

value

String

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

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

表15 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只能由中文,字母,数字,“-”,“_”,“.”组成。

表16 SysTag

参数

参数类型

描述

key

String

键。

系统标签的key,从白名单中取,不能随意定义。

目前仅支持 _sys_enterprise_project_id字段,对应 的value为企业项目ID。

value

String

值。

目前仅会用到企业项目ID,其中默认的企业项目ID为“0”。

状态码:400

表17 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码

error_msg

String

错误信息

请求示例

使用标签分页查询存储库资源实例。

POST   https://{endpoint}/v3/{project_id}/vault/resource_instances/action

{
  "tags" : [ {
    "key" : "string",
    "values" : [ "value" ]
  } ],
  "action" : "filter"
}

响应示例

状态码:200

OK

{
  "total_count" : 7,
  "resources" : [ {
    "resource_id" : "e54f7854-8de8-4f98-acf1-65f330bfe877",
    "resource_name" : "vault-7698-api-test",
    "resource_detail" : {
      "vault" : {
        "id" : "e54f7854-8de8-4f98-acf1-65f330bfe877",
        "name" : "vault-7698-api-test",
        "resources" : [ ],
        "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
        "created_at" : "2023-04-21T08:20:43.022+00:00",
        "project_id" : "667230ba418f48f1996329f174693053",
        "enterprise_project_id" : 0,
        "auto_bind" : false,
        "bind_rules" : { },
        "auto_expand" : false,
        "smn_notify" : true,
        "threshold" : 80,
        "user_id" : "0ae13f012b80d2d81f11c0129285d34b",
        "billing" : {
          "allocated" : 0,
          "cloud_type" : "public",
          "consistent_level" : "crash_consistent",
          "charging_mode" : "pre_paid",
          "order_id" : "CS23042116192E6CZ",
          "product_id" : "00301-231151-0--0",
          "protect_type" : "backup",
          "object_type" : "server",
          "spec_code" : "vault.backup.server.normal",
          "used" : 0,
          "status" : "available",
          "size" : 100
        },
        "tags" : [ ]
      }
    },
    "tags" : [ ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容