文档首页> 云硬盘 EVS> API参考 (巴黎区域)> API> 云硬盘标签管理> 通过标签查询云硬盘资源实例详情
更新时间:2024-03-25 GMT+08:00

通过标签查询云硬盘资源实例详情

功能介绍

通过标签查询云硬盘资源实例详情。

接口约束

URI

  • URI格式

    POST /v2/{project_id}/os-vendor-volumes/resource_instances/action

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

请求消息

  • 请求参数

    参数

    参数类型

    是否必选

    描述

    tags

    Array of objects

    标签的键值对,请参见•resource_tag参数数据结构说明

    标签列表中最多包含10个key 。

    标签列表中的标签key值不允许重复。

    标签列表中多个key之间是“与”的关系,云硬盘必须满足请求中所有key才会匹配出来。

    说明:

    如果存在多个tags结构体,以最后一个tags结构体为准,之前的会被覆盖。

    limit

    Integer

    查询记录数。

    最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。

    offset

    Integer

    索引位置。

    最小值0,默认为0。

    返回的结果中第一条记录为符合查询条件的第“offset值+1”条记录。

    action

    String

    操作标识。

    根据标签查询云硬盘实例详情时使用“filter”。

    matches

    Array of objects

    资源本身支持的查询条件,请参见•match参数数据结构说明

    标签列表中的标签key值不允许重复。

  • resource_tag参数数据结构说明

    参数

    参数类型

    是否必选

    描述

    key

    String

    标签键。

    values

    Array of objects

    标签值。

    • 标签列表中最多包含10个value。
    • 标签列表中的标签value值不允许重复。
    • 标签列表如果为空列表,表示匹配任意值。标签列表中多个value之间是“或”的关系,在key已经满足要求的前提下,云硬盘满足请求中的某个value就会匹配出来。
  • match参数数据结构说明

    参数

    参数类型

    是否必选

    描述

    key

    String

    键。枚举值。

    key取值范围为:

    • resource_name:资源名称。
    • service_type:服务类型。

    value

    String

    值。

    • 最大长度255个字符。
    • key为“resource_name”时,value为模糊匹配。
  • 请求样例
    {
        "offset": "100", 
        "limit": "100", 
        "action": "filter", 
        "tags": [
            {
                "key": "key1", 
                "values": [
                    "value1", 
                    "value2"
                ]
            }
        ], 
        "matches": [
            {
                "key": "resource_name", 
                "value": "resource1"
            }, 
            {
                "key": "service_type", 
                "value": "EVS"
            }
        ]
    }

