DescribeDiskMonitorData

1. API Description

This API is used to query disk performance metrics over a specified period.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

diskId

Yes

String

Disk ID.

metricType

Yes

Disk performance metric types.

startTime

Yes

String

Start time.

Format: yyyy-MM-ddTHH:mm:ssZ.

endTime

Yes

String

End time.

Format: yyyy-MM-ddTHH:mm:ssZ.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

metrics

Array of MetricValue

Information on performance metrics.

avgValue

Float

Average value.

minValue

Float

Minimum value.

maxValue

Float

Maximum value.

4. Code Example

Query disk performance metric of DISK_UTIL over a specified period.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeDiskMonitorData
<Common Request Params>

Request:
{
    "diskId": "< diskId >",
    "metricType": "DISK_UTIL",
    "startTime": "2025-06-25T01:55:00Z",
    "endTime": "2025-06-25T07:55:00Z"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "maxValue": 1.2,
    "minValue": 1.2,
    "avgValue": 1.2,
    "metrics": [
      {
        "time": "2023-07-11T08:05:00Z",
        "value": 1.2
      }
    ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated