Call the DescribeScheduledInstanceStock operation to query the available reservation time slots for Elastic Scheduled Instances (ESIs).

Request description

Currently, this operation only returns reservation status based on the resource delivery time period. The following table describes the return value.

Return field	Reservation status	ESI (Elastic Scheduled Instance)	Segmented (Elastic Scheduled Instances-Segmented)
Status (stock reservation status)	AVAILABLE	This time slot is not fully booked and is available for reservation. Call the DescribeAvailableResource operation to check whether instance stock is sufficient.	This time slot is not fully booked and is available for reservation. Whether a reservation can be successfully made when an order is placed also depends on the actual automatic release time selected.
Status (stock reservation status)		NOT_AVAILABLE	This time slot is fully booked and unavailable for reservation. Select another time slot.
ReleaseStatus (release reservation status)	AVAILABLE	No automatic release is involved. The return value is empty.	This time slot is not fully booked and is available for reservation.
ReleaseStatus (release reservation status)			NOT_AVAILABLE	This time slot is fully booked and unavailable for reservation. Select another time slot.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The table below lists only the request parameters specific to this operation and some common parameters. For more information, refer to Common parameters.

Action string required Sample value: DescribeScheduledInstanceStock

The operation that you want to perform. Valid value: DescribeScheduledInstanceStock.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

DeliveryType string Optional Sample value: Reserve

The delivery type of Elastic Scheduled Instances-Segmented. Valid values:

Reserve (default): Scheduled delivery

Immediate: Immediate delivery

tip

When ElasticScheduledInstanceType is set to Segmented, this parameter takes effect.

This feature is currently in Beta. If you need a trial, contact the account manager to apply.

ElasticScheduledInstanceType string Optional Sample value: Esi

The ESI type. Value:

Esi (default): Elastic Scheduled Instances (ESI)

Segmented: Elastic Scheduled Instances-Segmented

tip

This feature is currently in Beta. If you need a trial, contact the account manager to apply.

InstanceTypeId string Optional Sample value: ecs.g3i.xlarge

Instance type.

When ElasticScheduledInstanceType is set to Segmented, this parameter is required. This parameter specifies that the reservation and stock status of Elastic Scheduled Instances-Segmented with the current instance type are queried.

tip

This feature is currently in Beta. If you need a trial, contact the account manager to apply.

VolumeType string Optional Sample value: ESSD_PL0

Specify the volume type to query. Valid values:

ESSD_PL0: ESSD PL0

ESSD_FlexPL: ESSD FlexPL

ZoneId string Optional Sample value: cn-beijing-a

The ID of the availability zone where the instance is located.

You can call the DescribeZones operation to query the availability zones in the same region.

tip

When ElasticScheduledInstanceType is set to Segmented, this parameter is required.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

ScheduledInstanceStock object[] Sample value: --

The information about the reservation that meets the conditions.

ReleaseStatus string Sample value: AVAILABLE

The release reservation status for the current time period. Valid values:

AVAILABLE: Not fully booked. Reservation is allowed.

NOT_AVAILABLE: Fully booked. Select another time period for reservation.

tip

If the value of ElasticScheduledInstanceType is Esi, the return value of this parameter is empty.

EndDeliveryAt string Sample value: 2024-01-04T18:30:00+08:00

The end time for instance delivery.

StartDeliveryAt string Sample value: 2024-01-04T18:20:00+08:00

The start time for instance delivery.

Status string Sample value: AVAILABLE

The reservation status of stock for the current time period. Valid values:

AVAILABLE: Not fully booked. Reservation is allowed.

If the value of ElasticScheduledInstanceType is Esi, you also need to call DescribeAvailableResource to query whether the instance stock is sufficient.

If the value of ElasticScheduledInstanceType is Segmented, whether a reservation can be made successfully when an order is placed also depends on the actual automatic release time selected.

NOT_AVAILABLE: Fully booked. Select another time period for reservation.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidDeliveryType.Malformed	The specified DeliveryType is malformed.	The specified delivery type is invalid.
400	InvalidElasticScheduledInstanceType.Malformed	The specified ElasticScheduledInstanceType is malformed.	The specified ESI type is invalid.
400	InvalidInstanceTypeId.Malformed	The specified InstanceTypeId is malformed.	The specified instance type ID is invalid.
400	InvalidVolumeType.Malformed	The specified VolumeType is malformed.	The specified volume type is invalid.
400	InvalidZoneId.Malformed	The specified ZoneId is malformed.	The specified availability zone ID is invalid.
404	InvalidInstanceType.NotFound	The specified InstanceType does not exist.	The specified instance type does not exist.
404	InvalidZone.NotFound	The specified zone does not exist.	The specified availability zone does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service