List active instances for a function by using ListInstances - Function Compute - Alibaba Cloud -

Operation description

The ListInstances operation queries the currently available instances for a function.

Available instances are instances that are executing requests or can be scheduled to process requests. The instances returned by the ListInstances operation are consistent with the active instances on the traffic path of the InvokeFunction operation that has 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	The name of the service.	demoService
functionName	string	Yes	The name of the function.	demoFunction

Request parameters

Parameter	Type	Required	Description	Example
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 to 1000. The number of returned results can be less than the specified number but cannot exceed it.	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	The list of instance information returned by the query.
instances	array<object>	The list of instance information returned by the query.
	object	The instance information.
instanceId	string	The instance ID.	1ef6b6ff-7f7b-485e-ab49-501ac681****
versionId	string	The service version to which the instance belongs. If the function instance belongs to the LATEST alias, the version number 0 is returned.	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.