Query Monitoring Metric Data Set - QueryMetricDataSet
Overview
Query Monitoring Metrics Dataset
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is QueryMetricDataSet. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See Region and Zone List | Yes |
| ProjectId | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList API | Yes |
| ProductKey | string | Resource Type | Yes |
| StartTime | int | Start Time | Yes |
| EndTime | int | Deadline | Yes |
| MetricInfos.N.Metric | string | Metric Name | Yes |
| MetricInfos.N.ResourceId | string | Metric's associated resource id | Yes |
| TagList.N.TagKey | string | The key of the Tag of the metric to be queried | No |
| TagValues.N | string | To query the Value of the Tag of the metric | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| TraceId | string | Log Link ID | No |
| Data | QueryMetricDataResp | QueryMetricDataResp | No |
Data Model
QueryMetricDataResp
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| List | array[QueryMetricDataRespItem] | Query Result Set | No |
QueryMetricDataRespItem
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| Metric | string | Metric Name | No |
| Tags | object | All tag keys and corresponding value arrays of the metric query results. The format of Tags is, the key is the tagkey string, and the value is an array of tagValue strings. | No |
| Results | array[MetricResult] | No |
MetricResult
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| ResourceId | string | UUID of the resource | No |
| TagMap | object | TagMap is an object, both key and value are strings. TagMap returns the key and value of all tags of the current series. | No |
| Values | array[MetricSample] | No |
MetricSample
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| Timestamp | float | timestamp | No |
| Value | float | Sample Value | No |
Example
Request Example
https://api.surfercloud.com/?Action=QueryMetricDataSet
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=lBXDBARv
&ProductKey=YoLcjjOJ
&StartTime=2
&EndTime=1
&MetricInfos.N.Metric=wBhLvIzA
&MetricInfos.N.ResourceId=pAlImMnm
&MetricInfos.N.TagList.N.TagKey=bYSOyCNH
&MetricInfos.N.TagList.N.TagValues.N=jNRAlNmmResponse Example
{
"Action": "QueryMetricDataSetResponse",
"Data": {},
"Message": "nPOVsgEJ",
"RetCode": 0,
"TraceId": "wbgFGCpd"
}