QueryOrders - 订单列表查询服务

更新时间:

查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单,如需查询更长时间范围的订单数据,请设CreateTimeStartCreateTimeEnd参数。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bss:DescribeOrderList

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

CreateTimeEnd

string

创建时间段止(缺省查询当前时间最近 1 小时内订单),格式:YYYY-MM-ddTHH:mm:ssZ,时区: UTC

2016-05-23T12:00:00Z

PageNum

integer

页码。

1

PageSize

integer

每页条数。

20

ProductCode

string

产品代码。

rds

ProductType

string

产品类型。

rds

SubscriptionType

string

订阅类型。取值类型:

  • Subscription:预付费。

  • PayAsYouGo:后付费。

Subscription

OrderType

string

订单类型,取值范围

  • New 新购

  • Renew 续费

  • Upgrade 升级

  • TempUpgrade 短时升级

  • Downgrade 降级

  • Refund 退款

  • Convert 付费类型转换

  • ResizeDisk 调整磁盘大小

  • CompensatoryRenew 补偿续费

  • IncreaseUpgrade 带宽升级

  • Exchange 换购

  • ChangeOperatingSystem 更换操作系统

New

PaymentStatus

string

支付状态。非退款订单,取值范围:

  • Unpaid:未支付。

  • Paid:已支付。

  • Cancelled:已作废。

说明

对于退款订单可置 NULL。

Paid

CreateTimeStart

string

创建时间段起(缺省查询当前时间最近 1 小时内订单),格式:YYYY-MM-ddTHH:mm:ssZ,时区: UTC

2016-05-23T13:00:00Z

返回参数

名称

类型

描述

示例值

object

Code

string

状态码。

Success

Message

string

错误信息。

Successful!

RequestId

string

请求 ID。

61293E7A-3406-4447-8620-EC88B0AA66AD

Success

boolean

是否成功。

true

Data

object

返回信息。

HostName

string

主机名。

test

PageNum

integer

分页数。

1

PageSize

integer

每页条数。建议每页最大 20 条,条数过多会导致超时。

20

TotalCount

integer

总记录数。

1

OrderList

object

Order

array<object>

订单列表。

object

PretaxAmount

string

订单应付金额。

0

CommodityCode

string

商品 Code

ecs

RelatedOrderId

string

关联订单 ID。

234535345345342

CreateTime

string

创建时间。

2017-06-08T09:41:30Z

Currency

string

币种。

CNY

SubscriptionType

string

订阅类型。取值:

  • Subscription:预付费。

  • PayAsYouGo:后付费。

PayAsYouGo

PaymentCurrency

string

支付币种。

CNY

ProductType

string

主产品类型。

rds

AfterTaxAmount

string

税后金额。

66

PaymentTime

string

支付时间。

2017-06-08T09:41:30Z

PretaxGrossAmount

string

原始金额。

0

OrderType

string

订单类型,取值范围

  • New 新购

  • Renew 续费

  • Upgrade 升级

  • TempUpgrade 短时升级

  • Downgrade 降级

  • Refund 退款

  • Convert 付费类型转换

  • ResizeDisk 调整磁盘大小

  • CompensatoryRenew 补偿续费

  • IncreaseUpgrade 带宽升级

  • Exchange 换购

  • ChangeOperatingSystem 更换操作系统

New

PaymentStatus

string

支付状态。非退款订单,取值范围:

  • Unpaid:未支付。

  • Paid:已支付。

  • Cancelled:已作废。

说明

对于退款订单可置 NULL。

Paid

OrderId

string

订单号。

34532532

Tax

string

税费。

1

PretaxAmountLocal

string

本币金额。

0

ProductCode

string

主产品代码。

rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "61293E7A-3406-4447-8620-EC88B0AA66AD",
  "Success": true,
  "Data": {
    "HostName": "test",
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "OrderList": {
      "Order": [
        {
          "PretaxAmount": "0",
          "CommodityCode": "ecs",
          "RelatedOrderId": "234535345345342",
          "CreateTime": "2017-06-08T09:41:30Z",
          "Currency": "CNY",
          "SubscriptionType": "PayAsYouGo",
          "PaymentCurrency": "CNY",
          "ProductType": "rds",
          "AfterTaxAmount": "66",
          "PaymentTime": "2017-06-08T09:41:30Z",
          "PretaxGrossAmount": "0",
          "OrderType": "New",
          "PaymentStatus": "Paid",
          "OrderId": "34532532",
          "Tax": "1",
          "PretaxAmountLocal": "0",
          "ProductCode": "rds"
        }
      ]
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidOwner The specified owner doesn't belong to caller. 用户身份错误
500 InternalError The request processing has failed due to some unknown error.

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

变更历史

更多信息,参考变更详情