Querying Network Device Monitoring Data

Function

Query network device monitoring data.

SLA Item	Definition
Request success rate	≥ 99.9%
Availability	Tier 1
Data consistency	Eventual consistency can be achieved. The duration of inconsistency is less than 1 minute.
Throughput	4000 TPS
TP50 request latency	2 ms
TP99.9 request latency	5 ms

Precautions

None

Calling Method

GET

URI

/rest/dataapi/homs/open-api/v1/network-device/metric-data

Path parameters

None

Query parameters

Parameter	Mandatory	Type	Value Range	Description
begin_time	Yes	integer	None	Start time
end_time	Yes	integer	None	End time
offset_value	Yes	integer	None	Offset: greater than or equal to 0
page_size	Yes	integer	Default value: 500	Page size: greater than or equal to 0
management_ip	No	string	None	Management IP address of a network device
metric	No	string	Value range: 59, 60, 14, 18, 101, 102, 61, 52	Device metrics

Request

Request header parameters

Parameter	Mandatory	Type	Value Range	Description
X-APIG-Appcode	Yes	string	None	AppCode allocated by SRE
x-auth-token	Yes	string	None	IAM authentication token for the calling party APIG
x-hcso-domainid	No	string	None	ID of the accessed tenant. This parameter is mandatory only in the HCS Online scenario.
x-hcso-appcode	Yes	string	None	AppCode allocated by SRE

Request body parameters
None

Sample request

GET /rest/dataapi/homs/open-api/v1/network-device/metric-data?begin_time=0&end_time=0&offset_value=0&page_size=1
Content-Type: application/json
Accept: application/json
X-Auth-Token: xxx
x-hcso-appcode: xxx

Response

Response parameters

Parameter	Mandatory	Type	Value Range	Description
device_ip	Yes	string	None	Management IP address of a network device
res_type	Yes	string	None	Resource type
metric	Yes	string	None	Device metrics
region_id	Yes	string	None	Region code
value	Yes	string	None	Metric value
timestamp	Yes	string	None	Timestamp

Sample response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF8
{
	"total": 1698669,
	"list": [
		{
			"device_ip": "xx.xx.xx.xx",
			"res_type": "2",
			"metric": "14",
			"region_id": "cn-north-7",
			"value": "0",
			"timestamp": "1726819320000"
		}
	]
}