AI 助理
文档备案控制台
官方文档
首页 费用与成本 开发参考 API参考（2023-09-30） API目录 优惠券 DescribeCoupon - 查询优惠券列表

DescribeCoupon - 查询优惠券列表

更新时间：
复制 MD 格式
我的收藏

查询优惠券列表

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

bss:DescribeCoupon

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
EffectiveStartTime

integer

否

生效开始时间，使用 Unix 时间戳，单位为毫秒。

1684750028000
EffectiveEndTime

integer

否

生效结束时间，使用 Unix 时间戳，单位为毫秒。

1708423156000
ExpireStartDate

integer

否

失效开始时间，使用 Unix 时间戳，单位为毫秒。

1684750028000
ExpireEndDate

integer

否

失效结束时间，使用 Unix 时间戳，单位为毫秒。

1708423156000
Status

string

否

状态

AVAILABLE
CouponType

string

否

优惠券类型

CERTAIN
Nbid

string

否

一级场信息

2684201000001
CouponId

integer

否

优惠券 id

351430260343
CouponNo

string

否

券编码

554863270150
CurrentPage

integer

是

当前页码

1
PageSize

integer

是

每页大小

20
EcIdAccountIds

array<object>

否

企业与账号列表，为空表示查询当前账号自身

object

否

accountinfo

EcId

string

否

企业实体 ID

1501603440974415
AccountIds

array

否

访问的账号列表，为空代表全选当前实体 ID 下所有账号

integer

否

成员账号 ID。

1501603440974415
MaxResults

integer

否

单次查询的最大记录数。

NextToken

string

否

下一个查询开始 Token，为空表示没有下一页。

CouponTemplateIdList

array

否

优惠券模板 ID 列表。

integer

否

优惠券模板 ID。

ProductCode

string

否

产品 Code。

IncludeShare

boolean

否

是否包含共享优惠券。

返回参数

名称

类型

描述

示例值

object

BssApiPageResult

CurrentPage

integer

当前页码

1
PageSize

integer

每页大小

20
TotalCount

integer

总记录数

2
Data

array<object>

数据列表

array<object>

couponInfo

CouponId

integer

优惠券 ID

59243658
CouponNo

string

券编码

731074910070
CouponType

string

优惠券类型

CERTAIN
CouponTypeName

string

优惠券类型名称

满减券
Amount

string

面值

9929.750000
RemainAmount

string

剩余金额

100.00
ItemNames

array

产品 code 列表

string

适用商品名称

全产品适用
UniversalType

string

优惠券适用范围

UNIVERSAL
YhOrderTypes

array

优惠券适用订单类型列表

string

适用订单类型

新购
Status

string

状态

Available
GmtCreate

string

发券时间

2021-03-02T15:12Z

StartTime

string

开始时间，采用 ISO 8601 格式，时区为 UTC。

2021-03-02T15:12Z
EndTime

string

结束时间，采用 ISO 8601 格式，时区为 UTC。

2021-03-06T15:12Z
Site

string

站点

CHINA
SiteName

string

站点名称

官网自营
Remark

string

备注

新买28号
MoneyLimit

string

金额限制

无订单金额限制
Currency

string

币种

CNY
SuitAccount

string

适用账号

1902671110151254
OrderTimeRule

string

订单时长限制规则

预付费规则：购买订单时长大于3600s才能使用
ShareUidList

array<object>

共享账号列表

object

shareUidInfo

Uid

string

阿里云 uid

1902671110151254
UserNick

string

阿里云账号

阿里云计算有限公司
SuitItemType

string

适用产品类型：all 全产品通用 white 指定产品适用 black 指定产品不适用

all
ShowSetDeductTagButton

boolean

是否展示标签抵扣按钮

true
CertainAmount

string

CertainAmount

FirstBuy

boolean

是否有首购限制

RequestId

string

请求 ID。

C880B065-A781-4F19-B6DD-3E0E3B715C64

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Data": [
    {
      "CouponId": 59243658,
      "CouponNo": "731074910070",
      "CouponType": "CERTAIN",
      "CouponTypeName": "满减券",
      "Amount": "9929.750000",
      "RemainAmount": "100.00",
      "ItemNames": [
        "全产品适用"
      ],
      "UniversalType": "UNIVERSAL",
      "YhOrderTypes": [
        "新购"
      ],
      "Status": "Available",
      "GmtCreate": "2021-03-02T15:12Z\n",
      "StartTime": "2021-03-02T15:12Z",
      "EndTime": "2021-03-06T15:12Z",
      "Site": "CHINA",
      "SiteName": "官网自营",
      "Remark": "新买28号",
      "MoneyLimit": "无订单金额限制",
      "Currency": "CNY",
      "SuitAccount": "1902671110151254",
      "OrderTimeRule": "预付费规则：购买订单时长大于3600s才能使用",
      "ShareUidList": [
        {
          "Uid": "1902671110151254",
          "UserNick": "阿里云计算有限公司"
        }
      ],
      "SuitItemType": "all",
      "ShowSetDeductTagButton": true,
      "CertainAmount": "",
      "FirstBuy": true
    }
  ],
  "RequestId": "C880B065-A781-4F19-B6DD-3E0E3B715C64"
}

错误码

HTTP status code

错误码

错误信息

描述
400 AccountNoQueryPricePermission This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice. 由于您没有折扣查询权限，无法访问该页面。请联系主账号前往费用中心授权，需要授权的权限点为 queryprice
400 SubAccountNoQueryPricePermission This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice. 由于您没有折扣查询权限，无法访问该页面。请联系主账号前往RAM控制台授权，需要授权的Action为 bss:QueryPrice

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

变更历史

更多信息，参考变更详情。

上一篇：优惠券下一篇：DescribeCouponItemList - 查询优惠券可用商品列表