Listing Racks

Function

This API is used to list racks.

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

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:edgeSite:listRacks	List	edgeSite *	g:EnterpriseProjectId	ies:rack:list	-

URI

GET /v1/{domain_id}/racks

**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
limit	No	Integer	Page size.
marker	No	String	Pagination identifier.
sort_key	No	Array of strings	Sorting field.
sort_dir	No	Array of strings	Sorting order. The options are as follows: desc: descending order asc: ascending order
edge_site_id	No	String	Edge site ID
delivery_order_id	No	String	Delivery Order ID
status	No	Array of strings	Query by rack status. Multiple values are supported for query.

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
racks	Array of Rack objects	Rack list
page_info	PageInfo object	Pagination information.

**Table 5** Rack
Parameter	Type	Description
id	String	Rack ID
name	String	Rack name
edge_site_id	String	Edge site ID
rack_category_id	String	Rack category ID
rack_type	String	Rack type
status	String	Rack status CREATING: Resources are being created. AVAILABLE: Resources are available. EXPANDING: Resources are being expanded. PENDING_PAYMENT: Resources are to be paid for.
storage_assigned_size	Integer	Allocated storage
description	String	Rack description
rack_sn_no	String	Rack SN
rack_location_no	String	Rack location number
created_at	String	Time when the rack was created
updated_at	String	Time when the rack was updated
effected_at	String	Time when the rack took effect
market_options	MarketOptions object	Billing
compute_unit	Array of ComputeSpec objects	Compute unit information
storage_unit	StorageUnit object	Storage unit
rack_info	RackInfo object	Rack
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.

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

**Table 7** PrepaidOptions
Parameter	Type	Description
order_id	String	Order ID
product_id	String	Product ID
pay_mode	String	Yearly/Monthly payment. FULL: full upfront HALF: half upfront PAID_BY_YEAR: Yearly ZERO_PAID_BY_YEAR: zero upfront, yearly

**Table 8** Strategy
Parameter	Type	Description
status	String	O&M status: FREEZE: frozen
scene	String	Resource operations status: ARREAR: The account is in arrears. POLICE: public security. ILLEGAL: violation scenario. VERIFY: The resource is frozen because the user fails to pass the real-name authentication.
effect	String	Resource operations: DELETABLE: deletable UNDELETABLE: unable to delete

**Table 9** ComputeSpec
Parameter	Type	Description
flavor_type	String	Compute specification, for example, C6
count	Integer	Number of compute units

**Table 10** StorageUnit
Parameter	Type	Description
storage_type	String	Storage type. SAS: High I/O SSD: Ultra-high I/O SAS_SD: High I/O (software-defined) SSD_SD: Ultra-high I/O (software-defined) SAS_ARM: High I/O (Kunpeng) SSD_ARM: Ultra-high I/O (Kunpeng) VS_SMALL_CAP: Edge object storage (small-capacity) VS_MEDIUM_CAP: Edge object storage (medium-capacity) VS_LARGE_CAP: Edge object storage (large-capacity) CBR_STANDARD_SMALL_CAP: Cloud Backup and Recovery (basic edition) (small-capacity) CBR_STANDARD_MEDIUM_CAP: Cloud Backup and Recovery (basic edition) (medium-capacity) CBR_STANDARD_LARGE_CAP: Cloud Backup and Recovery (basic edition) (large-capacity) CBR_PROFESSIONAL_SMALL_CAP: Cloud Backup and Recovery (professional edition) (small-capacity) CBR_PROFESSIONAL_MEDIUM_CAP: Cloud Backup and Recovery (professional edition) (medium-capacity) CBR_PROFESSIONAL_LARGE_CAP: Cloud Backup and Recovery (professional edition) (large-capacity)
capacity	Integer	Storage pool size (TB)
gears	Array of integers	Storage pool pricing tiers
flavor_type	String	Flavor (for example: highio-4T)
count	Integer	Number of storage nodes

**Table 11** RackInfo
Parameter	Type	Description
power	Integer	Rack power (w)
size	String	Rack size, for example, 100200200 (cm)
has_lock	Boolean	Whether rack locks configured

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

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

Example Requests

Listing racks

GET https://{ies_endpoint}/v1/{domain_id}/racks

Example Responses

Status code: 200

successful operation

{
  "racks" : [ {
    "id" : "fe89570e-da65-4a4d-a64b-03231257dd96",
    "name" : "basic-absuv",
    "edge_site_id" : "a4a36874-c41b-4295-9fd5-6823864fd564",
    "rack_category_id" : "47ac059f-5df3-422b-b08a-eabba8c01980",
    "rack_type" : "BASIC",
    "status" : "AVAILABLE",
    "storage_assigned_size" : 36,
    "description" : null,
    "rack_sn_no" : "rack_sn_no",
    "rack_location_no" : "rack_location_no",
    "created_at" : "2022-01-18T02:56:02.759098Z",
    "updated_at" : "2022-01-18T02:59:56.559151Z",
    "effected_at" : "2022-01-19T02:59:25Z",
    "market_options" : {
      "charge_mode" : "prepaid",
      "prepaid_options" : {
        "order_id" : "CS2201181056V3SK6",
        "product_id" : "OFFI645544463633592326",
        "pay_mode" : "FULL"
      }
    },
    "compute_unit" : [ {
      "flavor_type" : "C6",
      "count" : 4
    }, {
      "flavor_type" : "Pi2",
      "count" : 1
    } ],
    "storage_unit" : {
      "storage_type" : "SAS",
      "capacity" : 144,
      "gears" : [ 36, 72, 108, 144 ],
      "flavor_type" : "string",
      "count" : 1
    },
    "rack_info" : {
      "power" : 6000,
      "size" : "600 mm x 1200 mm x 2000 mm (W x D x H)",
      "has_lock" : true
    }
  } ],
  "page_info" : {
    "current_count" : 1
  }
}