调用GetOrderDetail订单详情查询服务_阿里云交易和账单管理API(BOA)-阿里云帮助中心

查询用户或分销客户某个订单详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
OrderId	string	是	订单号	32453453

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。	Success
Message	string	错误信息。	Successful!
RequestId	string	请求 id。	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
Success	boolean	是否成功。	true
Data	object	返回数据。
HostName	string	主机名。	test
PageNum	integer	页码。	1
PageSize	integer	每页条数。	20
TotalCount	integer	总记录数。	1
OrderList	array<object>	订单列表。
	object	订单详情。
OrderSubType	string	子订单类型：-productsuborder：产品子订单类型。-refundsuborder：退款子订单类型	子订单类型
CreateTime	string	创建时间。	2017-06-08T09:41:30Z
Currency	string	币种，CNY：人民币。 USD：美元。 JPY：日元	CNY
Config	string	主产品的配置。	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
SubscriptionType	string	订阅类型， Subscription：预付费。 PayAsYouGo：按量付费。	Subscription
UsageStartTime	string	服务开始时间。	2017-06-08T16:00:00Z
UsageEndTime	string	服务结束时间。	2117-06-08T16:00:00Z
SubOrderId	string	子订单 id。	234343
Region	string	地域	cn-hangzhou
AfterTaxAmount	string	税后金额。	0
PaymentTime	string	支付时间。	2017-06-08T09:41:30Z
Operator	string	订单操作 RAM 用户对应 ID，如无则留空。	23424243432
OrderType	string	订单类型，取值范围：-new：新购。-renew：续费。-upgrade：升级。-refund：退款。	new
PaymentStatus	string	支付状态，取值范围：-unpaid：未支付。-paid：已支付。-cancelled：已作废。	paid
Quantity	string	主产品数量。	1
PretaxAmountLocal	string	本币金额。	0
Tax	string	税费。	1
OriginalConfig	string	未经标准化的模块信息。	DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]
PretaxAmount	string	订单应付金额。	0
CommodityCode	string	商品 code	rds
RelatedOrderId	string	关联订单 id。	4353453534543
PaymentCurrency	string	支付币种。 CNY：人民币。 USD：美元。 JPY：日元	CNY
ProductType	string	主产品类型。	rds
InstanceIDs	string	实例 id 列表。	["rm-bp1a2vsr018313t6o"]
PretaxGrossAmount	string	原始金额。	0
OrderId	string	订单号。	3453425324
ProductCode	string	主产品代码。	rds
ExtendInfos	object	订单扩展信息
	string	订单扩展信息	{"key": "订单扩展信息"}
BillModuleConfig	array<object>	计费配置信息
	object
Name	string	配件名	数据盘
Code	string	配置 code	datadisk
ApiCode	string	apiCode	datadisk
BillModuleProperties	array<object>	配置下的值
	object
ModuleApiCode	string	配置 apiCode	cloud_ssd
AttrApiCode	string	配置的属性 code	cloud_ssd
Value	string	配置的属性值	cloud_ssd
OriginalModuleConfig	array<object>	具体配置信息
	object
Name	string	配置名	系统盘
Code	string	配置 code	systemdisk
ModuleProperties	array<object>	配置的属性列表
	object
Code	string	配置属性 code	高效云盘
Name	string	配置属性名	cloud_efficiency
Value	string	配置属性的值	cloud_efficiency

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "Success": true,
  "Data": {
    "HostName": "test",
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "OrderList": {
      "Order": [
        {
          "OrderSubType": "子订单类型",
          "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": "Subscription",
          "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\": \"订单扩展信息\"}"
          },
          "BillModuleConfig": {
            "billModuleConfig": [
              {
                "Name": "数据盘",
                "Code": "datadisk",
                "ApiCode": "datadisk",
                "BillModuleProperties": {
                  "billModuleProperties": [
                    {
                      "ModuleApiCode": "cloud_ssd",
                      "AttrApiCode": "cloud_ssd",
                      "Value": "cloud_ssd"
                    }
                  ]
                }
              }
            ]
          },
          "OriginalModuleConfig": {
            "originalModuleConfig": [
              {
                "Name": "系统盘",
                "Code": "systemdisk",
                "ModuleProperties": {
                  "moduleProperties": [
                    {
                      "Code": "高效云盘",
                      "Name": "cloud_efficiency",
                      "Value": "cloud_efficiency"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidOwner	The specified owner doesn't belong to caller.	用户身份错误
500	InternalError	The request processing has failed due to some unknown error.	内部服务器错误。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-07-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-03-14	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情