Help Center/ CloudPond/ API Reference/ API/ Network Devices/ Querying Network Devices

Updated on 2025-10-28 GMT+08:00

View PDF

Querying Network Devices

Function

This API is used to query network devices.

This API supports fine-grained permissions for enterprise projects. For details, see ies:edgeSite:listNetworkDevices.

URI

GET /v2/{domain_id}/network-devices

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the URI.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
edge_site_id	No	String	Edge site ID.
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.
status	No	Array of strings	The status specified for querying network devices. Multiple values are supported for query.
id	No	Array of strings	The server ID specified for filtering servers. Multiple values can be used for query in the format of id=xxx&id=xxx.

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
network_devices	Array of NetworkDevice objects	Network device list.
page_info	PageInfo object	Pagination information.

**Table 5** NetworkDevice
Parameter	Type	Description
id	String	Network device resource ID.
domain_id	String	Account ID.
edge_site_id	String	Site ID.
name	String	Name.
status	String	PENDING_PAYMENT: Pending payment DELIVERING: Delivering USING: Using
offering_id	String	Offering ID.
spec	NetworkDeviceSpec object	Network device specifications.
market_options	MarketOptions object	Billing information.
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
location	LayoutLocation object	Device location information.
created_at	String	Creation time.
updated_at	String	Update time.

**Table 6** NetworkDeviceSpec
Parameter	Type	Description
id	String	Network device specification ID.
name	String	Network device specification name.
power	Integer	Device power (W).
unit	Integer	Height of a device. U spaces.
performance_type	String	Usage.

**Table 7** MarketOptions
Parameter	Type	Description
charge_mode	String	Billing mode. prepaid: Yearly/monthly
prepaid_options	PrepaidOptions object	Yearly/Monthly billing information.
strategies	Array of Strategy objects	The list of sales strategies.

**Table 8** PrepaidOptions
Parameter	Type	Description
order_id	String	Order ID.
product_id	String	Product ID.
pay_mode	String	Yearly/monthly payment type. Options: FULL: All upfront payments HALF: Half upfront payments PAID_BY_YEAR: Yearly payments ZERO_PAID_BY_YEAR: Yearly payments without upfront

**Table 9** Strategy
Parameter	Type	Description
status	String	O&M status. FREEZE: Frozen
scene	String	Resource operating status. Options: ARREAR: Resources are in arrears. POLICE: Resources are frozen for public security. ILLEGAL: Resources are frozen due to violation of laws and regulations. VERIFY: Resources are frozen because the user fails to pass real-name authentication.
effect	String	Resource operations: DELETABLE: Resources can be deleted. UNDELETABLE: Resources cannot be deleted.

**Table 10** ProductInfo
Parameter	Type	Description
cloud_service_type	String	Cloud service type.
resource_type	String	Resource type.
resource_spec_code	String	Resource code.

**Table 11** LayoutLocation
Parameter	Type	Description
rack_id	String	Rack ID.
start_index	Integer	Start U space.
unit	Integer	U spaces.

**Table 12** PageInfo
Parameter	Type	Description
next_marker	String	Marker of the next page.
current_count	Integer	The number of records on the current page.

Example Request

Querying network devices.

GET https://{ies_endpoint}/v2/{domain_id}/network-devices

Example Response

Status code: 200

successful operation

{
  "network_devices" : [ {
    "id" : "00000000-0000-000-0000-000000000000",
    "domain_id" : "00000000000000000000000000000000",
    "edge_site_id" : "00000000-0000-000-0000-000000000000",
    "name" : "network01",
    "status" : "USING",
    "offering_id" : "00000000-0000-000-0000-000000000000",
    "spec" : {
      "id" : "00000000-0000-000-0000-000000000000",
      "name" : "network_device01",
      "performance_type" : "normal",
      "power" : 10,
      "unit" : 3
    },
    "market_options" : {
      "charge_mode" : "prepaid",
      "prepaid_options" : {
        "order_id" : "CS2507010000LFU8W",
        "pay_mode" : "FULL"
      }
    },
    "product_info" : {
      "cloud_service_type" : "hws.service.type.ies",
      "resource_type" : "hws.resource.type.iesserver",
      "resource_spec_code" : "ies.cbu.testnetwork"
    },
    "created_at" : "2025-07-01T00:00:00.000000Z",
    "updated_at" : "2025-07-01T01:00:00.000000Z"
  } ],
  "page_info" : {
    "current_count" : 1
  }
}