响应消息

  • 响应参数

    参数

    参数类型

    描述

    total_count

    Integer

    符合查询条件的云硬盘资源个数

    resources

    List<resource>

    符合查询条件的资源列表,请参见•resource参数数据结构说明

    error

    Object

    出现错误时,返回的错误信息,具体请参见•error参数说明

  • resource参数数据结构说明

    参数

    参数类型

    描述

    resource_id

    String

    资源ID

    resource_name

    String

    资源名称

    resource_detail

    object

    资源详情

    tags

    Array of Map<String,String> objects

    标签列表。

  • VolumeDetailForTag 参数数据结构说明

    参数

    参数类型

    描述

    id

    String

    云硬盘的ID

    links

    Array of Objects

    云硬盘URI自描述信息,请参见•Link 参数数据结构说明

    name

    String

    云硬盘名称

    status

    String

    云硬盘状态,请参见云硬盘状态

    attachments

    Array of Objects

    云硬盘的挂载信息,请参见•Attachment 参数数据结构说明

    availability_zone

    String

    云硬盘所属的AZ信息

    os-vol-host-attr:host

    String

    预留属性

    source_volid

    String

    源云硬盘ID,如果是从源云硬盘创建,则有值

    当前云硬盘服务不支持该字段。

    snapshot_id

    String

    快照ID,如果是从快照创建,则有值。

    description

    String

    云硬盘描述。

    created_at

    String

    云硬盘创建时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    os-vol-tenant-attr:tenant_id

    String

    云硬盘所属的租户ID。租户ID就是项目ID。

    volume_image_metadata

    Map<String,Object>

    云硬盘镜像的元数据。

    说明:

    说明:

    volume_type

    String

    云硬盘类型。

    size

    Integer

    云硬盘大小,单位为GB。

    consistencygroup_id

    String

    预留属性。

    bootable

    String

    是否为启动云硬盘。 true:表示为启动云硬盘。 false:表示为非启动云硬盘。

    metadata

    Object

    云硬盘的元数据。请参见•VolumeMetadata 参数数据结构说明

    updated_at

    String

    云硬盘更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    encrypted

    Boolean

    当前云硬盘服务不支持该字段。

    replication_status

    String

    预留属性。

    os-volume-replication:extended_status

    String

    预留属性。

    os-vol-mig-status-attr:migstat

    String

    预留属性。

    os-vol-mig-status-attr:name_id

    String

    预留属性。

    shareable

    Boolean

    是否为共享云硬盘。true为共享盘,false为普通云硬盘。 该字段已经废弃,请使用multiattach。

    user_id

    String

    预留属性。

    service_type

    String

    服务类型,结果为EVS、DSS、DESS。

    multiattach

    Boolean

    是否为共享云硬盘。

    dedicated_storage_id

    String

    云硬盘所属的专属存储池ID。

    dedicated_storage_name

    String

    云硬盘所属的专属存储池的名称。

    tags

    Map<String,String>

    云硬盘的标签。 如果云硬盘有标签,则会有该字段,否则该字段为空。

    wwn

    String

    云硬盘挂载时的唯一标识。

    enterprise_project_id

    String

    云硬盘上绑定的企业项目ID。

    说明:

    说明:

  • Link 参数数据结构说明

    参数

    参数类型

    描述

    href

    String

    对应的快捷链接。

    rel

    String

    快捷链接标记名称。

  • Attachment 参数数据结构说明

    参数

    参数类型

    描述

    attached_at

    String

    挂载的时间信息。

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    attachment_id

    String

    挂载信息对应的ID。

    device

    String

    挂载点。

    host_name

    String

    云硬盘挂载到的云服务器对应的物理主机的名称。

    id

    String

    挂载的资源ID。

    server_id

    String

    云硬盘挂载到的云服务器的 ID。

    volume_id

    String

    云硬盘ID。

  • VolumeMetadata 参数数据结构说明

    参数

    参数类型

    描述

    __system__cmkid

    String

    metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。

    说明:

    __system__encrypted

    String

    metadata中的表示加密功能的字段,0代表不加密,1代表加密。 不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。

    full_clone

    String

    从快照创建云硬盘时的创建方式。

    • 0表示使用链接克隆方式。
    • 1表示使用全量克隆方式。

    hw:passthrough

    String

    • true表示云硬盘的设备类型为SCSI类型,即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。
    • false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型,即为默认类型,VBD只能支持简单的SCSI读写命令。
    • 该字段不存在时,云硬盘默认为VBD类型。
  • error参数说明

    参数

    参数类型

    描述

    message

    String

    出现错误时,返回的错误消息。

    code

    String

    出现错误时,返回的错误码。

    错误码和其对应的含义请参考错误码

  • 响应样例
    {
    	"total_count": 1,
    	"resources": [{
    		"resource_name": "resource1",
    		"resource_detail": {
    			"attachments": [{
    				"server_id": "2080869e-ba46-4ea5-b45e-3191ac0f1d54",
    				"attachment_id": "1335f039-7a42-4d1e-be49-ac584db0ba0b",
    				"attached_at": "2019-08-06T07:00:21.842812",
    				"host_name": null,
    				"volume_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
    				"device": "/dev/vda",
    				"id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
    			}],
    			"links": [{
    				"href": "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
    				"rel": "self"
    			},
    			{
    				"href": "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
    				"rel": "bookmark"
    			}],
    			"availability_zone": "kvmxen.dc1",
    			"os-vol-host-attr:host": "az21.dc1#2",
    			"encrypted": false,
    			"dedicated_storage_id": null,
    			"enterprise_project_id": "0",
    			"updated_at": "2019-08-09T06:19:35.874737",
    			"os-volume-replication:extended_status": null,
    			"replication_status": "disabled",
    			"snapshot_id": null,
    			"id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
    			"size": 40,
    			"user_id": "75f26e17348643bfb7718578b04635c2",
    			"os-vol-tenant-attr:tenant_id": "051375756c80d5eb2ff0c014498645fb",
    			"service_type": "EVS",
    			"os-vol-mig-status-attr:migstat": null,
    			"metadata": {
    				
    			},
    			"status": "in-use",
    			"volume_image_metadata": {
    				"size": "0",
    				"__quick_start": "False",
    				"container_format": "bare",
    				"min_ram": "0",
    				"image_name": "test-hua-centos7.3-0725",
    				"image_id": "c6c153a6-dde8-4bac-8e40-3d7619436934",
    				"__os_type": "Linux",
    				"min_disk": "20",
    				"__support_kvm": "true",
    				"virtual_env_type": "FusionCompute",
    				"__description": "",
    				"__os_version": "CentOS 7.3 64bit",
    				"__os_bit": "64",
    				"__image_source_type": "uds",
    				"__support_xen": "true",
    				"file_format": "zvhd2",
    				"checksum": "d41d8cd98f00b204e9800998ecf8427e",
    				"__imagetype": "gold",
    				"disk_format": "zvhd2",
    				"__image_cache_type": "Not_Cache",
    				"__isregistered": "true",
    				"__image_location": "192.168.46.200:5443:pcsimsregion:c6c153a6-dde8-4bac-8e40-3d7619436934",
    				"__image_size": "911269888",
    				"__platform": "CentOS"
    			},
    			"description": "",
    			"multiattach": false,
    			"source_volid": null,
    			"consistencygroup_id": null,
    			"os-vol-mig-status-attr:name_id": null,
    			"name": "resource1",
    			"bootable": "true",
    			"created_at": "2019-08-06T06:59:03.056682",
    			"volume_type": "SAS",
    			"shareable": false,
    			"dedicated_storage_name": null
    		},
    		"tags": [{
    			"key": "key1",
    			"value": "value1"
    		},
    		{
    			"key": "key1",
    			"value": "value2"
    		}],
    		"resource_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
    	}]
    }

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    其中error是泛指的错误,有badRequest、itemNotFound等,如报错:

    {
        "computeFault": {
            "message": "The server has either erred or is incapable of performing the requested operation.", 
            "code": 500
        }
    }

状态码

  • 正常

    200

错误码

请参考错误码