Help Center/ CloudPond/ API Reference/ API/ Servers/ Querying Details About a Server

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

View PDF

Querying Details About a Server

Function

This API is used to query details about a server.

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

URI

GET /v2/{domain_id}/servers/{server_id}

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the URI.
server_id	Yes	String	Server ID.

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
server	Server object	Server details.

**Table 4** Server
Parameter	Type	Description
id	String	Resource ID.
domain_id	String	Account ID.
edge_site_id	String	Site ID.
name	String	Name.
status	String	PENDING_PAYMENT: Pending payment DELIVERING: Delivering USING: Using
offering_id	String	Offering ID.
spec	ServerResourceSpec object	Server resource specifications.
market_options	MarketOptions object	Billing information.
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
location	LayoutLocation object	Device location information.
created_at	String	Creation time.
updated_at	String	Update time.

**Table 5** ServerResourceSpec
Parameter	Type	Description
id	String	Server flavor ID.
name	String	Server flavor name.
server_type	String	Server type. Options: COMPUTE: Computing servers NETWORK: Network servers BLOCK_STORAGE: Disk storage servers
flavor_type	String	Server resource flavor type.
performance_type	String	ECS flavor categories, for example, general computing, cloud desktop, and gateway.
power	Integer	Server power (W).
unit	Integer	Height of a device. U spaces.
vcpus	Integer	The number of available vCPU cores.
memory	Integer	Available memory (GB).
storage_capacity	Integer	Available storage capacity (TiB).
cpu_name	String	Name.
cpu_architecture	String	CPU architecture.

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

**Table 7** PrepaidOptions
Parameter	Type	Description
order_id	String	Order ID.
product_id	String	Product ID.
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

**Table 8** Strategy
Parameter	Type	Description
status	String	O&M status. FREEZE: Frozen
scene	String	Resource operating status. Options: ARREAR: Resources are in arrears. POLICE: Resources are frozen for public security. ILLEGAL: Resources are frozen due to violation of laws and regulations. VERIFY: Resources are frozen because the user fails to pass real-name authentication.
effect	String	Resource operations: DELETABLE: Resources can be deleted. UNDELETABLE: Resources cannot be deleted.

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

**Table 10** LayoutLocation
Parameter	Type	Description
rack_id	String	Rack ID.
start_index	Integer	Start U space.
unit	Integer	U spaces.

Example Request

Querying details about a server.

GET https://{ies_endpoint}/v2/{domain_id}/servers/{server_id}

Example Response

Status code: 200

successful operation

{
  "server" : {
    "id" : "00000000-0000-000-0000-000000000000",
    "domain_id" : "00000000000000000000000000000000",
    "edge_site_id" : "00000000-0000-000-0000-000000000000",
    "name" : "server01",
    "status" : "USING",
    "offering_id" : "00000000-0000-000-0000-000000000000",
    "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" : 500,
      "storage_capacity" : 3000,
      "cpu_name" : "",
      "cpu_architecture" : "X86"
    },
    "market_options" : {
      "charge_mode" : "prepaid",
      "prepaid_options" : {
        "order_id" : "CS2507010000LFU8W",
        "pay_mode" : "FULL"
      }
    },
    "created_at" : "2025-07-01T00:00:00.000000Z",
    "updated_at" : "2025-07-01T01:00:00.000000Z"
  }
}