All Products
Search

This Product

    BSS OpenAPI:GetOrderDetail

    Document Center

    BSS OpenAPI:GetOrderDetail

    Last Updated:Mar 01, 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
    bssapi:GetOrderDetailREAD
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    OrderIdstringYes

    The ID of the order.

    		32453453

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The status code.

    		Success
    Messagestring

    The error message returned.

    		Successful!
    RequestIdstring

    The ID of the request.

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

    Indicates whether the request was successful.

    		true
    Dataobject

    The data returned.

    HostNamestring

    The hostname.

    		test
    PageNuminteger

    The page number of the returned page.

    		1
    PageSizeinteger

    The number of entries returned on each page.

    		20
    TotalCountinteger

    The total number of returned entries.

    		1
    OrderListobject []

    The details of the order.

    OrderSubTypestring

    The type of the suborder. Valid values:

    • ProductSubOrder: the service suborder
    • RefundSubOrder: the refund suborder
    		ProductSubOrder
    CreateTimestring

    The time when the order was created.

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

    The currency.

    		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: subscription
    • PayAsYouGo: pay-as-you-go
    		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 ID of the region.

    		cn-hangzhou
    AfterTaxAmountstring

    The after-tax 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 who performs operations on the order. If no RAM user is involved, leave this parameter blank.

    		23424243432
    OrderTypestring

    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.
    • Convert: switches the billing method.
    • Downgrade: downgrades the configurations of an instance.
    • ResizeDisk: resizes the disk.
    		New
    PaymentStatusstring

    The status of payment. Valid values:

    • Unpaid: The order is not paid.
    • Paid: The order is paid.
    • Cancelled: The order is 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 module information without standardized conversion.

    		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 service code.

    		ecs
    RelatedOrderIdstring

    The ID of the associated order.

    		4353453534543
    PaymentCurrencystring

    The currency of payment.

    		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 ID of the order.

    		3453425324
    ProductCodestring

    The code of the main service.

    		rds

    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\n",
          "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": "ecs\n",
          "RelatedOrderId": "4353453534543",
          "PaymentCurrency": "CNY",
          "ProductType": "rds",
          "InstanceIDs": "[\"rm-bp1a2vsr018313t6o\"]",
          "PretaxGrossAmount": "0",
          "OrderId": "3453425324",
          "ProductCode": "rds"
        }
      ]
    }
  }
}

    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.