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

Data Structure for Querying Details About ECSs

Table 1 address parameters

Parameter

Type

Description

version

String

Specifies the IP address version.

  • 4: indicates IPv4.
  • 6: indicates IPv6.

addr

String

Specifies the IP address.

primary

Boolean

Specifies whether the NIC is a primary NIC.

  • true: The NIC is a primary NIC.
  • false: The NIC is a supplementary NIC.

OS-EXT-IPS:type

String

Specifies the IP address type.

  • fixed: indicates the private IP address.
  • floating: indicates the floating IP address.

OS-EXT-IPS-MAC:mac_addr

String

Specifies the MAC address.

OS-EXT-IPS:port_id

String

Specifies the port ID corresponding to the IP address.

Table 2 flavor parameters

Parameter

Type

Description

id

String

Specifies the ECS flavor ID.

name

String

Specifies the ECS flavor name.

disk

String

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.

vcpus

String

Specifies the number of vCPUs in the ECS flavor.

ram

String

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

gpus

Array of objects

Specifies the GPU information in the ECS flavor.

For details, see Table 8.

asic_accelerators

Array of objects

Specifies the ASIC information in the ECS flavor.

For details, see Table 9.

Table 3 security_groups parameters

Parameter

Type

Description

name

String

Specifies the security group name or UUID.

id

String

Specifies the security group ID.

Table 4 os-extended-volumes:volumes_attached parameters

Parameter

Type

Description

id

String

Specifies the disk ID in UUID format.

delete_on_termination

String

Specifies whether the disk is deleted with the ECS.

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

This parameter is supported in microversion 2.3 and later.

bootIndex

String

Specifies the EVS disk boot sequence.

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

device

String

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

Table 5 metadata parameters

Parameter

Type

Description

charging_mode

String

Specifies the ECS billing mode.

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

metering.order_id

String

Specifies the order ID for a yearly/monthly ECS.

metering.product_id

String

Specifies the product ID for a yearly/monthly ECS.

vpc_id

String

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

EcmResStatus

String

Specifies the ECS frozen status.

  • 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.
NOTE:

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

metering.image_id

String

Specifies the image ID of the ECS.

metering.imagetype

String

Specifies the image type. The following types are supported:

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

metering.resourcespeccode

String

Specifies the resource specifications of the ECS.

metering.resourcetype

String

Specifies the resource type of the ECS.

Value 1 indicates ECSs.

cascaded.instance_extrainfo

String

Specifies the extended information about the internal ECSs.

image_name

String

Specifies the image name of the ECS.

agency_name

String

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.

os_bit

String

Specifies the number of bits in the operating system: 32 or 64.

os_type

String

Specifies the OS type. The value can be Linux or Windows.

lockCheckEndpoint

String

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.

lockSource

String

Specifies the lock source.

  • Order lock (ORDER)

lockSourceId

String

Specifies the ECS lock source ID.

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

lockScene

String

Specifies the ECS lock type.

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

virtual_env_type

String

  • 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.
Table 6 sys_tags parameters

Parameter

Type

Description

key

String

Specifies the system tag key.

value

String

Specifies the system tag value.

Table 7 image parameters

Parameter

Type

Description

id

String

Specifies the image ID.

Table 8 gpus parameters

Parameter

Type

Description

name

String

Specifies the GPU name.

count

Integer

Specifies the number of GPUs.

memory_mb

Integer

Specifies the GPU memory size, in MB.

Table 9 asic_accelerators parameters

Parameter

Type

Description

name

String

Specifies the ASIC name.

count

Integer

Specifies the number of ASICs.

memory_mb

Integer

Specifies the ASIC memory size, in MB.