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

Queries the redemption ticket information of a user.

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 of the expiration period. Format: yyyy-MM-ddTHH:mm:ssZ.	2018-08-01T00:00:00Z
ExpiryTimeEnd	string	No	The end time of the expiration period. Format: yyyy-MM-ddTHH:mm:ssZ.	2018-08-01T00:00:00Z
EffectiveOrNot	boolean	No	Specifies whether the redemption ticket is effective. Valid values: true: Effective. false: Not effective. Default value: false.	true
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. The value cannot exceed 300.	10

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful
RequestId	string	The request ID.	E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B
Success	boolean	Indicates whether the request is successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	1
Redeem	object
Redeem	array<object>	The redemption ticket details.
	object
ExpiryTime	string	The expiration time of the redemption ticket. Format: YYYY-MM-DD HH:mm:ss.	2018-06-13 20:25:00
GrantedTime	string	The issue time of the redemption ticket. Format: YYYY-MM-DD HH:mm:ss.	2018-05-14 20:25:00
Status	string	The status of the redemption ticket. Valid values: Generated: Generated. CallBack: Called back. RefundPending: Refund in progress. Canceled: Canceled. Order_Canceled: Order canceled. ActivePending: Activating. ActiveSuccess: Activated. ExchangePending: Exchanging. ExchangeSuccess: Exchanged. Expired: Expired. Invalid: Invalid.	Generated
Specification	string	The specifications of the redemption ticket.	None
NominalValue	string	The face value.	0
EffectiveTime	string	The effective period of the redemption ticket. Format: YYYY-MM-DD HH:mm:ss.	2018-05-14 20:25:00
RedeemId	string	The redemption ticket ID.	1342
RedeemNo	string	The redemption ticket number.	4889*****1610
ApplicableProducts	string	The applicable products.	Elastic Compute Service
Balance	string	The balance.	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": "无",
          "NominalValue": "0",
          "EffectiveTime": "2018-05-14 20:25:00",
          "RedeemId": "1342",
          "RedeemNo": "4889*****1610",
          "ApplicableProducts": "云服务器",
          "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.