API Name
QueryAvailableInstances
Overview
You can call this operation to retrieve a list of available instances.
Request parameters
Name |
Type |
Required |
Description |
ProductCode |
String |
No |
The code of the specified product. This parameter cannot be empty when the region is specified. |
ProductType |
String |
No |
The type of the specified product. |
SubscriptionType |
String |
No |
The type of billing method. Valid values: Subscription, PayAsYouGo |
InstanceIDs |
String |
No |
The ID of the specified instance. Multiple instances are separated with commas (,). The maximum number of instances is 100. |
Region |
String |
No |
The region that the specified instance is located in. |
EndTimeStart |
String |
No |
The start time when the specified instance is expired. The time is the UTC time that follows the ISO8601 standard, such as 2016-05-23T12:00:00Z, which is Chinese Standard Time 2016-05-23 20:00:00. |
EndTimeEnd |
String |
No |
The end time when the specified instance is expired. The format is the same as EndTimeStart. |
CreateTimeStart |
String |
No |
The start time when the specified instance was created. The format is the same as EndTimeStart. |
CreateTimeEnd |
String |
No |
The end time when the specified instance was created. The format is the same as EndTimeStart. |
RenewStatus |
String |
No |
The renewal status of the specified instance. Valid values: AutoRenewal – auto renewal, ManualRenewal – manual renewal, NotRenewal – no renewal |
OwnerId |
String |
No |
This parameter is required if the owner is a reseller or a distributer. |
Response parameters
Name |
Type |
Required |
Success |
Boolean |
Indicates whether the call is successful. |
Code |
String |
The error code of a failed call. |
Message |
String |
The details of the response. |
RequestId |
String |
The GUID generated by Alibaba Cloud for the request. |
Data |
PagedBssResponse |
For more information, see the PagedBssResponse data dictionary. |
Data dictionary
PagedBssResponse
Name |
Type |
Description |
PageNum |
Integer |
The current page number, which starts from 1. |
PageSize |
Integer |
The number of items that are displayed on each page. |
TotalCount |
Integer |
The total number of pages. |
InstanceList |
List |
The list of available instances. For more information, see the BssInstanceInfo data dictionary. |
BssInstanceInfo
Name |
Type |
Description |
OwnerID |
String |
The ID of the owner. |
ProductCode |
String |
The code of the specified product. |
ProductType |
String |
The type of the specified product. |
SubscriptionType |
String |
The type of billing method. Valid values: Subscription, PayAsYouGo |
InstanceID |
String |
The ID of the specified instance. |
Region |
String |
The region that the specified instance is located in. |
CreateTime |
String |
The time when the specified instance was created. |
EndTime |
String |
The time when the specified instance is expired. |
StopTime |
String |
The time when the specified instance is suspended. |
ReleaseTime |
String |
The time when the specified instance is released. |
ExpectedReleaseTime |
String |
The expected time when the specified instance is released. |
Status |
String |
The status of the specified instance. |
SubStatus |
String |
The sub status of the specified instance. |
RenewStatus |
String |
The renewal status of the specified instance. Valid values: AutoRenewal – auto renewal, ManualRenewal – manual renewal, NotRenewal – no renewal |
RenewalDuration |
String |
The cycle of auto renewal. |
RenewalDurationUnit |
String The unit of the auto renewal cycle. Valid values: M-months and Y-years, Seller String The seller of the specified instance. |
Error codes
Error code |
Description |
HTTP status code |
Description |
NotApplicable |
This API is not applicable for caller. |
400 |
The error message returned when you are not authorized to use the API. |
MissingParameter |
The specified parameter xx is mandatory for this request. |
400 |
The error message returned when the xx parameter is not specified. |
InvalidParameter |
The specified parameter xx is not valid. |
400 |
The error message returned when the xx parameter is invalid. |
InvalidModuleCode |
The specified moduleCode is not valid. |
400 |
The error message returned when the specified moduleCode parameter is invalid. |
InvalidConfigCode |
The specified configCode is not valid. |
400 |
The error message returned when the specified configCode parameter is invalid. |
InvalidOwner |
The specified owner doesn’t belong to caller. |
400 |
The error message returned when the specified owner does not belong to the caller. |
InvalidCaller |
The specified caller doesn’t exists. |
400 |
The error message returned when the caller is invalid. |
InternalError |
The request processing has failed due to some unknown error, exception or failure. |
400 |
The error message returned when an unknown internal error occurs. |
ProductNotFind |
Can not find inquired product, it may not exist. |
400 |
The error message returned when the specified product is invalid. |
Sample requests
https://business.ap-southeast-1.aliyuncs.com/?Action=QueryAvailableInstances
&ProductCode=
&ProductType=
&SubscriptionType=
&InstanceIDs=
&Region=
&EndTimeStart=
&EndTimeEnd=
&CreateTimeStart=
&CreateTimeEnd=
&RenewStatus=
&OwnerId=
Sample responses
"Data": {
"TotalCount": 51,
"PageSize": 20,
"PageNum": 1,
"InstanceList": [
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "IFP-ji2gzgi11",
"ProductCode": "flowpack",
"CreateTime": "2999-09-08T16:00:00Z",
"OwnerId": "181****",
"EndTime": "2016-11-07T16:00:00Z",
"Seller": "26888"
},
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "IFP-6dyrcqrq1",
"ProductCode": "flowpack",
"CreateTime": "2999-09-08T16:00:00Z",
"OwnerId": "181****",
"EndTime": "2016-11-07T16:00:00Z",
"Seller": "26888"
},
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "IFP-ne1nt5uw1",
"ProductCode": "flowpack",
"CreateTime": "2999-09-08T16:00:00Z",
"OwnerId": "1812171928621610",
"EndTime": "2016-11-07T16:00:00Z",
"Seller": "26888"
},
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "IFP-vj5ry82x1",
"ProductCode": "flowpack",
"CreateTime": "2999-09-08T16:00:00Z",
"OwnerId": "1812171928621610",
"EndTime": "2016-11-07T16:00:00Z",
"Seller": "26888"
},
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "IFP-e6oupf251",
"ProductCode": "flowpack",
"CreateTime": "2999-09-08T16:00:00Z",
"OwnerId": "1812171928621610",
"EndTime": "2016-11-10T16:00:00Z",
"Seller": "26888"
}
]
},
"Message": "Successful!",
"RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
"Success": true,
"Code": "Success"