Download Paid Order Details - DownloadListPaidOrders

Overview

Generate a paid order detail Excel file and return a US3 presigned download URL; query conditions are identical to ListPaidOrders, StartTime/EndTime are required; the data range is [StartTime, EndTime), meaning that data whose billing start time is greater than or equal to StartTime and less than EndTime will be retrieved.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DownloadListPaidOrders`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
StartTime	int	Query start time (Unix timestamp, seconds), required	Yes
EndTime	int	Query end time (Unix timestamp, seconds), required; must be greater than StartTime	Yes
ResourceIds.N	string	Resource ID list (optional)	No
ModelIds.N	string	Model ID list (optional)	No
PricingUnits.N	int	Pricing unit list (optional)	No
PricingSkus.N	string	Billing unit SKU list (optional)	No
OrderTypes.N	int	Order type list (optional)	No
OrganizationIds.N	int	Organization ID list (optional)	No
Regions.N	string	Region list (optional). See Region and Zone List	No
ProductCodes.N	string	Product code list (optional). Enum: `modelverse`, `sandbox`	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
Data	DownloadFileData	Download file info	No

Data Model

DownloadFileData

Field Name	Type	Description Information	Required
DownloadURL	string	File download URL (US3 presigned URL, download promptly within validity period)	No
FileName	string	File name	No
FileSize	int	File size (bytes)	No

Example

Request Example


https://api.surfercloud.com/?Action=DownloadListPaidOrders
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=ykStVzQX
&ResourceIds.N=ZaUxZUjD
&ModelIds.N=XJAeQtEB
&PricingUnits.N=8
&OrderTypes.N=2
&StartTime=6
&EndTime=5
&ResourceIds.N=BeExGPAI
&ModelIds.N=NhormROX
&PricingUnits.N=7
&OrderTypes.N=2
&StartTime=9
&EndTime=3
&PricingSkus.N=mgqbideM
&OrganizationIds.N=1
&Regions.N=ubMVnzys
&ProductCodes.N=wHjCoFlq

Response Example


{
  "Action": "DownloadListPaidOrdersResponse",
  "Data": {},
  "RetCode": 0
}