Queries the instances of a resource plan. You can query the resource plans that are expired within one year.
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:QueryResourcePackageInstances | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ProductCode | string | No | The code of the service. | rds |
ExpiryTimeStart | string | No | The beginning of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2020-02-02T12:00:00Z |
ExpiryTimeEnd | string | No | The end of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2020-02-02T13:00:00Z |
PageNum | integer | No | The number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Default value: 20. Maximum value: 300. | 20 |
IncludePartner | boolean | No | Specifies whether partners are involved. | true |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
"Success": true,
"Code": "Success",
"Message": "Successful!",
"PageSize": 20,
"Total": 12,
"Page": 1,
"Data": {
"PageNum": "1",
"PageSize": "20",
"TotalCount": "12",
"HostId": "cn",
"Instances": {
"Instance": [
{
"ExpiryTime": "2019-03-12T16:00:00Z",
"Status": "Available",
"Remark": "",
"RemainingAmountUnit": "GB",
"InstanceId": "OSSBAG-cn-v0h1s4hma01",
"PackageType": "FPT_ossbag_absolute_Storage_sh",
"EffectiveTime": "2018-09-12T09:51:56Z",
"Region": "cn-hangzhou",
"TotalAmount": "40.000",
"DeductType": "Absolute",
"TotalAmountUnit": "GB",
"RemainingAmount": "40.000",
"ApplicableProducts": {
"Product": [
"{\"Product\": [\"oss\"] }"
]
},
"CommodityCode": "rds"
}
]
}
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | NotApplicable | This API is not applicable for caller. | - |
400 | NotAuthorized | This API is not authorized for caller. | - |
400 | MissingParameter | Absent some mandatory parameter for this request. | - |
400 | InvalidParameter | This request contain some invalid parameter | - |
400 | InvalidOwner | The specified owner doesn't belong to caller. | Invalid user identity. |
400 | OwnerIdInvalid | Parameter ownerId is invalid. | - |
400 | OwnerIdMissing | Paramter ownerId is missing. | - |
500 | InternalError | The request processing has failed due to some unknown error. | - |
For a list of error codes, visit the Service error codes.