DescribeMetricList - Data Transmission Service

Queries the metrics of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMetricList	The operation that you want to perform. Set the value to DescribeMetricList.
MetricType	String	No	NODE	Specifies whether to query the metrics of the cluster or a node. Valid values: CLUSTER: queries the metrics of the cluster. NODE: queries the metrics of a node.
MetricName	String	Yes	cpu_total	InternetOut: the outbound traffic over the Internet. Unit: bytes. diskusage_utilization: the disk usage. IntranetInRate: the inbound traffic over the internal network. Unit: bytes. InternetIn: the inbound traffic from the Internet. Unit: bytes. cpu_total: the CPU utilization. memory_usedutilization: the memory usage. IntranetOutRate: the outbound traffic over the internal network. Unit: bytes.
Period	Long	No	15	The monitoring interval. Unit: seconds. The minimum value is 15.
Param	String	Yes	nodeid	The monitored object. If MetricType is set to NODE, set this parameter to the ID of the node that is monitored.
StartTime	Long	No	1642476144000	The timestamp that indicates the beginning of the time range to query. Unit: milliseconds.
EndTime	Long	No	1642476194000	The timestamp that indicates the end of the time range to query. Unit: milliseconds.
Env	String	No	ALIYUN	The environment of the cluster. Default value: ALIYUN.
DtsJobId	String	No	k2gm967v16f****	The ID of the data migration or synchronization task.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
AccountId	String	No	12323344****	The ID of the Alibaba Cloud account.

Response parameters


Parameter	Type	Example	Description
MetricType	String	CLUSTER	Indicates whether the metrics of the cluster or a node are queried. Valid values: CLUSTER: The metrics of the cluster are queried. NODE: The metrics of a node are queried.
Param	String	ecs-jhjnjjn	The monitored object. If MetricType is set to NODE, the value of this parameter is the ID of the node that is monitored. If MetricType is set to CLUSTER, the value of this parameter is the ID of the dedicated cluster. You can obtain the ID by calling the ListDedicatedCluster operation.
MetricName	String	cpu_total	InternetOut: the outbound traffic over the Internet. Unit: bytes. diskusage_utilization: the disk usage. IntranetInRate: the inbound traffic over the internal network. Unit: bytes. InternetIn: the inbound traffic from the Internet. Unit: bytes. cpu_total: the CPU utilization. memory_usedutilization: the memory usage. IntranetOutRate: the outbound traffic over the internal network. Unit: bytes.
Period	Long	15	The monitoring interval. Unit: seconds. The minimum value is 15.
DataPoints	Array of DataPoint		The monitoring statistics.
Timestamp	Long	1650872310000	The timestamp of the record. Unit: milliseconds.
Statistics	Float	15.25	The statistical value.
Success	Boolean	true	Indicates whether the request was successful.
Code	String	403	The error code returned by the backend service. The number is incremented.
ErrCode	String	InternalError	The error code returned if the request failed.
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned if the request failed.
DynamicMessage	String	Type	The dynamic part in the error message. This parameter is used to replace the %s variable in the value of ErrMessage.
HttpStatusCode	Integer	403	The HTTP status code returned for an exception.
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	The ID of the request.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeMetricList
&MetricType=NODE
&MetricName=cpu_total
&Period=15
&Param=nodeid
&StartTime=1642476144000
&EndTime=1642476194000
&Env=ALIYUN
&DtsJobId=k2gm967v16f****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&AccountId=12323344****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricListResponse>
    <code>200</code>
    <data>
        <MetricName>diskusage_utilization</MetricName>
        <RequestId>36F33F1C-CF13-149E-AB05-****</RequestId>
        <MetricType>CLUSTER</MetricType>
        <HttpStatusCode>200</HttpStatusCode>
        <Period>15</Period>
        <DataPoints>
            <Timestamp>1651112970000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651112985000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113000000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113015000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113030000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113045000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113060000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113075000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113090000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113105000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113120000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113135000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113150000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113165000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113180000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113195000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113210000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113225000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113240000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113255000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113270000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113285000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113300000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113315000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113330000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113345000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113360000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113375000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113390000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113405000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113420000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113435000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113450000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113465000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113480000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113495000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113510000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113525000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113540000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113555000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <Success>true</Success>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>36F33F1C-CF13-149E-AB05-****</requestId>
    <successResponse>true</successResponse>
</DescribeMetricListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "MetricName" : "diskusage_utilization",
    "RequestId" : "36F33F1C-CF13-149E-AB05-****",
    "MetricType" : "CLUSTER",
    "HttpStatusCode" : 200,
    "Period" : 15,
    "DataPoints" : [ {
      "Timestamp" : 1651112970000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651112985000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113000000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113015000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113030000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113045000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113060000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113075000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113090000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113105000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113120000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113135000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113150000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113165000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113180000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113195000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113210000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113225000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113240000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113255000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113270000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113285000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113300000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113315000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113330000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113345000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113360000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113375000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113390000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113405000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113420000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113435000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113450000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113465000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113480000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113495000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113510000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113525000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113540000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113555000,
      "Statistics" : 10.5
    } ],
    "Success" : true
  },
  "httpStatusCode" : "200",
  "requestId" : "36F33F1C-CF13-149E-AB05-****",
  "successResponse" : true
}

Error codes


HTTP status code	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The number of requests reached the limit and the request was rejected. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.

For a list of error codes, see Service error codes.