Help Center/ Elastic Cloud Server/ API Reference/ Data Structure/ Data Structure for Querying Details About ECSs
Updated on 2025-08-20 GMT+08:00

Data Structure for Querying Details About ECSs

Table 1 flavor parameters

Parameter

Type

Description

id

String

Definition

Specifies the ECS flavor ID.

Range

N/A

name

String

Definition

Specifies the ECS flavor name.

Range

N/A

disk

String

Definition

Specifies the system disk size in the ECS flavor. Value 0 indicates that the disk size is not limited.

The field is invalid in this system.

Range

N/A

vcpus

String

Definition

Specifies the number of vCPUs in the ECS flavor.

Range

N/A

ram

String

Definition

Specifies the memory size (MiB) in the ECS flavor.

Range

N/A

gpus

Array of objects

Definition

Specifies the GPU information in the ECS flavor.

For details, see Table 8.

Range

N/A

asic_accelerators

Array of objects

Definition

Specifies the ASIC information in the ECS flavor.

For details, see Table 9.

Range

N/A

Table 2 flavor parameters (v1.1 API)

Parameter

Type

Description

id

String

Definition

Specifies the ECS flavor ID.

Range

N/A

name

String

Definition

Specifies the ECS flavor name.

Range

N/A

disk

Integer

Definition

Specifies the system disk size in the ECS flavor. Value 0 indicates that the disk size is not limited.

The field is invalid in this system.

Range

N/A

vcpus

Integer

Definition

Specifies the number of vCPUs in the ECS flavor.

Range

N/A

ram

Integer

Definition

Specifies the memory size (MiB) in the ECS flavor.

Range

N/A

gpus

Array of objects

Definition

Specifies the GPU information in the ECS flavor.

For details, see Table 8.

Range

N/A

asic_accelerators

Array of objects

Definition

Specifies the ASIC information in the ECS flavor.

For details, see Table 9.

Range

N/A

Table 3 security_groups parameters

Parameter

Type

Description

name

String

Definition

Specifies the security group name or UUID.

Range

N/A

id

String

Definition

Specifies the security group ID.

Range

N/A

Table 4 os-extended-volumes:volumes_attached parameters

Parameter

Type

Description

id

String

Definition

Specifies the disk ID in UUID format.

Range

N/A

delete_on_termination

String

Definition

Specifies whether the disk is deleted with the ECS.

This parameter is supported in microversion 2.3 and later.

Range

  • true: indicates that the disk is deleted with the ECS.
  • false: indicates that the disk is not deleted with the ECS.

bootIndex

String

Definition

Specifies the EVS disk boot sequence.

Range

  • 0 indicates the system disk.
  • Non-0 indicates a data disk.

device

String

Definition

Specifies the drive letter of the EVS disk, which is the device name of the EVS disk.

Range

N/A

Table 5 metadata parameters

Parameter

Type

Description

charging_mode

String

Definition

Specifies the ECS billing mode.

Range

  • 0: pay-per-use payment (postpaid)
  • 1: yearly/monthly payment (prepaid)
  • 2: spot price billing mode

metering.order_id

String

Definition

Specifies the order ID for a yearly/monthly ECS.

Range

N/A

metering.product_id

String

Definition

Specifies the product ID for a yearly/monthly ECS.

Range

N/A

vpc_id

String

Definition

Specifies the ID of the VPC where the ECS is located.

Range

N/A

EcmResStatus

String

Definition

Specifies the ECS frozen status.

NOTE:

The system automatically adds this field, which is mandatory, after an ECS is frozen or unfrozen.

Range

  • normal: The ECS is not frozen.
  • freeze: The ECS has been frozen.

    The freeze field is in the following format: freeze,<freezing-scenario>,<resource-release-status>.

    Freezing scenarios include:
    • arrear: frozen due to arrears
    • police: frozen for legal management
    • illegal: frozen due to abuse
    • verify: frozen due to incomplete real-name authentication
    The resource release status can be:
    • deletable: The resource is frozen and can be released.
    • not_delete: The instance is frozen and cannot be released.

metering.image_id

String

Definition

Specifies the image ID of the ECS.

Range

N/A

metering.imagetype

String

Definition

Specifies the image type.

Range

  • Public image (gold)
  • Private image (private)
  • Shared image (shared)
  • KooGallery image (market)

metering.resourcespeccode

String

Definition

Specifies the resource specifications of the ECS.

Range

N/A

metering.resourcetype

String

Definition

Specifies the resource type of the ECS.

Value 1 indicates ECSs.

Range

N/A

cascaded.instance_extrainfo

String

Definition

Specifies the extended information about the internal ECSs.

Range

N/A

image_name

String

Definition

Specifies the image name of the ECS.

Range

N/A

agency_name

String

Definition

Specifies the IAM agency name.

An agency is created by a tenant administrator on IAM to provide temporary credentials for ECSs to access cloud services.

Range

N/A

os_bit

String

Definition

OS bit

Range

32 or 64

os_type

String

Definition

Specifies the OS type.

Range

Linux or Windows

lockCheckEndpoint

String

Definition

Specifies the callback URL for checking whether ECS locking is enabled.

  • If ECS locking is enabled, the ECS is locked.
  • If ECS locking is disabled, the ECS is unlocked, and invalid locks are deleted.

Range

N/A

lockSource

String

Definition

Specifies the lock source.

  • Order lock (ORDER)

Range

N/A

lockSourceId

String

Definition

Specifies the ECS lock source ID.

If lockSource is set to ORDER, lockSourceId is the order ID.

Range

N/A

lockScene

String

Definition

Specifies the ECS lock type.

TO_PERIOD_LOCK: changing from pay-per-use to yearly/monthly

Range

N/A

virtual_env_type

String

Definition

  • If an ECS is created using an iOS image, the value of this parameter is IsoImage.
  • If an ECS is created using a non-iOS image, the value of this parameter is FusionCompute in versions earlier than 19.5.0, and this parameter will be unavailable in versions later than 19.5.0.
NOTE:

The virtual_env_type cannot be added, deleted, or modified.

Range

N/A

Table 6 sys_tags parameters

Parameter

Type

Description

key

String

Definition

Specifies the system tag key.

Range

N/A

value

String

Definition

Specifies the system tag value.

Range

N/A

Table 7 image parameters

Parameter

Type

Description

id

String

Definition

Specifies the image ID.

Range

N/A

Table 8 gpus parameters

Parameter

Type

Description

name

String

Definition

Specifies the GPU name.

Range

N/A

count

Integer

Definition

Specifies the number of GPUs.

Range

N/A

memory_mb

Integer

Definition

Specifies the GPU memory size, in MB.

Range

N/A

Table 9 asic_accelerators parameters

Parameter

Type

Description

name

String

Definition

Specifies the ASIC name.

Range

N/A

count

Integer

Definition

Specifies the number of ASICs.

Range

N/A

memory_mb

Integer

Definition

Specifies the ASIC memory size, in MB.

Range

N/A