Query voucher information by calling the QueryRedeem API - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries the information about a voucher.

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

bssapi:QueryRedeem

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExpiryTimeStart	string	No	The start time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.	2018-08-01T00:00:00Z
ExpiryTimeEnd	string	No	The end time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.	2018-08-01T00:00:00Z
EffectiveOrNot	boolean	No	Specifies whether the redemption coupon takes effect. Valid values: true false Default value: false.	true
PageNum	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object
Code	string	The status code returned.	Success
Message	string	The message returned.	Successful
RequestId	string	The ID of the request.	E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B
Success	boolean	Indicates whether the request is successful.	true
Data	object	The data returned.
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	1
Redeem	object
Redeem	array<object>	The details of the redemption coupon.
	object
ExpiryTime	string	The time when the redemption coupon expired.	2018-06-13 20:25:00
GrantedTime	string	The time when the redemption coupon was issued.	2018-05-14 20:25:00
Status	string	The status of the redemption coupon. Valid values: Generated CallBack RefundPending Canceled Order_Canceled ActivePending ActiveSuccess ExchangePending ExchangeSuccess Expired	Generated
Specification	string	The specifications of the redemption coupon.	N/A
NominalValue	string	The nominal value of the redemption coupon.	0
EffectiveTime	string	The time when the redemption coupon took effect.	2018-05-14 20:25:00
RedeemId	string	The ID of the redemption coupon.	1342
RedeemNo	string	The number of the redemption coupon.	4889*****1610
ApplicableProducts	string	The services to which the redemption coupon is applicable.	Elastic Compute Service (ECS)
Balance	string	The balance of the redemption coupon.	0

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Redeem": {
      "Redeem": [
        {
          "ExpiryTime": "2018-06-13 20:25:00",
          "GrantedTime": "2018-05-14 20:25:00",
          "Status": "Generated",
          "Specification": "N/A\n",
          "NominalValue": "0",
          "EffectiveTime": "2018-05-14 20:25:00",
          "RedeemId": "1342",
          "RedeemNo": "4889*****1610",
          "ApplicableProducts": "Elastic Compute Service (ECS)\n",
          "Balance": "0"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
400	NotAuthorized	This API is not authorized for caller.
400	NotApplicable	This API is not applicable for caller.
400	InvalidOwner	The specified owner doesn't belong to caller.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.