AI 助理
备案控制台
文档
输入文档关键字查找
首页 阿里云交易和账单管理API API参考指南 API目录 订单 GetOrderDetail - 订单详情查询服务

GetOrderDetail - 订单详情查询服务

更新时间：
我的收藏

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
bss:DescribeOrderDetailget
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
OrderIdstring是

订单号

32453453

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 id。

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

是否成功。

true
Dataobject

返回数据。

HostNamestring

主机名。

test
PageNuminteger

页码。

1
PageSizeinteger

每页条数。

20
TotalCountinteger

总记录数。

1
OrderListarray<object>

订单列表。

object

订单详情。

OrderSubTypestring

子订单类型：-productsuborder：产品子订单类型。-refundsuborder：退款子订单类型

子订单类型
CreateTimestring

创建时间。

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

币种，CNY：人民币。 USD：美元。 JPY：日元

 CNY
Configstring

主产品的配置。

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

订阅类型， Subscription：预付费。 PayAsYouGo：按量付费。

Subscription
UsageStartTimestring

服务开始时间。

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

服务结束时间。

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

子订单 id。

234343
Regionstring

地域

cn-hangzhou
AfterTaxAmountstring

税后金额。

0
PaymentTimestring

支付时间。

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

订单操作 RAM 用户对应 ID，如无则留空。

23424243432
OrderTypestring

订单类型，取值范围：-new：新购。-renew：续费。-upgrade：升级。-refund：退款。

new
PaymentStatusstring

支付状态，取值范围：-unpaid：未支付。-paid：已支付。-cancelled：已作废。

paid
Quantitystring

主产品数量。

1
PretaxAmountLocalstring

本币金额。

0
Taxstring

税费。

1
OriginalConfigstring

未经标准化的模块信息。

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

订单应付金额。

0
CommodityCodestring

商品 code

rds
RelatedOrderIdstring

关联订单 id。

4353453534543
PaymentCurrencystring

支付币种。 CNY：人民币。 USD：美元。 JPY：日元

CNY
ProductTypestring

主产品类型。

rds
InstanceIDsstring

实例 id 列表。

["rm-bp1a2vsr018313t6o"]
PretaxGrossAmountstring

原始金额。

0
OrderIdstring

订单号。

3453425324
ProductCodestring

主产品代码。

rds
ExtendInfosobject

订单扩展信息

string

订单扩展信息

  • IsAutoRenew=true 表示自动续费订单，非自动续费订单不返回该参数；
  • CouponNo 为优惠券编号；
  • DeductedByCoupons 为优惠券抵扣金额，单位为元；
  • DiscountAmount 为优惠金额，单位为元。
{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}
BillModuleConfigarray<object>

计费配置信息

object
Namestring

配件名

数据盘
Codestring

配置 code

datadisk
ApiCodestring

apiCode

datadisk
BillModulePropertiesarray<object>

配置下的值

object
ModuleApiCodestring

配置 apiCode

cloud_ssd
AttrApiCodestring

配置的属性 code

cloud_ssd
Valuestring

配置的属性值

cloud_ssd
OriginalModuleConfigarray<object>

具体配置信息

object
Namestring

配置名

系统盘
Codestring

配置 code

systemdisk
ModulePropertiesarray<object>

配置的属性列表

object
Codestring

配置属性 code

高效云盘
Namestring

配置属性名

cloud_efficiency
Valuestring

配置属性的值

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": "{\"IsAutoRenew\":\"true\",\"DiscountAmount\":\"100.98\",\"DeductedByCoupons\":\"98.88\",\"CouponNo\":\"319170900877\"}"
          },
          "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错误码错误信息描述
400InvalidOwnerThe specified owner doesn't belong to caller.用户身份错误
500InternalErrorThe request processing has failed due to some unknown error.内部服务器错误。

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

变更历史

变更时间变更内容概要操作
2024-07-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：订单下一篇：QueryOrders - 订单列表查询服务
文档推荐