You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
实例
DescribeScheduledInstanceStock - 查询弹性预约实例预约情况
复制全文
下载 pdf
DescribeScheduledInstanceStock - 查询弹性预约实例预约情况
调用 DescribeScheduledInstanceStock 接口查询弹性预约实例可预约时间段。​
请求说明​
该接口当前仅支持根据资源交付时间段返回预约情况,返回结果说明如下:​
说明​
弹性预约实例-时段型正在邀测中,如需试用,请联系客户经理申请。​
​
返回字段​
预约状态​
Esi(弹性预约实例)​
Status(库存预约状态)​
AVAILABLE​
该时间段未约满,可预约。请调用DescribeAvailableResource接口查询实例库存是否充足。​
该时间段未约满,可预约。下单时是否可预约成功,还与实际选择的自动释放时间有关。​
​
NOT_AVAILABLE​
该时间段已约满,不可预约,请选择其它时间段预约。​
​
ReleaseStatus(释放预约状态)​
AVAILABLE​
不涉及自动释放,返回为空。​
该时间段未约满,可预约。​
​
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 object[] 示例值:--​
符合条件的预约信息。​
ReleaseStatus string 示例值:AVAILABLE​
当前时间段释放预约状态,取值:​
  • AVAILABLE:未约满,可预约。​
  • NOT_AVAILABLE:已约满,请选择其它时间段预约。​
说明​
若查询的ElasticScheduledInstanceType为Esi,该参数返回为空。​
​
EndDeliveryAt string 示例值:2024-01-04T18:30:00+08:00​
实例结束交付时间。​
​
StartDeliveryAt string 示例值:2024-01-04T18:20:00+08:00​
实例开始交付时间。​
​
Status string 示例值:AVAILABLE​
当前时间段库存预约状态,取值:​
  • AVAILABLE:未约满,可预约。​
  • 若查询的ElasticScheduledInstanceType为Segmented,下单时是否可预约成功,还与实际选择的自动释放时间有关。​
  • NOT_AVAILABLE:已约满,请选择其它时间段预约。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeScheduledInstanceStock&Version=2020-04-01&ElasticScheduledInstanceType=Segmented&InstanceTypeId=ecs.g3i.xlarge&ZoneId=cn-beijing-a&VolumeType=ESSD_PL0 HTTP/1.1​
Host: ecs.cn-beijing.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",​
"ReleaseStatus": "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.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2025.09.04 16:59:42
这个页面对您有帮助吗?
有用
有用
无用
无用