文档首页/ CloudPond云服务/ API参考/ API/ 网络设备/ 查询网络设备列表 - ListNetworkDevices
更新时间：2025-10-28 GMT+08:00
查看PDF
分享

查询网络设备列表 - ListNetworkDevices

功能介绍

查询网络设备列表。

  • 该接口支持企业项目细粒度权限的校验，具体细粒度请参见 ies:edgeSite:listNetworkDevices

URI

GET /v2/{domain_id}/network-devices

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

path中租户的账号ID
表2 Query参数

参数

是否必选

参数类型

描述

edge_site_id

否

String

边缘小站ID

limit

否

Integer

每页的数量

marker

否

String

分页标识

status

否

Array of strings

根据网络设备状态查询，支持多值查询

id

否

Array of strings

根据ID过滤，支持多值查询，查询条件格式：id=xxx&id=xxx。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

network_devices

Array of NetworkDevice objects

网络设备列表

page_info

PageInfo object

分页信息
表5 NetworkDevice

参数

参数类型

描述

id

String

网络设备资源ID

domain_id

String

账号ID

edge_site_id

String

站点ID

name

String

名称

status

String

  • PENDING_PAYMENT：待支付

  • DELIVERING：交付中

  • USING：使用中

offering_id

String

商品ID

spec

NetworkDeviceSpec object

网络设备规格

market_options

MarketOptions object

计费信息

product_info

ProductInfo object

商品归属产品属性信息

location

LayoutLocation object

设备位置信息

created_at

String

创建时间

updated_at

String

更新时间
表6 NetworkDeviceSpec

参数

参数类型

描述

id

String

网络设备规格ID

name

String

网络设备规格名称。

power

Integer

设备功率。单位：w

unit

Integer

设备高度。U位数。

performance_type

String

用途
表7 MarketOptions

参数

参数类型

描述

charge_mode

String

计费模式。

  • prepaid：包周期

prepaid_options

PrepaidOptions object

包周期计费信息

strategies

Array of Strategy objects

销售策略列表
表8 PrepaidOptions

参数

参数类型

描述

order_id

String

订单ID

product_id

String

产品ID

pay_mode

String

包周期付款类型

  • FULL: 全预付

  • HALF：半预付

  • PAID_BY_YEAR：按年付费

  • ZERO_PAID_BY_YEAR：零预付-按年
表9 Strategy

参数

参数类型

描述

status

String

运维状态说明：

  • FREEZE - 已冻结

scene

String

资源运营状态场景：

ARREAR：欠费场景；

POLICE：公安场景。

ILLEGAL：违规场景。

VERIFY：客户未实名认证冻结场景。

effect

String

资源运营功能：

DELETABLE：可删除

UNDELETABLE：不可删除
表10 ProductInfo

参数

参数类型

描述

cloud_service_type

String

云服务类型

resource_type

String

资源类型

resource_spec_code

String

资源编码
表11 LayoutLocation

参数

参数类型

描述

rack_id

String

机柜ID

start_index

Integer

起始U位

unit

Integer

U位数
表12 PageInfo

参数

参数类型

描述

next_marker

String

下一页标识。

current_count

Integer

当前页数量。

请求示例

查询网络设备列表

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

响应示例

状态码：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
  }
}

状态码

状态码

描述

200

successful operation

错误码

请参见错误码。

父主题： 网络设备