客户运营能力-查询订单列表:URI
URI
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
order_id |
否 |
String |
最大长度:64 |
订单ID。大小写不敏感。 此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。
说明:
使用特殊字符进行查询的时候,请注意进行URL编码转换,如“%”的转码应为“%25”。 |
customer_id |
否 |
String |
最大长度:64 |
客户账号ID。 此参数不携带时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空或携带值为空串。 |
create_time_begin |
否 |
String |
最大长度:20 |
订单创建开始时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 订单创建开始时间与订单创建结束时间间隔不能超过1年。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 |
create_time_end |
否 |
String |
最大长度:20 |
订单创建结束时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 订单创建开始时间与订单创建结束时间间隔不能超过1年。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 |
service_type_code |
否 |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为"hws.service.type.obs"。大小写不敏感。 您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件;携带值为空串或携带值为null时,作为筛选条件。 |
status |
否 |
Integer |
- |
订单状态:
此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。 |
order_type |
否 |
String |
最大长度:64 |
订单类型:
此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 |
limit |
否 |
Integer |
[1-100] |
每次查询的订单数量,默认值为10。 此参数不携带或携带值为空或携带值为null时,取默认值10;不支持携带值为空串。 |
offset |
否 |
Integer |
[0-最大整数] |
偏移量,从0开始。默认值为0。 此参数不携带或携带值为空或携带值为null时,取默认值0;不支持携带值为空串。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 |
order_by |
否 |
String |
最大长度:36 |
查询的订单列表排序。大小写不敏感。 支持按照创建时间进行排序,带-表示倒序。 创建时间:升序为createTime,倒序为-createTime。 此参数不携带或携带值为空或携带值为空串或携带值为null时,按照创建时间倒序排列。 |
payment_time_begin |
否 |
String |
最大长度:20 |
订单支付开始时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 订单支付开始时间与订单支付结束时间间隔不能超过1年。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 |
payment_time_end |
否 |
String |
最大长度:20 |
订单支付结束时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 其中,HH范围是0~23,mm和ss范围是0~59。 订单支付开始时间与订单支付结束时间间隔不能超过1年。 此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。 |