QueryOrders - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the orders of your Alibaba Cloud account or distributors. By default, orders within the last hour are queried. To query earlier orders, specify the CreateTimeStart and CreateTimeEnd parameters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
bssapi:QueryOrders	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
CreateTimeEnd	string	No	The end time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-05-23T12:00:00Z
PageNum	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries to return per page.	20
ProductCode	string	No	The code of the service.	rds
ProductType	string	No	The type of the service.	rds
SubscriptionType	string	No	The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go	Subscription
OrderType	string	No	The type of the order. Valid values: New: purchases an instance. Renew: renews an instance. Upgrade: upgrades the configurations of an instance. Refund: applies for a refund.	New
PaymentStatus	string	No	The status of payment. Valid values for a non-refund order: Unpaid: The order is not paid. Paid: The order is paid. Cancelled: The order is canceled. Note : You can set this parameter to NULL for a refund order.	Paid
CreateTimeStart	string	No	The start time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-05-23T13:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message returned.	Successful!
RequestId	string	The ID of the request.	61293E7A-3406-4447-8620-EC88B0AA66AD
Success	boolean	Indicates whether the request was successful.	true
Data	object	The message returned.
HostName	string	The hostname.	test
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of returned entries.	1
OrderList	object []	The orders returned.
PretaxAmount	string	The pretax amount of the order.	0
CommodityCode	string	The service code.	ecs
RelatedOrderId	string	The ID of the associated order.	234535345345342
CreateTime	string	The time when the order was created.	2017-06-08T09:41:30Z
Currency	string	The currency.	CNY
SubscriptionType	string	The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go	PayAsYouGo
PaymentCurrency	string	The currency of payment.	CNY
ProductType	string	The type of the main service.	rds
AfterTaxAmount	string	The aftertax amount of the order.	66
PaymentTime	string	The time of payment.	2017-06-08T09:41:30Z
PretaxGrossAmount	string	The pretax gross amount of the order.	0
OrderType	string	The type of the order. Valid values: New: purchases an instance. Renew: renews an instance. Upgrade: upgrades the configurations of an instance. Refund: applies for a refund.	New
PaymentStatus	string	The status of payment. Valid values for a non-refund order: Unpaid: The order is not paid. Paid: The order is paid. Cancelled: The order is canceled. Note : The value is NULL for a refund order.	Paid
OrderId	string	The ID of the order.	34532532
Tax	string	The tax of the order.	1
PretaxAmountLocal	string	The pretax amount of the order in local currency.	0
ProductCode	string	The code of the main service.	rds

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOwner	The specified owner doesn't belong to caller.	Invalid user identity.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history