API Explorer

名称	类型	IN	必选	描述
X-Auth-Token	string	header	是	合作伙伴Token调用

名称

类型

必选

描述

X-Auth-Token

string

header

是

合作伙伴Token调用

名称	类型	必选	描述
quota_ids	Array of strings	否	优惠券额度ID列表。此参数不携带或携带值为空列表或携带值为null时,不作为筛选条件。
quota_status_list	Array of integers	否	优惠券额度状态列表。 0:正常3:失效(过期失效和人工设置失效)4:额度调整中(伙伴可以查看该额度,但不能使用该额度发放优惠券)5:冻结此参数不携带或携带值为空列表或携带值为null时,不作为筛选条件。
quota_type	integer	否	优惠券额度的类型。 0:代金券额度1:现金券额度此参数不携带或携带值为null时,默认值为“0:代金券额度”。
create_time_begin	string	否	创建时间(开始)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出创建时间大于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
create_time_end	string	否	创建时间(结束)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出创建时间小于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
effective_time_begin	string	否	生效时间(开始)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出生效时间大于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
effective_time_end	string	否	生效时间(结束)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出生效时间小于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
expire_time_begin	string	否	失效时间(开始)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出失效时间大于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
expire_time_end	string	否	失效时间(结束)。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出失效时间小于这个时间的记录。此参数不携带或携带值为null时,不作为筛选条件。
offset	integer	否	偏移量,从0开始。默认值为0。说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。
limit	integer	否	每次查询记录数。默认值为10。
indirect_partner_id	string	否	云经销商(二级经销商)ID。华为云总经销商(一级经销商)查询云经销商的优惠券额度时,需要携带该参数;否则只能查询自己的优惠券额度。

名称	类型	描述
total_count	integer	查询总数。
quotas	Array of CouponQuotaV2 objects	额度记录列表。具体请参见表1。

名称

类型

描述

total_count

integer

查询总数。

quotas

Array of CouponQuotaV2 objects

额度记录列表。具体请参见表1。

名称	类型	描述
quota_id	string	优惠券额度ID。
quota_type	integer	优惠券额度的类型: 0:代金券额度1:现金券额度
create_time	string	创建时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。
last_update_time	string	最后一次更新时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。
quota_value	number	优惠券额度的值,精确到小数点后2位。
quota_status	integer	优惠券额度的状态: 0:正常3:失效(过期失效和人工设置失效)4:额度调整中(伙伴可以查看该额度,但不能使用该额度发放优惠券)5:冻结
balance	number	剩余的优惠券额度,精确到小数点后2位。
measure_id	integer	面额单位。 1:元。
currency	string	币种。 CNY:人民币
effective_time	string	生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。
expire_time	string	失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。
limit_infos	Array of QuotaLimitInfo objects	优惠券额度上的限制属性,具体参见表2。

名称

类型

描述

quota_id

string

优惠券额度ID。

quota_type

integer

优惠券额度的类型: 0:代金券额度1:现金券额度

create_time

string

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

last_update_time

string

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

quota_value

number

优惠券额度的值,精确到小数点后2位。

quota_status

integer

优惠券额度的状态: 0:正常3:失效(过期失效和人工设置失效)4:额度调整中(伙伴可以查看该额度,但不能使用该额度发放优惠券)5:冻结

balance

number

剩余的优惠券额度,精确到小数点后2位。

measure_id

integer

面额单位。 1:元。

currency

string

币种。 CNY:人民币

effective_time

string

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

expire_time

string

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

limit_infos

Array of QuotaLimitInfo objects

优惠券额度上的限制属性,具体参见表2。

名称	类型	描述
limit_key	string	属性key值。
limit_values	Array of LimitValue objects	属性值,具体参见表3。

名称

类型

描述

limit_key

string

属性key值。

limit_values

Array of LimitValue objects

属性值,具体参见表3。

名称	类型	描述
value1	string	属性值1。
value2	string	属性值2。

名称

类型

描述

value1

string

属性值1。

value2

string

属性值2。

{ "quota_type": 1, "create_time_begin": "2017-12-17T10:32:02Z", "create_time_end": "2222-12-17T10:32:02Z", "effective_time_begin": "2019-05-06T08:05:01Z", "effective_time_end": "2222-05-06T08:05:01Z", "expire_time_begin": "2019-05-06T08:05:01Z", "expire_time_end": "2222-05-06T08:05:01Z", "offset": 0, "limit": 10 }

{ "total_count": 3, "quotas": [ { "quota_id": "2020040206297606", "quota_type": 1, "create_time": "2020-04-02T06:29:47Z", "last_update_time": "2020-04-02T06:29:47Z", "quota_value": 2000, "quota_status": 0, "balance": 2000, "measure_id": 1, "currency": "CNY", "effective_time": "2020-04-01T00:00:00Z", "expire_time": "2021-03-31T15:59:59Z", "limit_infos": [ { "limit_key": "associationType", "limit_values": [ { "value1": "3", "value2": null } ] }, { "limit_key": "isOnlyForStrictSelected", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "simultaneousUseWithEmpowerDiscount", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "chargeScene", "limit_values": [ { "value1": "6", "value2": null } ] } ] }, { "quota_id": "2020040206177605", "quota_type": 1, "create_time": "2020-04-02T06:17:03Z", "last_update_time": "2020-04-02T06:17:03Z", "quota_value": 2000, "quota_status": 0, "balance": 2000, "measure_id": 1, "currency": "CNY", "effective_time": "2020-04-01T00:00:00Z", "expire_time": "2021-03-31T15:59:59Z", "limit_infos": [ { "limit_key": "associationType", "limit_values": [ { "value1": "3", "value2": null } ] }, { "limit_key": "isOnlyForStrictSelected", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "simultaneousUseWithEmpowerDiscount", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "chargeScene", "limit_values": [ { "value1": "6", "value2": null } ] } ] }, { "quota_id": "2020040206167604", "quota_type": 1, "create_time": "2020-04-02T06:16:14Z", "last_update_time": "2020-04-02T06:16:14Z", "quota_value": 10000.03, "quota_status": 0, "balance": 10000.03, "measure_id": 1, "currency": "CNY", "effective_time": "2020-04-01T00:00:00Z", "expire_time": "2021-03-31T15:59:59Z", "limit_infos": [ { "limit_key": "associationType", "limit_values": [ { "value1": "3", "value2": null } ] }, { "limit_key": "isOnlyForStrictSelected", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "simultaneousUseWithEmpowerDiscount", "limit_values": [ { "value1": "1", "value2": null } ] }, { "limit_key": "chargeScene", "limit_values": [ { "value1": "6", "value2": null } ] } ] } ] }

本文导读