• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. ECSs
  6. Introduction

Introduction

Object

You can use the APIs to manage ECSs, including querying the ECS list, creating ECSs, querying details of an ECS, updating the configuration of an ECS, and deleting an ECS.

ECS Object Model

Table 1 lists ECS object models.

Table 1 ECS attributes

Attribute

Type

CRUD

Default Value

Restriction

Description

id

UUID

R

generated

N/A

Specifies the ECS universally unique identifier (UUID).

tenant_id

UUID

RC

N/A

Existing tenant IDs

Specifies the tenant UUID.

user_id

UUID

RC

N/A

Existing user IDs

Specifies the user UUID.

status

String

R

N/A

N/A

Specifies the ECS status.

updated

String

R

N/A

N/A

Specifies the last update time.

hostId

String

R

N/A

N/A

Specifies the host UUID.

OS-EXT-SRV-ATTR:host

String

R

N/A

Existing host names

Specifies the name of the physical host housing the ECS. This is an extended attribute.

addresses

List(Dict)

RCUD

N/A

N/A

Specifies the network attribute of the ECS.

links

List(Dict)

R

N/A

N/A

Specifies the ECS URI.

key_name

String

RCUD

N/A

Existing key pair names

Specifies the name of the key pair corresponding to the ECS.

image

List(Dict)

RC

N/A

N/A

Specifies the ECS image information.

OS-EXT-STS:task_state

String

R

N/A

N/A

Specifies the ECS task status. This is an extended attribute.

OS-EXT-STS:vm_state

String

R

N/A

N/A

Specifies the ECS status. This is an extended attribute.

OS-EXT-SRV-ATTR:instance_name

String

RCUD

N/A

N/A

Specifies the ECS alias. This is an extended attribute.

OS-EXT-SRV-ATTR:hypervisor_hostname

String

R

N/A

N/A

Specifies the name of the host accommodating the ECS.

flavor

List(Dict)

RCU

N/A

N/A

Specifies the ECS flavor.

security_groups

List(Dict)

RCUD

N/A

N/A

Specifies the security group that the ECS belongs to.

OS-EXT-AZ:availability_zone

String

R

N/A

N/A

Specifies the availability zone (AZ) that the ECS belongs to.

name

String

RCUD

N/A

N/A

Specifies the ECS name.

created

String

R

N/A

N/A

Specifies the time when the ECS is created.

OS-DCF:diskConfig

String

RCU

N/A

N/A

Specifies the disk configuration method. The value can be AUTO or MANUAL.

  • MANUAL: The image space of the system disk cannot be expanded.
  • AUTO: The image space of the system disk can be automatically expanded to a value same as that specified in flavor.

accessIPv4

String

R

N/A

N/A

Not used

accessIPv6

String

R

N/A

N/A

Not used

OS-EXT-STS:power_state

Int

R

N/A

N/A

Specifies the VM power supply status.

config_drive

Int

R

N/A

N/A

Specifies whether to attach the config_drive disk when the VM is created.

metadata

List(Dict)

RCUD

N/A

N/A

Specifies the VM metadata.

Table 2 VM status

Name

Description

ACTIVE

The VM is available.

BUILD

The initial creation process for the VM is not complete.

DELETED

The VM has been deleted.

ERROR

The VM status is incorrect.

HARD_REBOOT

The VM is hard restarting (restart the physical server by pressing the power switch).

PASSWORD

The VM password is being reset.

REBOOT

The VM is soft restarting (run the reboot command on the OS).

REBUILD

The VM is being rebuilt using images.

RESCUE

The VM is in the rescue mode.

RESIZE

The VM is in the flavor adjusting status.

REVERT_RESIZE

The VM is restarting using the initial configurations because the resizing and migration failed due to some reasons.

SHUTOFF

The VM is powered off.

SUSPENDED

The VM is suspended. Only the hypervisors, such as XenServer, XCP, KVM, and ESXi, can be suspended.

UNKNOWN

The VM status is unknown.

VERIFY_RESIZE

The VM is being confirmed after resizing and migration.