文档首页 > > API参考> 管理包周期订单> 查询订单列表

查询订单列表

分享
更新时间: 2019/10/25 GMT+08:00

功能介绍

客户购买包周期资源后,可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。

Web UI

客户登录费用中心进入“我的订单”页面,选择“全部”页签,可以查看待审核、处理中、已取消、已完成和待支付等状态的订单。

REST API

客户购买包周期资源后,可以在客户自建平台查看待审核、处理中、已取消、已完成和待支付等状态的订单。

  • 该接口可以使用客户AK/SK或者Token调用。
  • 如果想查询某条订单下的资源信息,在调用本接口获取订单ID后,请调用“查询客户包周期资源列表”接口在请求参数输入订单号进行查询。
  1. URI

    GET /v1.0/{domain_id}/common/order-mgr/orders/detail

    参数说明请参见下表。

    表1 路径参数

    参数

    是否必选

    取值范围

    描述

    domain_id

    最大长度:64

    客户账号ID。获取方法请参见如何获取customer_id/domain_id

    表2 查询参数

    参数

    是否必选

    参数类型

    取值范围

    描述

    order_id

    String

    最大长度:64

    订单ID。

    customer_id

    String

    最大长度:64

    客户账号ID。获取方法请参见如何获取customer_id/domain_id

    create_time_begin

    String

    最大长度:64

    订单创建开始时间。

    UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    其中,HH范围是0~23,mm和ss范围是0~59。

    create_time_end

    String

    最大长度:64

    订单创建结束时间。

    UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    其中,HH范围是0~23,mm和ss范围是0~59。

    service_type

    String

    最大长度:64

    云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

    status

    String

    最大长度:64

    订单状态。

    • 1:待审核
    • 3:处理中
    • 4:已取消
    • 5:已完成
    • 6:待支付
    • 9:待确认

    order_type

    String

    最大长度:64

    订单类型。

    • 1:开通
    • 2:续订
    • 3:变更
    • 4:退订
    • 10:包周期转按需
    • 11:按需转包周期
    • 13:试用
    • 14:转商用
    • 15:费用调整

    page_size

    Integer

    [1-100]

    单页行数。

    page_index

    Integer

    [1-最大整数]

    当前查询页码。

    sort

    String

    最大长度:36

    查询的订单列表排序。

    支持3中多个响应参数进行排序,但每次只能用一个。

    缺省或者带+为升序,带-表示倒序。

    例如:按照创建时间升序排序表示为+createTime

    payment_time_begin

    String

    最大长度:64

    订单支付开始时间。

    UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    其中,HH范围是0~23,mm和ss范围是0~59。

    payment_time_end

    String

    最大长度:64

    订单支付结束时间。

    UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    其中,HH范围是0~23,mm和ss范围是0~59。

  1. 请求消息

    请求参数

    无。

    请求示例

    GET /v1.0/{domain_id}/common/order-mgr/orders/detail?page_size=5&page_index=1 HTTP/1.1
    Host:Host Server  
    Content-Length:length
    Content-Type:application/json
    X-Sdk-Date: request time  
    Authorization: authorization

  1. 响应消息

    响应参数

    参数

    参数类型

    描述

    error_code

    String

    状态码。

    具体请参见4

    error_msg

    String

    错误描述信息。

    data

    Result

    订单列表。

    具体请参见表3

    表3 Result

    参数

    参数类型

    描述

    pageSize

    Integer

    单页行数。

    pageIndex

    Integer

    当前查询页码。

    totalSize

    Integer

    符合条件的记录总数。

    orderInfos

    List<CustomerOrder>

    客户订单详情信息。

    具体请参见表4

    表4 CustomerOrder

    参数

    参数类型

    描述

    orderId

    String

    订单ID。

    baseOrderId

    String

    父订单ID(拆分前的订单ID)。

    当云服务资源进行续订、变更或退订会产生新的订单ID(“orderId”的取值),此时“baseOrderId”为进行续订、变更或退订前的ID。

    beId

    String

    华为云运营实体ID。

    customerId

    String

    客户ID。

    sourceType

    Integer

    客户订单订单来源类型:

    • 1:客户
    • 2:代理
    • 3:合同
    • 4:分销商

    status

    Integer

    订单状态:

    • 1:待审核
    • 3:处理中
    • 4:已取消
    • 5:已完成
    • 6:待支付
    • 9:待确认

    orderType

    Integer

    订单类型:

    • 1:开通
    • 2:续订
    • 3:变更
    • 4:退订
    • 10:包周期转按需
    • 11:按需转包周期
    • 13:试用
    • 14:转商用
    • 15:费用调整

    currency

    Double

    订单金额(原价)。

    退订订单中,该金额等于currencyAfterDiscount。

    currencyAfterDiscount

    Double

    订单优惠后金额(实付价格,不含券不含卡)。

    measureId

    Integer

    订单金额度量单位:

    • 1:元
    • 2:角
    • 3:分

    measureName

    String

    金额单位名称。

    createTime

    String

    创建时间 。

    paymentTime

    String

    支付时间。

    lastUpdateTime

    String

    最后更新状态时间。

    needAudit

    Boolean

    是否需要审核。

    currencyType

    String

    货币编码。

    contractId

    String

    合同ID。

    currencyOfficial

    Double

    订单金额(官网价)。

    退订订单中,该金额等于currencyAfterDiscount。

    amountInfo

    AmountInfo

    订单扣费详情。

    具体请参见表5

    serviceType

    String

    云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

    表5 AmountInfo

    参数

    参数类型

    描述

    discountList

    List<DiscountItem>

    费用项。

    具体请参见表6

    cashcouponAmount

    Double

    现金券金额。

    couponAmount

    Double

    代金券金额。

    cardAmount

    Double

    储值卡金额。

    commissionAmount

    Double

    手续费(仅退订订单存在)。

    consumedAmount

    Double

    消费金额(仅退订订单存在)。

    表6 DiscountItem

    参数

    参数类型

    描述

    discountType

    String

    折扣类型:

    200:促销产品折扣;

    300:促销折扣券;

    301:促销代金券;

    302:促销现金券;

    500:代理订购指定折扣;

    501:代理订购指定减免;

    502:代理订购指定一口价;

    600:折扣返利合同;

    601:渠道框架合同;

    602:专款专用合同;

    603:线下直签合同;

    604:电销授权合同;

    605:商务合同折扣;

    606:渠道商务合同折扣;

    607:合作伙伴授权折扣;

    609:订单调价折扣;

    700:促销折扣;

    800:充值帐户折扣;

    900:产品本身折扣;

    901:基准价一口价的折扣。

    discountAmount

    Double

    折扣金额。

    响应示例:

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Content-Length: length
    Date: response time  
    
    {
    	"error_code": "CBC.0000",
    	"error_msg": "success",
    	"data": {
    		"pageSize": 10,
    		"pageIndex": 1,
    		"totalSize": 1,
    		"orderInfos": [{
    			"orderId": "9Lw9bGzUCCALxuDqzlKWfqYW5Pg1gEamqK5k",
    			"baseOrderId": null,
    			"beId": "0",
    			"customerId": "L3BnGfjVGsxisDmyp1R6pOA3rivqO3RijBdD",
    			"sourceType": 1,
    			"status": 4,
    			"orderType": 1,
    			"currency": 30,
    			"currencyAfterDiscount": 30,
    			"measureId": 1,
    			"measureName": null,
    			"createTime": "2019-04-01T11:28:20Z",
    			"paymentTime": null,
    			"lastUpdateTime": "2019-04-02T11:29:42Z",
    			"needAudit": false,
    			"currencyType": "CNY",
    			"contractId": null,
    			"currencyOfficial": 30,
    			"amountInfo": {
    				"discountList": [{
    					"discountType": "901",
    					"discountAmount": 100
    				}],
    				"cashcouponAmount": 1,
    				"couponAmount": 2,
    				"cardAmount": 3,
    				"commissionAmount": 4,
    				"consumedAmount": 5
    			},
    			"serviceType": "hws.service.type.ebs"
    		}]
    	}
    }

  1. 状态码

    状态码

    描述

    CBC.0000

    成功。

    CBC.0100

    输入参数校验失败。

    CBC.0101

    参数无效。

    CBC.0151

    访问拒绝。

    CBC.0155

    不允许执行当前请求。

    CBC.0999

    其他错误。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区