DescribeDemands - - 阿里云

接口说明

您可通过该接口查询阿里云为您报备的资源详情，包括报备资源类型、资源的交付情况以及资源的消费情况。

默认查询I/O优化实例规格，以及专有网络VPC类型的ECS实例的报备表单状态。

如果您需要获取关于创建ECS资源需求报备信息（CreateDemand）、修改ECS资源需求报备信息（ModifyDemand）及删除ECS资源需求报备信息（DeleteDemand）的相关信息，请联系您对应的客户经理。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDemands	系统必选参数。取值：DescribeDemands。
RegionId	String	是	cn-hangzhou	目标地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
PageNumber	Integer	否	1	报备单列表的页码。起始值：1。默认值：1。
PageSize	Integer	否	10	分页查询时设置的每页行数。最大值：100。默认值：10。
DryRun	Boolean	否	false	是否只预检此次请求。取值范围： true：发送检查请求，不会查询报备单状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码DryRunOperation。 false（默认值）：发送正常请求，通过检查后返回2XX HTTP状态码并直接查询报备单状况。
Tag.N.Key	String	否	TestKey	说明该参数暂未开放使用。
Tag.N.Value	String	否	TestValue	说明该参数暂未开放使用。
ZoneId	String	否	cn-hangzhou-g	可用区ID。更多详情，请参见DescribeZones获取可用区列表。
DemandId	String	否	ed-bp11n21kq00sl71p****	报备ID。指定该参数后，将忽略其他非必选请求参数。
InstanceTypeFamily	String	否	ecs.g6	报备实例的规格族。
InstanceType	String	否	ecs.g6.xlarge	报备实例的规格。
InstanceChargeType	String	否	PostPaid	实例的计费方式。取值范围： PostPaid：按量付费。 PrePaid：包年包月。
DemandType	String	否	Custom	报备实例来源。取值范围： Custom：自助报备。 System（默认）：阿里云协助报备。
DemandStatus.N	String	否	Active	报备单或资源使用状态。取值范围： Creating：报备单创建中。 Active：资源供应中。 Expired：报备单已过期。 Finished：消费完毕。 Refused：报备拒绝，具体原因请查看返回参数`Comment`。 Cancelled：报备取消。

返回数据

