Help Center/ CloudPond/ API Reference/ API/ Offerings/ Querying Network Device Offerings

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

View PDF

Querying Network Device Offerings

Function

This API is used to query network device offerings.

URI

GET /v2/{domain_id}/network-device-offerings

**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
zone_code	No	String	Area code.
storage_type	No	Array of strings	Storage types.
pay_mode	No	Array of strings	Billing mode.
period_num	No	Array of integers	Purchase duration.
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.

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
offerings	Array of NetworkDeviceOffering objects	Offering list.
page_info	PageInfo object	Pagination information.

**Table 5** NetworkDeviceOffering
Parameter	Type	Description
id	String	Sales strategy ID.
zone_code	String	Area code, which indicates that devices can be purchased and deployed in this area.
scene_code	String	Sales scenario code.
status	String	Rack status. Options: TESTING: Racks are being tested. ONSALE: Racks are available for sale. SUSPENDED: Racks are suspended. RETIREMENT: Racks are retired.
spec	NetworkDeviceSpec object	Network device specifications.
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
sale_cycles	Array of SaleCycle objects	Objects of the sales cycle.

**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** ProductInfo
Parameter	Type	Description
cloud_service_type	String	Cloud service type.
resource_type	String	Resource type.
resource_spec_code	String	Resource code.

**Table 8** SaleCycle
Parameter	Type	Description
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
period_type	String	Subscription period type. year: Yearly
period_num	Integer	The number of subscription periods.

**Table 9** 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 device offerings

GET https://{ies_endpoint}/v2/{domain_id}/network-device-offerings

Example Response

Status code: 200

successful operation

{
  "offerings" : [ {
    "id" : "00000000-0000-000-0000-000000000000",
    "zone_code" : "CN",
    "scene_code" : "normal",
    "status" : "ONSALE",
    "spec" : {
      "id" : "00000000-0000-000-0000-000000000000",
      "name" : "network_device01",
      "power" : 1000,
      "unit" : 3,
      "performance_type" : "normal"
    },
    "product_info" : {
      "cloud_service_type" : "hws.service.type.ies",
      "resource_type" : "hws.resource.type.iesserver",
      "resource_spec_code" : "ies.cbu.testnetwork"
    },
    "sale_cycles" : [ {
      "pay_mode" : "HALF",
      "period_type" : "year",
      "period_num" : 3
    }, {
      "pay_mode" : "FULL",
      "period_type" : "year",
      "period_num" : 3
    } ]
  } ],
  "page_info" : {
    "current_count" : 1
  }
}