Cloud Monitor(UMon)

Get monitoring overview data - GetMetricOverview


Get the current monitoring indicator data of resources

💡 Note
For resource types and monitoring indicators, refer to the GetMetric document.


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetMetricOverview.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID, if not filled in, the default project will be used. Sub-accounts must fill in the Project ID.No
ResourceTypestringResource TypeYes
MetricName.NstringMonitoring metric name, if omitted, all monitoring metric data will be returned.No
LimitintData pagination value, default is 20No
OffsetintData offset, default is 0No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[ResourceItemSet]JSON format monitoring data listNo
RefreshTimeintSystem update time, in Unix Timestamp formatNo
ResourceTypestringResource TypeNo
TotalCountintReturn Total QuantityNo

Data Model


Field NameTypeDescription InformationRequired
ResourceIdstringResource IDYes
NamestringResource NameNo


Request Example

Response Example

  "Action": "GetMetricOverviewResponse",
  "DataSet": [
      "BlockProcessCount": 0,
      "CPUUtilization": 0,
      "DataSpaceUsage": 0,
      "DiskReadOps": 0,
      "DiskWriteOps": 0,
      "IORead": 0,
      "IOWrite": 4641,
      "MemUsage": 0,
      "NICIn": 3002,
      "NICOut": 3944,
      "Name": "testtest",
      "NetPacketIn": 2,
      "NetPacketOut": 2,
      "Remark": "",
      "ResourceId": "uhost-xxx",
      "RootSpaceUsage": 0,
      "RunnableProcessCount": 0,
      "Uuid": "0e796e5a-e004-42a2-92be-77277bde9144"
  "RefreshTime": 1431507033,
  "ResourceType": "uhost",
  "RetCode": 0,
  "TotalCount": 1
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.