ListInstances - Function Compute - Alibaba Cloud Documentation Center

Query a list of available instances of a function.

Operation description

The ListInstances operation allows you to query available instances of a function.

Available instances are instances that are processing requests or can be scheduled to process requests. Available instances queried by the ListInstances operation are the same as the active instances queried by using the InvokeFunction operation if values of ServiceName, FunctionName, and Qualifier are the same.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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
fc:ListInstances	get	All Resources *	none	none

Request syntax

GET /2021-04-06/services/{serviceName}/functions/{functionName}/instances

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demoService
functionName	string	Yes	The name of the function.	demoFunction
qualifier	string	No	The version or alias.	dev
instanceIds	array	No	The instance ID.
	string	No	The instance ID.	["1ef6b6ff-7f7b-485e-ab49-501ac681**", "04db0821-c6d2-4c10-970b-93e36f1a**"]
limit	integer	No	The maximum number of resources to return. Valid values: [0,1000]. The number of returned resources is less than or equal to the specified number.	20
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****

Response parameters

Parameter	Type	Description	Example
	object	The information about instances.
instances	array<object>	The information about instances.
	object	The instances that are queried.
instanceId	string	The instance ID.	1ef6b6ff-7f7b-485e-ab49-501ac681****
versionId	string	The version of service to which the instance belongs. If the instance belongs to the LATEST alias, 0 is returned as the version.	1

Examples

Sample success responses

JSONformat

{
  "instances": [
    {
      "instanceId": "1ef6b6ff-7f7b-485e-ab49-501ac681****",
      "versionId": "1"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-27	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-02-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-06-15	Add Operation	View Change Details