GetOrderDetail - Query order details - Expenses and Costs

Queries the details of a specific order for a user or a distribution customer.

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 status code.	Success
Data	object	The returned data.
HostName	string	The hostname.	test
OrderList	object
Order	array<object>	The order list.
	array<object>	The order details.
AfterTaxAmount	string	The after-tax amount.	0
BillModuleConfig	object
billModuleConfig	array<object>	The billing configuration information.
	array<object>
ApiCode	string	apiCode	datadisk
BillModuleProperties	object
billModuleProperties	array<object>	The values under the configuration.
	object
AttrApiCode	string	The attribute code of the configuration.	cloud_ssd
ModuleApiCode	string	The API code of the configuration.	cloud_ssd
Value	string	The attribute value of the configuration.	cloud_ssd
Code	string	The configuration code.	datadisk
Name	string	The component name.	Data cloud disk
CommodityCode	string	The commodity code.	rds
Config	string	The configuration of the main product.	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
CreateTime	string	The creation time in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2017-06-08T09:41:30Z
Currency	string	The currency. Valid values: CNY: Chinese yuan. USD: US dollar. JPY: Japanese yen.	CNY
ExtendInfos	object	The extended information of the order.
	string	The extended information of the order. IsAutoRenew=true indicates an auto-renewal order. This parameter is not returned for non-auto-renewal orders. CouponNo is the coupon number. DeductedByCoupons is the amount deducted by coupons, in yuan. DiscountAmount is the discount amount, in yuan.	{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}
InstanceIDs	string	The list of instance IDs.	["rm-bp1a2vsr018313t6o"]
Operator	string	The ID of the Resource Access Management (RAM) user who performed the order operation. If no RAM user performed the operation, this parameter is left empty.	23424243432
OrderId	string	The order ID.	3453425324
OrderSubType	string	The sub-order type. Valid values: productsuborder: product sub-order. refundsuborder: refund sub-order.	Sub-order type
OrderType	string	The order type. Valid values: new: new purchase. renew: renewal. upgrade: upgrade. refund: refund.	new
OriginalConfig	string	The unstandardized module information.	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
OriginalModuleConfig	object
originalModuleConfig	array<object>	The specific configuration information.
	array<object>
Code	string	The configuration code.	systemdisk
ModuleProperties	object
moduleProperties	array<object>	The list of configuration attributes.
	object
Code	string	The configuration property code.	Ultra cloud disk
Name	string	The configuration property name.	cloud_efficiency
Value	string	The value of the configuration property.	cloud_efficiency
Name	string	The configuration name.	System cloud disk
PaymentCurrency	string	The payment currency. Valid values: CNY: Chinese yuan. USD: US dollar. JPY: Japanese yen.	CNY
PaymentStatus	string	The payment status. Valid values: unpaid: unpaid. paid: paid. cancelled: cancelled.	paid
PaymentTime	string	The payment time in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2017-06-08T09:41:30Z
PretaxAmount	string	The payable amount of the order.	0
PretaxAmountLocal	string	The local currency amount.	0
PretaxGrossAmount	string	The original amount.	0
ProductCode	string	The main product code.	rds
ProductType	string	The main product type.	rds
Quantity	string	The quantity of the main product.	1
Region	string	The region.	cn-hangzhou
RelatedOrderId	string	The ID of the associated order.	4353453534543
SubOrderId	string	The sub-order ID.	234343
SubscriptionType	string	The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription
Tax	string	The tax.	1
UsageEndTime	string	The service end time in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2117-06-08T16:00:00Z
UsageStartTime	string	The service start time in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2017-06-08T16:00:00Z
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of records.	1
Message	string	The error message.	Successful!
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

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

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.