Querying Server Offerings

Function

This API is used to query server offerings.

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::listServerOfferings	List	-	-	ies:system:listServerOfferings	-

URI

GET /v2/{domain_id}/server-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.
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 ServerOffering objects	Offering list.
page_info	PageInfo object	Pagination information.

**Table 5** ServerOffering
Parameter	Type	Description
id	String	The server offering 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	ServerSpec object	Server 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** ServerSpec
Parameter	Type	Description
id	String	Server specification ID.
name	String	Server specification name.
server_type	String	Server type. COMPUTE: compute server NETWORK: network server BLOCK_STORAGE: disk storage server
flavor_type	String	Server resource flavor type.
performance_type	String	Types of server specifications, for example, general computing, cloud desktop, and gateway.
power	Integer	Rack power (w).
unit	Integer	Device height (U spaces).
vcpus	Integer	The number of available vCPU cores.
memory	Integer	Available memory size (GB).
storage_capacity	Integer	Available storage capacity (TiB).
cpu_name	String	Name.
cpu_architecture	String	CPU architecture.

**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 server offerings

GET https://{ies_endpoint}/v2/{domain_id}/server-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" : "S7",
      "server_type" : "COMPUTE",
      "flavor_type" : null,
      "performance_type" : "normal",
      "power" : 10,
      "unit" : 3,
      "vcpus" : 100,
      "memory" : 800,
      "storage_capacity" : 3000,
      "cpu_name" : "",
      "cpu_architecture" : "X86"
    },
    "product_info" : {
      "cloud_service_type" : "hws.service.type.ies",
      "resource_type" : "hws.resource.type.iesserver",
      "resource_spec_code" : "ies.cbu.testcompute"
    },
    "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
  }
}