名称	类型	示例值	描述
PageSize	Integer	10	输入时设置的每页行数。
PageNumber	Integer	1	报备单列表的页码。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
TotalCount	Integer	6	查询到的报备单数量。
RegionId	String	cn-hangzhou	查询的地域。
Demands	Array of Demand		指定地域符合过滤条件的报备单集合。
Demand
Comment	String	test-for-comment	资源报备被拒绝的反馈建议。
DemandDescription	String	test-DemandDescription	报备描述。
DemandId	String	ed-bp11n21kq00sl71p****	报备ID。
DemandTime	String	2019-02-26T12:00:00Z	报备单创建时间。按照ISO 8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
InstanceType	String	ecs.g6.xlarge	报备的实例规格。
DemandName	String	k8s-node-demand	报备名称。
Period	Integer	3	报备资源的使用时长。
InstanceChargeType	String	Prepaid	报备资源的付费类型。可能值： Prepaid：包年包月。 Postpaid：按量付费。
AvailableAmount	Integer	10	报备资源当前可使用实例数量。
EndTime	String	2019-03-03T15:00:00Z	报备资源预期截止购买时间。按照ISO 8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
StartTime	String	2019-02-27T12:00:00Z	报备资源预期开始购买时间。按照ISO 8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
PeriodUnit	String	Month	报备资源的使用时长单位。可能值： Hour：小时。 Day：天。 Month：月。
ZoneId	String	cn-hangzhou-g	报备资源所在的可用区。
UsedAmount	Integer	20	已经消耗的实例数。
TotalAmount	Integer	50	报备的实例数。
DeliveringAmount	Integer	20	报备资源中待交付实例数量。
InstanceTypeFamily	String	ecs.g6	报备实例所属的规格族。
DemandStatus	String	Active	报备单或资源使用的状态。可能值： Creating：报备单创建中。 Active：资源供应中。 Expired：报备单已过期。 Finished：消费完毕。 Refused：报备拒绝，具体原因请查看参数`comment`。 Cancelled：报备取消，报备资源已取消。报备取消后，资源交付状态无效。
SupplyInfos	Array of SupplyInfo		报备资源的交付状态。
SupplyInfo
Amount	Integer	30	交付的实例数量。
SupplyStatus	String	Delivering	资源交付状态。可能值： Delivered ：已交付。 Delivering：交付中。
SupplyStartTime	String	2019-03-01T14:00:00Z	资源交付可用的开始时间。按照ISO 8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
SupplyEndTime	String	2019-03-03T15:00:00Z	资源交付可用的截止时间。按照ISO 8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
PrivatePoolId	String	crp-bp1fv8sbhelbzjwx****	需求单对应的私有池ID。

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeDemands
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDemandsResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>6</TotalCount>
    <RegionId>cn-hangzhou</RegionId>
    <Demands>
        <Comment>test-for-comment</Comment>
        <DemandDescription>test-DemandDescription</DemandDescription>
        <DemandId>ed-bp11n21kq00sl71p****</DemandId>
        <DemandTime>2019-02-26T12:00:00Z</DemandTime>
        <InstanceType>ecs.g6.xlarge</InstanceType>
        <DemandName>k8s-node-demand</DemandName>
        <Period>3</Period>
        <InstanceChargeType>Prepaid</InstanceChargeType>
        <AvailableAmount>10</AvailableAmount>
        <EndTime>2019-03-03T15:00:00Z</EndTime>
        <StartTime>2019-02-27T12:00:00Z</StartTime>
        <PeriodUnit>Month</PeriodUnit>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <UsedAmount>20</UsedAmount>
        <TotalAmount>50</TotalAmount>
        <DeliveringAmount>20</DeliveringAmount>
        <InstanceTypeFamily>ecs.g6</InstanceTypeFamily>
        <DemandStatus>Active</DemandStatus>
        <SupplyInfos>
            <Amount>30</Amount>
            <SupplyStatus>Delivering</SupplyStatus>
            <SupplyStartTime>2019-03-01T14:00:00Z</SupplyStartTime>
            <SupplyEndTime>2019-03-03T15:00:00Z</SupplyEndTime>
            <PrivatePoolId>crp-bp1fv8sbhelbzjwx****</PrivatePoolId>
        </SupplyInfos>
    </Demands>
</DescribeDemandsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 6,
  "RegionId" : "cn-hangzhou",
  "Demands" : [ {
    "Comment" : "test-for-comment",
    "DemandDescription" : "test-DemandDescription",
    "DemandId" : "ed-bp11n21kq00sl71p****",
    "DemandTime" : "2019-02-26T12:00:00Z",
    "InstanceType" : "ecs.g6.xlarge",
    "DemandName" : "k8s-node-demand",
    "Period" : 3,
    "InstanceChargeType" : "Prepaid",
    "AvailableAmount" : 10,
    "EndTime" : "2019-03-03T15:00:00Z",
    "StartTime" : "2019-02-27T12:00:00Z",
    "PeriodUnit" : "Month",
    "ZoneId" : "cn-hangzhou-g",
    "UsedAmount" : 20,
    "TotalAmount" : 50,
    "DeliveringAmount" : 20,
    "InstanceTypeFamily" : "ecs.g6",
    "DemandStatus" : "Active",
    "SupplyInfos" : [ {
      "Amount" : 30,
      "SupplyStatus" : "Delivering",
      "SupplyStartTime" : "2019-03-01T14:00:00Z",
      "SupplyEndTime" : "2019-03-03T15:00:00Z",
      "PrivatePoolId" : "crp-bp1fv8sbhelbzjwx****"
    } ]
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	MissingParamter.RegionId	The regionId should not be null.	参数 RegionId 不得为空。
404	InvalidInstanceChargeType.NotFound	The InstanceChargeType does not exist in our records.	指定的实例计费方式不存在。
404	InvalidZone.NotFound	The ZoneId provided does not exist in our records.	指定的zoneId不存在
404	InvalidDemandId.NotFound	The specified DemandId is not found.	输入的报备单ID不存在。

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