GetOrderDetail - 订单详情查询服务

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bss:DescribeOrderDetail

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

OrderId

string

订单号

32453453

返回参数

名称

类型

描述

示例值

object

Code

string

状态码。

Success

Data

object

返回数据。

HostName

string

主机名。

test

OrderList

object

Order

array<object>

订单列表。

array<object>

订单详情。

AfterTaxAmount

string

税后金额。

0

BillModuleConfig

object

billModuleConfig

array<object>

计费配置信息

array<object>

ApiCode

string

apiCode

datadisk

BillModuleProperties

object

billModuleProperties

array<object>

配置下的值

object

AttrApiCode

string

配置的属性 code

cloud_ssd

ModuleApiCode

string

配置 apiCode

cloud_ssd

Value

string

配置的属性值

cloud_ssd

Code

string

配置 code

datadisk

Name

string

配件名

数据盘

CommodityCode

string

商品 code

rds

Config

string

主产品的配置。

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

CreateTime

string

创建时间。

2017-06-08T09:41:30Z

Currency

string

币种,CNY:人民币。 USD:美元。 JPY:日元

CNY

ExtendInfos

object

订单扩展信息

string

订单扩展信息

  • IsAutoRenew=true 表示自动续费订单,非自动续费订单不返回该参数;

  • CouponNo 为优惠券编号;

  • DeductedByCoupons 为优惠券抵扣金额,单位为元;

  • DiscountAmount 为优惠金额,单位为元。

{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}

InstanceIDs

string

实例 id 列表。

["rm-bp1a2vsr018313t6o"]

Operator

string

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

23424243432

OrderId

string

订单号。

3453425324

OrderSubType

string

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

子订单类型

OrderType

string

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

new

OriginalConfig

string

未经标准化的模块信息。

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

OriginalModuleConfig

object

originalModuleConfig

array<object>

具体配置信息

array<object>

Code

string

配置 code

systemdisk

ModuleProperties

object

moduleProperties

array<object>

配置的属性列表

object

Code

string

配置属性 code

高效云盘

Name

string

配置属性名

cloud_efficiency

Value

string

配置属性的值

cloud_efficiency

Name

string

配置名

系统盘

PaymentCurrency

string

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

CNY

PaymentStatus

string

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

paid

PaymentTime

string

支付时间。

2017-06-08T09:41:30Z

PretaxAmount

string

订单应付金额。

0

PretaxAmountLocal

string

本币金额。

0

PretaxGrossAmount

string

原始金额。

0

ProductCode

string

主产品代码。

rds

ProductType

string

主产品类型。

rds

Quantity

string

主产品数量。

1

Region

string

地域

cn-hangzhou

RelatedOrderId

string

关联订单 id。

4353453534543

SubOrderId

string

子订单 id。

234343

SubscriptionType

string

订阅类型, Subscription:预付费。 PayAsYouGo:按量付费。

Subscription

Tax

string

税费。

1

UsageEndTime

string

服务结束时间。

2117-06-08T16:00:00Z

UsageStartTime

string

服务开始时间。

2017-06-08T16:00:00Z

PageNum

integer

页码。

1

PageSize

integer

每页条数。

20

TotalCount

integer

总记录数。

1

Message

string

错误信息。

Successful!

RequestId

string

请求 id。

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

Success

boolean

是否成功。

true

示例

正常返回示例

JSON格式

{
  "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": "数据盘"
              }
            ]
          },
          "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": "子订单类型",
          "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": "高效云盘",
                      "Name": "cloud_efficiency",
                      "Value": "cloud_efficiency"
                    }
                  ]
                },
                "Name": "系统盘"
              }
            ]
          },
          "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
}

错误码

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.

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

变更历史

更多信息,参考变更详情