Esta página ainda não está disponível no idioma selecionado. Estamos trabalhando para adicionar mais opções de idiomas. Agradecemos sua compreensão.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Details About All Disks

Updated on 2022-02-22 GMT+08:00

Function

This API is used to query details about all disks.

URI

  • URI format

    GET /v2/{project_id}/cloudvolumes/detail

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    For details about how to obtain the project ID, see Obtaining a Project ID.

  • Request filter parameters

    Parameter

    Type

    Mandatory

    Description

    marker

    String

    No

    Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one.

    name

    String

    No

    Specifies the disk name. The value can contain a maximum of 255 bytes.

    status

    String

    No

    Specifies the disk status. For details, see EVS Disk Status.

    limit

    Integer

    No

    Specifies the maximum number of query results that can be returned.

    The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.

    availability_zone

    String

    No

    Specifies the AZ.

    sort_key

    String

    No

    Specifies the keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at.

    sort_dir

    String

    No

    Specifies the result sorting order. The default value is desc.
    • desc: indicates the descending order.
    • asc: indicates the ascending order.

Request

The following example shows how to query the disks in the available state.
  • Example request
    GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?status=available

Response

  • Parameter description

    Parameter

    Type

    Description

    volumes

    Array of objects

    Specifies the list of queried disks. For details, see Parameters in the volumes field.

    error

    Object

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the volumes field

    Parameter

    Type

    Description

    id

    String

    Specifies the disk ID.

    links

    Array of objects

    Specifies the disk URI. For details, see Parameters in the links field.

    name

    String

    Specifies the disk name.

    status

    String

    Specifies the disk status. For details, see EVS Disk Status.

    attachments

    Array of objects

    Specifies the disk attachment information. For details, see Parameters in the attachments field.

    availability_zone

    String

    Specifies the AZ to which the disk belongs.

    source_volid

    String

    Specifies the source disk ID. This parameter has a value if the disk is created from a source disk.

    Currently, this field is not supported by EVS.

    snapshot_id

    String

    Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot.

    description

    String

    Specifies the disk description.

    os-vol-tenant-attr:tenant_id

    String

    Specifies the ID of the tenant to which the disk belongs. The tenant ID is actually the project ID.

    volume_image_metadata

    Object

    Specifies the metadata of the disk image.

    NOTE:

    For details about volume_image_metadata, see Querying Image Details in the Image Management Service API Reference.

    created_at

    String

    Specifies the time when the disk was created.

    Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    volume_type

    String

    Specifies the disk type.

    Currently, only SSD and SAS are supported.
    • SSD: specifies the ultra-high I/O disk type.
    • SAS: specifies the high I/O disk type.

    size

    Integer

    Specifies the disk size, in GB.

    bootable

    String

    Specifies whether the disk is bootable.
    • true: specifies a bootable disk.
    • false: specifies a non-bootable disk.

    metadata

    Object

    Specifies the disk metadata. For details, see Parameters in the metadata field.

    If metadata does not contain the hw:passthrough field, the disk device type is VBD.

    os-vol-host-attr:host

    String

    Reserved field

    shareable

    String

    Specifies whether the disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    multiattach

    Boolean

    Specifies whether the disk is shareable.
    • true: specifies a shared disk.
    • false: specifies a non-shared disk.
  • Parameters in the links field

    Parameter

    Type

    Description

    href

    String

    Specifies the corresponding shortcut link.

    rel

    String

    Specifies the shortcut link marker name.

  • Parameters in the attachments field

    Parameter

    Type

    Description

    server_id

    String

    Specifies the ID of the server to which the disk is attached.

    attachment_id

    String

    Specifies the ID of the attachment information.

    attached_at

    String

    Specifies the time when the disk was attached.

    Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    host_name

    String

    Specifies the name of the physical host accommodating the server to which the disk is attached.

    volume_id

    String

    Specifies the disk ID.

    device

    String

    Specifies the device name.

    id

    String

    Specifies the ID of the attached resource.

  • Parameters in the metadata field

    Parameter

    Type

    Description

    full_clone

    String

    Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    Specifies the error message returned when an error occurs.

    code

    String

    Specifies the error code returned when an error occurs.

    For details about the error code, see Error Codes.

  • Example response
    {
        "volumes": [
            {
                "id": "c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "test_volume", 
                "status": "available", 
                "attachments": [ ], 
                "description": null, 
                "size": 100, 
                "metadata": null, 
                "bootable": "false", 
                "availability_zone": "az-dc-1", 
                "os-vol-host-attr:host": "az-dc-1#sata", 
                "source_volid": null, 
                "snapshot_id": null, 
                "created_at": "2015-09-17T06:37:16.275659", 
                "volume_type": "SATA", 
                "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e", 
                "volume_image_metadata": null
            }, 
            {
                "id": "a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "test_volume", 
                "status": "available", 
                "attachments": [ ], 
                "description": null, 
                "size": 100, 
                "metadata": null, 
                "bootable": "false", 
                "availability_zone": "az-dc-1", 
                "os-vol-host-attr:host": "az-dc-1#sata", 
                "source_volid": null, 
                "snapshot_id": null, 
                "created_at": "2015-09-17T06:37:16.192556", 
                "volume_type": "SATA", 
                "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e", 
                "volume_image_metadata": null
            }
        ]
    }

    or

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

Status Codes

  • Normal

    200

Error Codes

For details, see Error Codes.

Usamos cookies para aprimorar nosso site e sua experiência. Ao continuar a navegar em nosso site, você aceita nossa política de cookies. Saiba mais

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback