DescribeBenefits-阿里云帮助中心

Queries the specifications, quantity, and other details of benefits associated with a channel to support benefit distribution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeBenefits

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ChannelId	string	Yes	The ID of the channel for the benefit query.	wuying****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	25BB1CE-6B47-12DC-9FE6-03726****
Benefits	array<object>	The list of benefits.
	array<object>	The list of benefit objects.
BenefitId	string	The benefit ID. Each benefit specification has a unique benefit ID.	6a79****
BenefitType	string	The type of the benefit. Valid values: Desktop.TimePack : Cloud computer time pack	Desktop.TimePack
TotalAmount	integer	The total quantity of the benefit.	100
AvailableAmount	integer	The available quantity of the benefit. This number decreases as benefits are distributed.	80
SpecInfo	object	The details of the benefit specification.
CpuCore	integer	The number of vCPU cores.	4
AvailableHours	integer	The available duration, in hours.	800
MemorySize	integer	The memory size, in MB.	8192

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.