Updated on 2024-04-18 GMT+08:00

Querying Disk Information

Function

This API is used to query information about disks monitored by a host.

Call Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/disk
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

cluster_id

No

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

instance_name

No

String

Instance name

instance_id

No

String

Instance ID

limit

Yes

Integer

Number of data records. The value ranges from 1 to 2147483647.

offset

Yes

Integer

Data offset. Value range: 0 to 2147483646.

Request Parameters

None

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

[Array]

Array of DiskResp objects

List of disks on a host

Table 4 DiskResp

Parameter

Type

Description

instance_name

String

Instance name

instance_id

String

Instance ID

host_name

String

Host name

disk_name

String

Disk name

disk_type

String

Disk type (system disk, data disk, or log disk)

total

double

Total disk capacity (GB)

used

double

Used disk capacity (GB)

available

double

Available disk capacity (GB)

used_percentage

double

Disk Usage (%)

await

double

I/O wait time (ms)

svctm

double

I/O service time (ms)

util

double

I/O usage (%)

read_rate

double

Disk read rate (KB/s)

write_rate

double

Disk write rate (KB/s)

Example Request

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/disk?limit=1&offset=0

Example Response

[
  {
    "instance_name": "d30035376-dms-test07-dws-cn-cn-1-1",
    "instance_id": "1",
    "host_name": "host-172-16-11-62",
    "disk_name": "vda",
    "disk_type": "system",
    "total": 49,
    "used": 5.64,
    "available": 40.99,
    "used_percentage": 11.51,
    "await": 0.21,
    "svctm": 0.03,
    "util": 0.01,
    "read_rate": 0,
    "write_rate": 52.72
  }
]

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListHostDiskSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListHostDiskRequest request = new ListHostDiskRequest();
        request.withClusterId("<cluster_id>");
        request.withInstanceId("<instance_id>");
        request.withInstanceName("<instance_name>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListHostDiskResponse response = client.listHostDisk(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListHostDiskRequest()
        request.cluster_id = "<cluster_id>"
        request.instance_id = "<instance_id>"
        request.instance_name = "<instance_name>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_host_disk(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListHostDiskRequest{}
	clusterIdRequest:= "<cluster_id>"
	request.ClusterId = &clusterIdRequest
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	instanceNameRequest:= "<instance_name>"
	request.InstanceName = &instanceNameRequest
	request.Limit = int32(<limit>)
	request.Offset = int32(<offset>)
	response, err := client.ListHostDisk(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The disk information is queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.