GetOrderDetail - Query order details - Expenses and Costs

Retrieves order details for your Alibaba Cloud account or distributor customers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	string	Yes	The order ID.	32453453

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	Success
Message	string	The error message.	Successful!
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
Success	boolean	Whether the request was successful.	true
Data	object	The response data.
HostName	string	The hostname.	test
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	1
OrderList	object
Order	array<object>	The orders returned.
	array<object>	The details of the order.
OrderSubType	string	The suborder type. Valid values: productsuborder (service suborder) and refundsuborder (refund suborder).	ProductSubOrder
CreateTime	string	The order creation time.	2017-06-08T09:41:30Z
Currency	string	The currency. Valid values: CNY, USD, and JPY.	CNY
Config	string	The primary product configurations.	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
SubscriptionType	string	The billing method. Valid values: Subscription and PayAsYouGo.	PayAsYouGo
UsageStartTime	string	The service start time.	2017-06-08T16:00:00Z
UsageEndTime	string	The service end time.	2117-06-08T16:00:00Z
SubOrderId	string	The ID of the suborder.	234343
Region	string	The region ID.	cn-hangzhou
AfterTaxAmount	string	The after-tax amount.	0
PaymentTime	string	The payment time.	2017-06-08T09:41:30Z
Operator	string	The RAM user ID that performed the operation. Empty if no RAM user was involved.	23424243432
OrderType	string	The type of the order. Valid values: new, renew, upgrade, and refund.	New
PaymentStatus	string	The payment status. Valid values: unpaid, paid, and canceled.	Paid
Quantity	string	The quantity of primary products.	1
PretaxAmountLocal	string	The pretax amount of the order in local currency.	0
Tax	string	The tax of the order.	1
OriginalConfig	string	The raw configuration string.	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
PretaxAmount	string	The pretax amount of the order.	0
CommodityCode	string	The commodity code.	rds
RelatedOrderId	string	The ID of the associated order.	4353453534543
PaymentCurrency	string	The currency used for payment. Valid values: CNY, USD, and JPY.	CNY
ProductType	string	The primary product type.	rds
InstanceIDs	string	The instance IDs.	["rm-bp1a2vsr018313t6o"]
PretaxGrossAmount	string	The pretax gross amount of the order.	0
OrderId	string	The order ID.	3453425324
ProductCode	string	The primary product code.	rds
ExtendInfos	object	The order extension information.
	string	The order extension information. isAutoRenew: whether auto-renewal is enabled. Not returned if disabled. couponNo: the coupon number. couponAmount: the coupon deduction amount. discountAmount: the discount deduction amount.	{"key":"Order extension information"}
BillModuleConfig	object
billModuleConfig	array<object>	The billing module configurations.
	array<object>
Name	string	The name of the configuration item.	Data disk
Code	string	The code of the configuration item.	datadisk
ApiCode	string	The API code of the configuration item.	datadisk
BillModuleProperties	object
billModuleProperties	array<object>	The configuration item attributes.
	object
ModuleApiCode	string	The configuration API code.	cloud_ssd
AttrApiCode	string	The configuration attribute code.	cloud_ssd
Value	string	The configuration attribute value.	cloud_ssd
OriginalModuleConfig	object
originalModuleConfig	array<object>	The configuration details.
	array<object>
Name	string	The name of the configuration item.	System disk
Code	string	The code of the configuration item.	systemdisk
ModuleProperties	object
moduleProperties	array<object>	The configuration item attributes.
	object
Code	string	The configuration attribute code.	cloud_efficiency
Name	string	The configuration attribute name.	cloud_efficiency
Value	string	The configuration attribute value.	cloud_efficiency

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "Success": true,
  "Data": {
    "HostName": "test",
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "OrderList": {
      "Order": [
        {
          "OrderSubType": "ProductSubOrder",
          "CreateTime": "2017-06-08T09:41:30Z",
          "Currency": "CNY",
          "Config": "DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]",
          "SubscriptionType": "PayAsYouGo",
          "UsageStartTime": "2017-06-08T16:00:00Z",
          "UsageEndTime": "2117-06-08T16:00:00Z",
          "SubOrderId": "234343",
          "Region": "cn-hangzhou",
          "AfterTaxAmount": "0",
          "PaymentTime": "2017-06-08T09:41:30Z",
          "Operator": "23424243432",
          "OrderType": "New",
          "PaymentStatus": "Paid",
          "Quantity": "1",
          "PretaxAmountLocal": "0",
          "Tax": "1",
          "OriginalConfig": "DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]",
          "PretaxAmount": "0",
          "CommodityCode": "rds",
          "RelatedOrderId": "4353453534543",
          "PaymentCurrency": "CNY",
          "ProductType": "rds",
          "InstanceIDs": "[\"rm-bp1a2vsr018313t6o\"]",
          "PretaxGrossAmount": "0",
          "OrderId": "3453425324",
          "ProductCode": "rds",
          "ExtendInfos": {
            "key": "{\"key\":\"Order extension information\"}"
          },
          "BillModuleConfig": {
            "billModuleConfig": [
              {
                "Name": "Data disk\n",
                "Code": "datadisk",
                "ApiCode": "datadisk",
                "BillModuleProperties": {
                  "billModuleProperties": [
                    {
                      "ModuleApiCode": "cloud_ssd",
                      "AttrApiCode": "cloud_ssd",
                      "Value": "cloud_ssd"
                    }
                  ]
                }
              }
            ]
          },
          "OriginalModuleConfig": {
            "originalModuleConfig": [
              {
                "Name": "System disk\n",
                "Code": "systemdisk",
                "ModuleProperties": {
                  "moduleProperties": [
                    {
                      "Code": "cloud_efficiency\n",
                      "Name": "cloud_efficiency",
                      "Value": "cloud_efficiency"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.