调用 DescribeScheduledInstances 接口查询弹性预约单信息。 ## 调试 [去调试](https://api.volcengine.com/api-explorer/?action=DescribeScheduledInstances&groupName=%E5%AE%9E%E4%BE%8B&serviceCode=ecs&version=2020-04-01) ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string 必选 `示例值：DescribeScheduledInstances` 要执行的操作，取值：DescribeScheduledInstances。 **Version** string 必选 `示例值：2020-04-01` API的版本，取值：2020\-04\-01。 **DeliveryType** string `可选` `示例值：Reserve` 弹性预约实例\-时段型交付类型，取值： * Reserve（默认）：预约交付 * Immediate：立即交付

说明

仅ElasticScheduledInstanceType取值为Segmented时，需传入该参数。

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

**ElasticScheduledInstanceType** string `可选` `示例值：Esi` 弹性预约实例类型，取值： * Esi：弹性预约实例 * Segmented：弹性预约实例\-时段型

说明

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

**ImageId** string `可选` `示例值：image-3tefr6wgx63vj0******` 镜像ID。 **InstanceTypeIds.N** string[] `可选` `示例值：InstanceTypeIds.1=ecs.g3i.2xlarge&InstanceTypeIds.2=ecs.g3i.2xlarge` 根据实例规格过滤弹性预约单，最多支持100个。 * 参数 \-N：表示实例规格的序号。 * 多个规格之间用&分隔。 **KeyPairName** string `可选` `示例值：kp-test-123` 密钥对的名称。 **MaxResults** integer `可选` `示例值：10` 分页查询时设置的每页行数： * 最大值：100 * 默认值：10 **NextToken** string `可选` `示例值：--` 分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。 **ProjectName** string `可选` `示例值：default` 资源所属项目一个资源只能归属于一个项目。 * 只能包含字母、数字、下划线“_”、点“.”和中划线“\-”。 * 长度限制在64个字符以内。 **ScheduledInstanceIds.N** string[] `可选` `示例值：ScheduledInstanceIds.1=si-3tiefmkskq3vj0x0****&ScheduledInstanceIds.2=esi-ycqweb5q3oa8j6lr****` 弹性预约单ID，最多支持100个。 * 参数 \-N：表示预约单ID的序号。 * 多个ID之间用&分隔。 **ScheduledInstanceName** string `可选` `示例值：ESI-Name` 弹性预约单名称，取值： * 不能以数字、中划线、下划线开头。 * 只能包含中文、字母、数字、下划线和中划线。 * 长度限制为1～128个字符。 * 暂不支持特殊字符。 **Status** string `可选` `示例值：CREATING` 预约单的状态，取值： * CREATING：创建中 * PENDING：待交付 * DELIVERING：交付中 * DELIVERED：已交付 * FAILED：交付失败 * PART_FAILED：部分交付失败 * INVALID：已失效 * CANCELED: 已取消 **TagFilters.N.Key** string[] `可选` `示例值：TagFilters.1.Key=k1` 用户标签的标签键。 * 参数 \- N：表示标签键的序号，取值范围：1～10。 * 多个标签键之间用&分隔，不允许重复。 **TagFilters.N.Values.N** string[] `可选` `示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2` 用户标签的标签值。 * 第一个N：表示标签键的序号，取值范围：1～10。 * 第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值， * 多个标签值之间用&分隔。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

不传则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

