ListInstances - Function Compute - Alibaba Cloud Documentation Center

Operation description

The ListInstances API lets you list the active instances for a function.

An active instance is either processing a request or ready to be scheduled to process a request. The instances returned by ListInstances match the active instances in the traffic path of the InvokeFunction API with the same ServiceName, FunctionName, and Qualifier.

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

fc:ListInstances

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	Name of the service.	demoService
functionName	string	Yes	Name of the function.	demoFunction

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	Version or alias.	dev
instanceIds	array	No	The ID of the instance.
	string	No	Instance ID.	["1ef6b6ff-7f7b-485e-ab49-501ac681**", "04db0821-c6d2-4c10-970b-93e36f1a**"]
limit	integer	No	Maximum number of instances to return. Valid values: 0 to 1000. The actual number of results may be less than this value, but never more.	20
X-Fc-Account-Id	string	No	Your Alibaba Cloud account ID.	188077086902****
X-Fc-Date	string	No
X-Fc-Trace-Id	string	No

Response elements

Element	Type	Description	Example
	object	List of instance information returned by the query.
instances	array<object>	List of instance information returned by the query.
	object	Instance information.
instanceId	string	Instance ID.	1ef6b6ff-7f7b-485e-ab49-501ac681****
versionId	string	Service edition that the instance belongs to. If the instance belongs to a function under the LATEST alias, the version ID is 0.	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.