Queries the information about a redemption coupon.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
bssapi:QueryRedeem | Read |
|
| 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:
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 parameters
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-08-08 | API Description Update. The Error code has changed | see changesets | ||||||||
|