Query available instances by using QueryAvailableInstances - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries the list of available instances for the user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region.	cn-hangzhou
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 300.	20
ProductCode	string	No	The product code. You can call the QueryProductList operation to query product codes. Note If the region is specified, this parameter cannot be empty.	rds
ProductType	string	No	The product type.	rds
SubscriptionType	string	No	The subscription type. Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription
InstanceIDs	string	No	The instance IDs. Separate multiple IDs with commas. You can specify up to 100 IDs.	rm-xxxxxxxxxxxx
EndTimeStart	string	No	The start time of the expiration time range. Specify the time in the ISO 8601 standard in the UTC format. Example: 2016-05-23T12:00:00Z.	2016-05-23T12:00:00Z
EndTimeEnd	string	No	The end time of the expiration time range. Specify the time in the ISO 8601 standard in the UTC format. Example: 2016-05-23T12:00:00Z.	2016-05-23T12:00:00Z
CreateTimeStart	string	No	The start time of the creation time range. Specify the time in the ISO 8601 standard in the UTC format.	2016-05-23T12:00:00Z
CreateTimeEnd	string	No	The end time of the creation time range. Specify the time in the ISO 8601 standard in the UTC format.	2016-05-23T12:00:00Z
RenewStatus	string	No	The renewal status. Valid values: AutoRenewal: auto-renewal. ManualRenewal: manual renewal. NotRenewal: no renewal.	AutoRenewal

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful!
RequestId	string	The request ID.	C7C15585-8349-4C62-BEE4-5A391841B9BE
Success	boolean	Indicates whether the request is successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	11
InstanceList	array<object>	The list of instance information.
	object
SubStatus	string	The sub-status.	Normal - The pay-as-you-go module is normal. WaitForLimit - The pay-as-you-go module is about to be restricted due to overdue payments. BandwidthLimited - The pay-as-you-go module is restricted due to overdue payments
Status	string	The status.	Creating - The resource is being created. WaitForExpire - The service is about to be suspended. Normal - Normal. Expired - The service is suspended
ExpectedReleaseTime	string	The expected release time. The time is in the ISO 8601 standard in the UTC format (YYYY-MM-DDTHH:mm:ssZ).	2019-09-08T16:00:00Z
RenewStatus	string	The renewal status. Valid values: AutoRenewal: auto-renewal. ManualRenewal: manual renewal. NotRenewal: no renewal.	ManualRenewal
CreateTime	string	The creation time. The time is in the ISO 8601 standard in the UTC format (YYYY-MM-DDTHH:mm:ssZ).	2019-09-08T16:00:00Z
SellerId	integer	The seller ID.	123123123
InstanceID	string	The instance ID.	1049056
Seller	string	The seller.	123123123
StopTime	string	The stop time. The time is in the ISO 8601 standard in the UTC format (YYYY-MM-DDTHH:mm:ssZ).	2019-09-08T16:00:00Z
RenewalDurationUnit	string	The unit of the auto-renewal epoch. Valid values: M: month. Y: year.	M
SubscriptionType	string	The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription
OwnerId	integer	The owner ID.	325352345
EndTime	string	The end time. The time is in the ISO 8601 standard in the UTC format (YYYY-MM-DDTHH:mm:ssZ).	2019-09-08T16:00:00Z
ProductType	string	The product type.	rds
Region	string	The region.	cn-hangzhou
ReleaseTime	string	The release time. The time is in the ISO 8601 standard in the UTC format (YYYY-MM-DDTHH:mm:ssZ).	2019-09-08T16:00:00Z
RenewalDuration	integer	The number of auto-renewal epochs.	1
ProductCode	string	The product code.	rds

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 11,
    "InstanceList": [
      {
        "SubStatus": "Normal-后付费模块正常\nWaitForLimit-后付费模块即将欠费受限\nBandwidthLimited-后付费模块欠费受限",
        "Status": "Creating-资源创建中\nWaitForExpire-即将停服\nNormal-正常\nExpired-停服",
        "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.