Querying Network Devices

Function

This API is used to query network devices.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ies::listNetworkOfferings	List	-	-	ies:system:listNetworkOfferings	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the path.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
zone_code	No	String	Area code.
storage_type	No	Array of strings	Storage type.
pay_mode	No	Array of strings	Billing mode.
period_num	No	Array of integers	Purchase duration.
limit	No	Integer	Page size.
marker	No	String	Pagination identifier.

Request Parameters

**Table 3** Request header parameters
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 policy 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. TESTING: testing ONSALE: on sale SUSPENDED: discontinued RETIREMENT: product retirement
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	Device height (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. FULL: full upfront HALF: half upfront PAID_BY_YEAR: Yearly ZERO_PAID_BY_YEAR: zero upfront, yearly
period_type	String	Yearly/Monthly type. year
period_num	Integer	The number of sales cycles.

**Table 9** PageInfo
Parameter	Type	Description
next_marker	String	Next page marker.
current_count	Integer	Number of records on the current page.

Example Requests

Example request for querying network devices

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

Example Responses

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
  }
}