Querying the NIC Status

Function

This API is used to check the NIC status.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/net

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cluster_id	No	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A
instance_name	No	String	Definition Instance name. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value No limit.
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of NetResp objects	Definition NIC status response body. Range N/A

**Table 4** NetResp
Parameter	Type	Description
virtual_cluster_id	Integer	Definition Virtual cluster ID. Range N/A
ctime	Long	Definition Query time. Range N/A
host_id	Integer	Definition Host ID. Range N/A
host_name	String	Definition Host name. Range N/A
instance_name	String	Definition Instance name. Range N/A
up	Boolean	Definition NIC status. Range true: The NIC is in the Up status. false: The NIC is in the Down state.
speed	Long	Definition NIC speed (Mbps). Range N/A
recv_packets	Long	Definition Number of received packets. Range N/A
send_packets	Long	Definition Number of transmitted packets Range N/A
recv_drop	Long	Definition Number of lost packets. Range N/A
recv_rate	Double	Definition Receive rate (KB/s). Range N/A
send_rate	Double	Definition Transmit rate (KB/s). Range N/A
io_rate	Double	Definition Network speed (KB/s). Range N/A
interface_name	String	Definition NIC name. Range N/A

Example Requests

https://10.95.226.104:31521/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/net?limit=1&offset=0

Example Responses

Status code: 200

NIC status queried.

[ {
  "virtual_cluster_id" : 23,
  "ctime" : 1668071223000,
  "host_id" : 34,
  "host_name" : "host-172-16-11-62",
  "instance_name" : "dms-test07-dws-cn-cn-1-1",
  "interface_name" : "eth2",
  "up" : true,
  "speed" : -1,
  "recv_packets" : 490595835,
  "send_packets" : 533376765,
  "recv_drop" : 0,
  "recv_rate" : 16.35,
  "send_rate" : 11.71,
  "io_rate" : null
} ]

Status Codes

Status Code	Description
200	NIC status queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.