**ZoneId** string `可选` `示例值：cn-beijing-a` 实例所在可用区ID。您可以调用[DescribeZones](https://www.volcengine.com/docs/6396/120518)查询一个地域下的可用区信息。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **NextToken** string `示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******` 本次调用返回的查询凭证值，返回为空表示该页为末页。 **ScheduledInstanceInfo** object[] `示例值：--` 符合条件的弹性预约单信息。 **AutoReleaseAt** string `示例值：2024-01-04T23:00:00+08:00` 实例自动释放时间。 **Count** integer `示例值：3` 实例数量。 **CreatedAt** string `示例值：2024-01-04T14:32:58+08:00` 弹性预约单创建时间。 **DeliveryCount** integer `示例值：3` 已交付实例数量。 **DeliveryType** string `示例值：Reserve` 弹性预约实例\-时段型交付类型。 **ElasticScheduledInstanceType** string `示例值：Esi` 弹性预约实例类型。 **EndDeliveryAt** string `示例值：2024-01-04T14:50:00+08:00` 实例结束交付时间。 **InstanceConfig** object `示例值：--` 弹性预约单的实例配置信息。 **HpcClusterId** string `示例值：hpcCluster-ybo1y364wkf80o0m****` 高性能计算集群ID。 **Description** string `示例值：用于测试的云服务器实例` 实例的描述信息。 **EipAddress** object `示例值：--` 实例绑定的公网IP信息。 **BandwidthMbps** integer `示例值：5` 公网IP的带宽上限，单位为Mbps。 * 默认值：1 * 取值范围： * `ChargeType`取值为`PayByBandwidth`：取值范围1～500。 * `ChargeType`取值为`PayByTraffic`：取值范围1～200。 **BandwidthPackageId** string `示例值：bwp-2zeo05qre24nhrqpy****` 共享带宽包的ID。 **ChargeType** string `示例值：PayByBandwidth` 公网IP的计量方式，取值： * PayByBandwidth（默认）：按量计费\-按带宽上限计费。 * PayByTraffic：按量计费\-按实际流量计费。 * PrePaid：包年包月。 **ISP** string `示例值：BGP` 线路类型，取值： * BGP（默认）：BGP（多线）。 * 若您的账号已申请并开通了静态单线权限，则可传入如下取值： * ChinaMobile：中国移动静态单线。 * ChinaTelecom：中国电信静态单线。 * ChinaUnicom：中国联通静态单线。 * 若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。 * 若您的账号已申请并开通了静态BGP权限，则可传入Static_BGP。 **ReleaseWithInstance** boolean `示例值：true` 公网IP是否随实例删除，仅按量计费公网IP生效。取值： * true：公网IP随实例删除。当实例被系统自动回收（退订24小时后、到期回收等）或被调用[DeleteInstance](https://www.volcengine.com/docs/6396/70465)、[DeleteInstances](https://www.volcengine.com/docs/6396/101070)接口删除时，公网IP随实例一同释放。 * false：公网IP不随实例删除。 **SecurityProtectionInstanceId** string `示例值：20` 绑定安全防护包的ID。仅`SecurityProtectionTypes`不为空时返回该参数。 **SecurityProtectionTypes** string[] `示例值：AntiDDoS_Enhanced` 公网IP的安全防护类型。 * AntiDDoS_Enhanced：增强防护类型的公网IP（可加入到DDoS原生防护（企业版）实例）。 * 空值：基础防护类型的公网IP。 **HostName** string `示例值：instance-host-name` 实例主机名。 **ImageId** string `示例值：image-yctfez5q0e5pkg0f****` 镜像ID。 **InstanceName** string `示例值：ECS-qJsO` 实例名称。 **InstanceTypeId** string `示例值：ecs.c3i.xlarge` 实例规格。 **KeyPairName** string `示例值：kp-test-123` 密钥对名称。 **NetworkInterfacesRes** object[] `示例值：--` 实例挂载的网卡信息。 **SecurityGroupIds** string[] `示例值：sg-12b0uab1j62gw17q7y38d****` 网卡关联的安全组ID。 **SubnetId** string `示例值：subnet-2ff2xcgobksn459gp67cp****` 实例的私有网络子网ID。 **ProjectName** string `示例值：default` 实例所属项目。 **Tags** object[] `示例值：--` 实例的标签信息。 **Key** string `示例值：k1` 资源的标签键。 **Value** string `示例值：v1` 资源的标签值。 **Volumes** object[] `示例值：--` 实例挂载的云盘信息。 **Kind** string `示例值：system` 云盘种类，取值： * system：系统盘 * data：数据盘 **Size** integer `示例值：2048` 云盘容量，单位为GiB。 **VolumeType** string `示例值：ESSD_PL0` 云盘类型，取值： * ESSD_PL0：极速型SSD PL0 * ESSD_FlexPL：极速型SSD FlexPL **ZoneId** string `示例值：cn-beijing-a` 弹性预约单所在的可用区ID。 **InvalidAt** string `示例值：--` 弹性预约单失效时间。 **ProjectName** string `示例值：default` 弹性预约单所属项目。 **ReleaseCount** integer `示例值：0` 已释放实例数量。 **ScheduledInstanceDescription** string `示例值：用于测试的弹性预约单` 弹性预约单描述。 **ScheduledInstanceId** string `示例值：esi-ycvye5a380l8j1ld****` 弹性预约单ID。 **ScheduledInstanceName** string `示例值：ESI-Name` 弹性预约单名称。 **StartDeliveryAt** string `示例值：2024-01-04T14:40:00+08:00` 实例开始交付时间。 **Status** string `示例值：CREATING` 弹性预约单的状态。 **Tags** object[] `示例值：--` 弹性预约单的标签信息。 **Key** string `示例值：k1` 资源的标签键。 **Value** string `示例值：v1` 资源的标签值。 **UpdatedAt** string `示例值：2024-01-04T15:35:15+08:00` 弹性预约单更新时间。 **ZoneId** string `示例值：cn-beijing-a` 弹性预约单所在的可用区ID。 ## 请求示例 ```text GET /?Action=DescribeScheduledInstances&Version=2020-04-01&ScheduledInstanceIds.1=esi-ycvye5a380l8j1ld****&ElasticScheduledInstanceType=Segmented&DeliveryType=Reserve HTTP/1.1 Host: ecs.cn-beijing.volcengineapi.com Region: cn-beijing ServiceName: ecs ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20240104180821CDEEFD683593D54D****", "Action": "DescribeScheduledInstances", "Version": "2020-04-01", "Service": "ecs", "Region": "cn-beijing" }, "Result": { "ScheduledInstanceInfo": [ { "CreatedAt": "2024-01-04T14:32:58+08:00", "UpdatedAt": "2024-01-04T15:35:15+08:00", "ScheduledInstanceId": "esi-ycvye5a380l8j1ld****", "ZoneId": "cn-beijing-a", "ScheduledInstanceDescription": "用于测试的弹性预约单", "Status": "DELIVERED", "ScheduledInstanceName": "ESI-Name", "StartDeliveryAt": "2024-01-04T14:40:00+08:00", "EndDeliveryAt": "2024-01-04T14:50:00+08:00", "Count": 3, "DeliveryCount": 3, "ReleaseCount": 0, "InvalidAt": "", "ElasticScheduledInstanceType": "Segmented", "AutoReleaseAt": "2024-01-04T23:00:00+08:00", "ProjectName": "default", "Tags": [], "InstanceConfig": { "ZoneId": "cn-beijing-a", "InstanceTypeId": "ecs.c3i.xlarge", "ImageId": "image-yctfez5q0e5pkg0f****", "InstanceName": "ECS-qJsO", "Description": "", "HpcClusterId": "", "Hostname": "instance-host-name", "KeyPairName": "kp-test-123", "ProjectName": "default", "Tags": [], "Volumes": [ { "VolumeType": "ESSD_PL0", "Size": 40, "Kind": "system" } ], "NetworkInterfacesRes": [ { "SubnetId": "subnet-2ff2xcgobksn459gp67cp****", "SecurityGroupIds": [ "sg-12b0uab1j62gw17q7y38d****" ] } ], "EipAddress": { "AllocationId": "eip-2749d8a20h4hs7fap8taa****", "ISP": "BGP", "BandwidthMbps": 1, "ChargeType": "PayByTraffic", "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****", "ReleaseWithInstance": "true", "SecurityProtectionTypes": [] } }, "DeliveryType": "Reserve" } ], "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******" } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6396/70462)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |InvalidTagFilterKey.Malformed |The specified TagFilterKey is malformed. |指定的查询标签的键格式错误。 | |400 |InvalidTagFilterValue.Malformed |The specified TagFilterValue is malformed. |指定的查询标签的值格式错误。 | |400 |LimitExceeded.MaximumInstanceTypeIds |You've reached the limit on the number of InstanceTypeIds that you can set. |指定的InstanceTypeIds数量超过最大限制。 | |400 |LimitExceeded.MaximumScheduledInstanceIds |The number of specified ScheduledInstanceIds exceeds the maximum limit. |指定的ScheduledInstanceIds超过最大限制。 | |400 |LimitExceeded.MaximumTagFilterKeys |You've reached the limit on the number of TagFilterKeys that you can set. |指定的查询标签键超出取值范围。 | |400 |LimitExceeded.MaximumTagFilterResults |You've reached the limit on the number of resources that you can describe by TagFilters. |通过标签过滤出的资源数量超过上限。 | |400 |LimitExceeded.MaximumTagFilterValues |You've reached the limit on the number of TagFilterValues that you can set. |指定的查询标签值超出取值范围。 | |404 |InvalidActionOrVersion |Could not find operation %s for version %s. |请求接口不存在。 | |409 |InvalidTagFilterKey.Conflict |The specified TagFilterKey already exists. |指定的过滤标签键已存在。 | |500 |InternalError |An internal error has occurred. |内部错误，请重试。如果多次尝试失败，请提交工单。 |