Queries available instances.
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 Resourcesis 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:QueryAvailableInstances | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Region | string | No | The ID of the region in which the instance resides. | cn-hangzhou |
| PageNum | integer | No | The number of the page to return. | 1 |
| PageSize | integer | No | The number of entries to return on each page. | 20 |
| ProductCode | string | No | The code of the service. You can query the service code by calling the QueryProductList operation or viewing Codes of Alibaba Cloud services. Note
This parameter cannot be left empty if the region is specified.
| rds |
| ProductType | string | No | The type of the service. | rds |
| SubscriptionType | string | No | The billing method. Valid values:
| Subscription |
| InstanceIDs | string | No | The ID of the instance. Separate multiple IDs with commas (,). You can specify a maximum of 100 IDs. | rm-xxxxxxxxxxxx |
| EndTimeStart | string | No | The beginning of the 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. Example: 2016-05-23T12:00:00Z. | 2016-05-23T12:00:00Z |
| EndTimeEnd | string | No | The end of the 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. Example: 2016-05-23T12:00:00Z. | 2016-05-23T12:00:00Z |
| CreateTimeStart | string | No | The start time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2016-05-23T12:00:00Z |
| CreateTimeEnd | string | No | The end time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2016-05-23T12:00:00Z |
| RenewStatus | string | No | The renewal status of the specified instance. Valid values:
| AutoRenewal |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
"Success": true,
"Data": {
"PageNum": 1,
"PageSize": 10,
"TotalCount": 11,
"InstanceList": [
{
"SubStatus": "Normal: The pay-as-you-go module can properly run. WaitForLimit: The pay-as-you-go module is about to be limited due to overdue payments. BandwidthLimited: The pay-as-you-go module is limited due to overdue payments.\n",
"Status": "Creating: The instance is being created. WaitForExpire: The instance is about to expire. Normal: The instance can properly run. Expired: The instance is expired.\n",
"ExpectedReleaseTime": "2019-09-08T16:00:00Z",
"RenewStatus": "ManualRenewal",
"CreateTime": "2019-09-08T16:00:00Z",
"SellerId": 123123123,
"InstanceID": "1049056",
"Seller": "123123123",
"StopTime": "2019-09-08T16:00:00Z",
"RenewalDurationUnit": "M",
"SubscriptionType": "Subscription",
"OwnerId": 325352345,
"EndTime": "2019-09-08T16:00:00Z",
"ProductType": "rds",
"Region": "cn-hangzhou",
"ReleaseTime": "2019-09-08T16:00:00Z",
"RenewalDuration": 1,
"ProductCode": "rds"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.