All Products
Search
Document Center

BSS OpenAPI:GetOrderDetail

Last Updated:Sep 12, 2024

Queries the details of an order that belongs to your Alibaba Cloud account or distributors.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
bss:DescribeOrderDetailget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdstringYes

The order ID.

32453453

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The response code.

Success
Messagestring

The error message.

Successful!
RequestIdstring

The request ID.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
Successboolean

Indicates whether the request was successful.

true
Dataobject

The returned data.

HostNamestring

The hostname.

test
PageNuminteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

1
OrderListarray<object>

The orders returned.

object

The details of the order.

OrderSubTypestring

The type of the suborder. A value of productsuborder indicates service suborder. A value of refundsuborder indicates refund suborder.

ProductSubOrder
CreateTimestring

The time when the order was created.

2017-06-08T09:41:30Z
Currencystring

The currency. Valid values: CNY, USD, and JPY.

CNY
Configstring

The configurations of the main service.

DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
SubscriptionTypestring

The billing method. Valid values: Subscription and PayAsYouGo.

PayAsYouGo
UsageStartTimestring

The time when the service starts.

2017-06-08T16:00:00Z
UsageEndTimestring

The time when the service ends.

2117-06-08T16:00:00Z
SubOrderIdstring

The ID of the suborder.

234343
Regionstring

The region ID.

cn-hangzhou
AfterTaxAmountstring

The aftertaxt amount of the order.

0
PaymentTimestring

The time of payment.

2017-06-08T09:41:30Z
Operatorstring

The ID of the Resource Access Management (RAM) user that performs operations on the order. If no RAM user is involved, this parameter is empty.

23424243432
OrderTypestring

The type of the order. Valid values: new, renew, upgrade, and refund.

New
PaymentStatusstring

The payment state. Valid values: unpaid, paid, and canceled.

Paid
Quantitystring

The number of main services.

1
PretaxAmountLocalstring

The pretax amount of the order in local currency.

0
Taxstring

The tax of the order.

1
OriginalConfigstring

The configuration information that is not formatted.

DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
PretaxAmountstring

The pretax amount of the order.

0
CommodityCodestring

The commodity code.

rds
RelatedOrderIdstring

The ID of the associated order.

4353453534543
PaymentCurrencystring

The currency used for payment. Valid values: CNY, USD, and JPY.

CNY
ProductTypestring

The type of the main service.

rds
InstanceIDsstring

The instance IDs.

["rm-bp1a2vsr018313t6o"]
PretaxGrossAmountstring

The pretax gross amount of the order.

0
OrderIdstring

The order ID.

3453425324
ProductCodestring

The code of the main service.

rds
ExtendInfosobject

The additional information about the order.

string

The additional information about the order.

  • A value of true for isAutoRenew indicates that automatic renewal is enabled. If automatic renewal is disabled, this parameter is not returned.
  • couponNo indicates the coupon number.
  • couponAmount indicates the amount deducted by using the coupon.
  • discountAmount indicates the amount deducted.
{"key":"Order extension information"}
BillModuleConfigarray<object>

The billing information about the configurations.

object
Namestring

The name of the configuration item.

Data disk
Codestring

The code of the configuration item.

datadisk
ApiCodestring

The API code of the configuration item.

datadisk
BillModulePropertiesarray<object>

The attributes of the configured item.

object
ModuleApiCodestring

The API code of the configured item.

cloud_ssd
AttrApiCodestring

The attribute code of the configured item.

cloud_ssd
Valuestring

The attribute value of the configuration item.

cloud_ssd
OriginalModuleConfigarray<object>

The information about the configurations.

object
Namestring

The name of the configuration item.

System disk
Codestring

The code of the configuration item.

systemdisk
ModulePropertiesarray<object>

The attributes of the configured item.

object
Codestring

The attribute code of the configured item.

cloud_efficiency
Namestring

The attribute name of the configured item.

cloud_efficiency
Valuestring

The attribute value of the configured item.

cloud_efficiency

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidOwnerThe specified owner doesn't belong to caller.Invalid user identity.
500InternalErrorThe request processing has failed due to some unknown error.-

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

Change history

Change timeSummary of changesOperation
2024-07-10The Error code has changed. The response structure of the API has changedView Change Details
2024-03-14The Error code has changed. The response structure of the API has changedView Change Details