Get resource support monitoring metric information - DescribeResourceMetric
Overview
Get resource support monitoring metric information
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is DescribeResourceMetric. | 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 |
|---|---|---|---|
| ResourceType | string | Resource Type supports the following types: dbaudit: Database Audit; docker: Container Service; docker_node: Container Service Node; eip: Elastic IP; fortress: Bastion Host; hybridcloud_lan: UHybrid Local Area Network; hybridcloud_port: UHybrid Switch Port; hybridcloud_port_sum: UHybrid Public Network Total Export; mq: Message Queue; natgw: NAT Gateway; phost: Physical Cloud Host; sharebandwidth: Shared Bandwidth; uaiservice: AI Online Service; ucdn: UCDN; udb: UDB; uddb: Distributed Database; uddbac: UDDB Analysis Node; uddbmd: Distributed Database Middleware; uddbnode: Distributed Database Node; udisk: UDisk; udisk_rssd: RSSD UDisk; udisk_ssd: SSD UDisk (Data Disk); udisk_sys: Common UDisk (System Disk); udpn: UDPN; udset: UDSet Resource Pool; udset_uhost: Resource Pool Host; udw: UDW; udw_node: UDW Node; ues: ES Service; ues_node: Elasticsearch Service Node; ufile: US3; ufs: UFS; ugaa: Global Dynamic Acceleration; ugc: General Computing; uhadoop: UHadoop Cluster; uhadoop_host: Managed Hadoop Cluster; uhost: UHost; ukafka: UKafka; ukafka_host: Distributed Message Node; ukv: Capacity KV Storage; ulb: ULB; ulb-server: Real Service Node; ulb-vserver: Virtual Service Node; umem: UMem; umemcache: Standalone Memcache; upath: Acceleration Line; uredis: UMem; utsdb: Time Series Database; vpntunnel: VPN Tunnel; vserver: Virtual Service Node; For monitoring items supported by each product, please check: https://docs.ucloud.cn/api/umon-api/get_metric (opens in a new tab) | Yes |
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 |
| DataSet | array[DescribeResourceMetricResponse] | Metric Information Collection | Yes |
Data Model
DescribeResourceMetricResponse
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| Unit | string | Unit: bit Byte Kb KB Mb MB Gb GB Tb TB Pb PB Eb EB iops bps Bps Kbps KBps Mbps MBps Gbps GBps Tbps TBps pcs pcs/s times times/s thousand times/s ten thousand times/s % s ms us bool ‱ pcs/min pcs/core pcs/10s bytes/10s MB/s dbm min | Yes |
| ConversionFactor | int | Reserved Field | Yes |
| Type | string | Metric Type (temporarily meaningless) | Yes |
| MetricGroup | string | Monitoring Metrics Group | Yes |
| SupportAlarm | string | Supports alert: Yes|No | Yes |
| AlarmRange | object | Valid range for setting alarm thresholds | Yes |
| Frequency | int | Alarm Frequency | Yes |
| MetricId | int | Monitoring Item ID | Yes |
| CompareOption | array[string] | Comparison Method: GE Greater than or Equal to | LE Less than or Equal to | Yes |
| MetricName | string | Metric Name | No |
Example
Request Example
https://api.surfercloud.com/?Action=DescribeResourceMetric
&ResourceType=uhostResponse Example
{
"Action": "DescribeResourceMetricResponse",
"DataSet": [
{
"AlarmRange": {
"max": 100,
"min": 50
},
"CompareOption": [
"GE"
],
"ConversionFactor": 0,
"Frequency": 60,
"MetricGroup": "",
"MetricId": 8000,
"MetricName": "CPUUtilization",
"SupportAlarm": "Yes",
"Type": "Number",
"Unit": "%"
}
],
"RetCode": 0
}