DescribeScheduledInstanceStock - 查询弹性预约实例预约情况--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeScheduledInstanceStock - 查询弹性预约实例预约情况

最近更新时间：2024.09.26 11:00:22首次发布时间：2024.01.12 08:04:20

调用 DescribeScheduledInstanceStock 接口查询弹性预约实例可预约时间段。

请求说明

该接口当前仅支持根据资源交付时间段返回预约情况，返回结果说明如下：

说明

弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。

预约状态	Esi（弹性预约实例）	Segmented（弹性预约实例-时段型）
AVAILABLE	该时间段未约满，可预约。请调用DescribeAvailableResource接口查询实例库存是否充足。	该时间段未约满，可预约。下单时是否可预约成功，还与实际选择的自动释放时间有关。
NOT_AVAILABLE	该时间段已约满，不可预约，请选择其它时间段预约。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeScheduledInstanceStock	要执行的操作，取值：DescribeScheduledInstanceStock。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
DeliveryType	String	否	Reserve	弹性预约实例-时段型交付类型，取值： Reserve（默认）：预约交付 Immediate：立即交付说明仅`ElasticScheduledInstanceType`为`Segmented`时该参数生效。弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。
ElasticScheduledInstanceType	String	否	Esi	弹性预约实例类型，取值： Esi（默认）：弹性预约实例 Segmented：弹性预约实例-时段型说明弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。
InstanceTypeId	String	否	ecs.g3i.xlarge	实例规格。 `ElasticScheduledInstanceType`为`Segmented`时，该参数必填。表示查询当前规格的弹性预约实例-时段型的预约及库存情况。说明弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。
VolumeType	String	否	ESSD_PL0	指定一个要查询的云盘类型，取值： ESSD_PL0：极速型SSD PL0 ESSD_FlexPL：极速型SSD FlexPL
ZoneId	String	否	cn-beijing-a	实例所在可用区ID。您可以调用DescribeZones查询一个地域下的可用区信息。说明 `ElasticScheduledInstanceType`为`Segmented`时，该参数必填。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ScheduledInstanceStock	Array of Object	--	符合条件的预约信息。

请求示例

GET /?Action=DescribeScheduledInstanceStock&Version=2020-04-01&ElasticScheduledInstanceType=Segmented&InstanceTypeId=ecs.g3i.xlarge&ZoneId=cn-beijing-a&VolumeType=ESSD_PL0 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401041812061F86A29C5B0D3267****",
        "Action": "DescribeScheduledInstanceStock",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScheduledInstanceStock": [
            {
                "StartDeliveryAt": "2024-01-04T18:20:00+08:00",
                "EndDeliveryAt": "2024-01-04T18:30:00+08:00",
                "Status": "AVAILABLE"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDeliveryType.Malformed	The specified DeliveryType is malformed.	指定的交付类型不合法。
400	InvalidElasticScheduledInstanceType.Malformed	The specified ElasticScheduledInstanceType is malformed.	指定的弹性预约实例类型不合法。
400	InvalidInstanceTypeId.Malformed	The specified InstanceTypeId is malformed.	指定的规格ID不合法。
400	InvalidVolumeType.Malformed	The specified VolumeType is malformed.	指定的云盘类型不合法。
400	InvalidZoneId.Malformed	The specified ZoneId is malformed.	指定的可用区ID不合法。
404	InvalidInstanceType.NotFound	The specified InstanceType does not exist.	指定的实例规格不存在。
404	InvalidZone.NotFound	The specified zone does not exist.	指定的可用区不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。