Queries prepaid cards.
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:QueryPrepaidCards | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ExpiryTimeEnd | string | No | The end of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format. | 2018-08-01T00:00:00Z |
ExpiryTimeStart | string | No | The start of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format. | 2018-08-01T00:00:00Z |
EffectiveOrNot | boolean | No | Specifies whether the prepaid card takes effect. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "Success",
"Message": "Successful",
"RequestId": "7EA6C02D-06D0-4213-9C3B-E67910F7D1EB",
"Success": true,
"Data": {
"PrepaidCard": [
{
"Status": "Available",
"ExpiryTime": "2019-08-04T01:39:11Z",
"GrantedTime": "2018-08-03T01:39:11Z",
"NominalValue": "100.00",
"EffectiveTime": "2018-08-03T01:39:11Z",
"PrepaidCardNo": "Q-7edaab979fc9",
"ApplicableScenarios": "test",
"PrepaidCardId": 213432432,
"ApplicableProducts": "All Alibaba Cloud services\n",
"Balance": "100.00"
}
]
}
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | NotApplicable | This API is not applicable for caller. |
400 | NotAuthorized | This API is not authorized for caller. |
400 | MissingParameter | Some parameters arte mandatoryfor this request. |
400 | InvalidParameter | Some parameters are not valid. |
400 | InvalidOwner | The specifiedowner doesn’t belong to caller |
400 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
500 | UndefinedError | The request processing has failed due to some unknown error. |
For a list of error codes, visit the Service error codes.