调用DescribeDemands查询报备资源的交付及使用状态。您可通过该接口查询客户经理为您报备的资源详情,包括报备资源类型、资源的交付情况、资源的消费情况。

接口说明

仅支持报备I/O优化,专有网络VPC类型的ECS实例。默认查询I/O优化,VPC网络类型的ECS实例的报备单状态。

说明 该接口正在内测调整中,尚未正式上线,暂时不建议使用,请您耐心等待。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

目标地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

Action String DescribeDemands

接口名称。取值:DescribeDemands

DemandStatus.N RepeatList Active

报备单状态。取值范围:

  • Creating:报备单创建中
  • Active:供应中
  • Expired:已过期
  • Finished:消费完毕
  • Cancelled:报备取消
DryRun Boolean false

是否只预检此次请求。

  • true:发送检查请求,不会查询报备单状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。
  • false(默认值):发送正常请求,通过检查后返回2XX HTTP状态码并直接查询报备单状况。
InstanceChargeType String PostPaid

实例的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月
InstanceType String ecs.g5.large

报备实例的规格。

InstanceTypeFamily String ecs.g5

报备实例的规格族。

PageNumber Integer 1

报备单列表的页码。起始值:1

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。最大值:100

默认值:10

ZoneId String cn-hangzhou-g

可用区ID。

返回数据

名称 类型 示例值 描述
Demands

指定地域符合过滤条件的报备单

AvailableAmount Integer 10

报备资源当前可使用实例数量

DeliveringAmount Integer 20

报备资源中待交付实例数量

DemandStatus String Active

报备单的状态。可能值:

  • Creating:报备资源创建中
  • Active:报备资源供应中
  • Finished:报备资源已消费完毕
  • Expired:报备时期望购买时间已过期,过期后报备资源会释放,资源交付状态无效
  • Cancelled:报备资源已取消,报备取消后,资源交付状态无效
DemandTime String 2019-02-26T12:00Z

报备单创建时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

EndTime String 2019-03-03T15:00Z

报备资源预期截止购买时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

InstanceChargeType String Prepaid

报备资源的付费类型。可能值:

  • Prepaid
  • Postpaid
InstanceType String ecs.g5.xlarge

报备的实例规格。

InstanceTypeFamily String ecs.g5

报备实例所属的规格族。

Period Integer 3

报备资源的使用时长。

PeriodUnit String Month

报备资源的使用时长单位。

  • Hour
  • Day
  • Month
StartTime String 2019-02-27T12:00Z

报备资源预期开始购买时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

SupplyInfos

报备资源的交付状态

Amount Integer 30

本次交付的实例数量。

SupplyEndTime String 2019-03-03T15:00Z

资源交付可用的截止时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

SupplyStartTime String 2019-03-01T14:00Z

资源交付可用的开始时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

SupplyStatus String Delivering

资源交付状态。

  • Delivered :已交付
  • Delivering:交付中
TotalAmount Integer 50

报备的实例数

UsedAmount Integer 20

已经消耗的实例数

ZoneId String cn-hangzhou-g

报备资源所在的可用区

PageNumber Integer 1

报备单列表的页码。

PageSize Integer 10

输入时设置的每页行数

RegionId String cn-hangzhou

查询的地域

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID

TotalCount Integer 6

查询到的报备单数量

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeDemands
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDemandsResponse>
    <Demands>
        <AvailableAmount>0</AvailableAmount>
        <DeliveringAmount>50</DeliveringAmount>
        <DemandStatus>Expired</DemandStatus>
        <DemandTime>2019-02-26T12:00Z</DemandTime>
        <EndTime>2019-03-03T15:00Z</EndTime>
        <InstanceChargeType>PrePaid</InstanceChargeType>
        <InstanceType>ecs.g5.4xlarge</InstanceType>
        <InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
        <Period>3</Period>
        <PeriodUnit>Month</PeriodUnit>
        <StartTime>2019-02-27T12:00Z</StartTime>
        <SupplyInfos>
            <Amount>50</Amount>
            <SupplyEndTime>2019-03-03T15:00Z</SupplyEndTime>
            <SupplyStartTime>2019-03-01T14:00Z</SupplyStartTime>
            <SupplyStatus>Delivering</SupplyStatus>
        </SupplyInfos>
        <TotalAmount>50</TotalAmount>
        <UsedAmount>0</UsedAmount>
        <ZoneId>cn-hangzhou-g</ZoneId>
    </Demands>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <RegionId>cn-hangzhou</RegionId>
    <RequestId>04066112-BF3A-4FCD-ABBD-B4B5EDAE9DXX</RequestId>
    <TotalCount>1</TotalCount>
</DescribeDemandsResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"Demands":[
		{
			"Period":3,
			"DemandTime":"2019-02-26T12:00Z",
			"InstanceTypeFamily":"ecs.g5",
			"AvailableAmount":0,
			"ZoneId":"cn-hangzhou-g",
			"UsedAmount":0,
			"DeliveringAmount":50,
			"InstanceType":"ecs.g5.4xlarge",
			"DemandStatus":"Expired",
			"EndTime":"2019-03-03T15:00Z",
			"TotalAmount":50,
			"StartTime":"2019-02-27T12:00Z",
			"SupplyInfos":[
				{
					"Amount":"50",
					"SupplyStartTime":"2019-03-01T14:00Z",
					"SupplyEndTime":"2019-03-03T15:00Z",
					"SupplyStatus":"Delivering"
				}
			],
			"InstanceChargeType":"PrePaid",
			"PeriodUnit":"Month"
		}
	],
	"RequestId":"04066112-BF3A-4FCD-ABBD-B4B5EDAE9DXX",
	"RegionId":"cn-hangzhou"
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParamter.RegionId The regionId should not be null. 参数 RegionId 不得为空。
404 InvalidInstanceChargeType.NotFound The InstanceChargeType does not exist in our records 指定的实例升降配规格不存在。

访问错误中心查看更多错误码。