文档

DescribeBenefits - 查询渠道权益

更新时间:

查询渠道关联的权益规格、权益数量等信息,相关信息可用于渠道权益的发放。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeBenefitsWrite
  • acs:ecd::{#accountId}:*

请求参数

名称类型必填描述示例值
ChannelIdstring

渠道 ID。权益查询的目标渠道。

wuying****

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求 ID。

25BB1CE-6B47-12DC-9FE6-03726****
Benefitsobject []

权益列表。

BenefitIdstring

权益 ID。不同规格的权益,对应不同的权益 ID。

6a79****
BenefitTypestring

权益类型。

枚举值:
  • Desktop.TimePack云电脑时长包
Desktop.TimePack
TotalAmountinteger

权益总量。

100
AvailableAmountinteger

权益余量,即可用量,数量随着权益发放而减少。

80
SpecInfoobject

权益规格详情。

CpuCoreinteger

vCPU 核数。

4
AvailableHoursinteger

可用时长,单位:小时。

800
MemorySizeinteger

内存大小,单位:MB。

8192

示例

正常返回示例

JSON格式

{
  "RequestId": "25BB1CE-6B47-12DC-9FE6-03726****",
  "Benefits": [
    {
      "BenefitId": "6a79****",
      "BenefitType": "Desktop.TimePack",
      "TotalAmount": 100,
      "AvailableAmount": 80,
      "SpecInfo": {
        "CpuCore": 4,
        "AvailableHours": 800,
        "MemorySize": 8192
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