List Function Instances with ListInstances API - Function Compute - Alibaba Cloud - Function Compute

Lists function instances.

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

list

*All Resource

*

None

Request syntax

GET /2023-03-30/functions/{functionName}/instances HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	Yes	The function name.	my-func

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	The function version or alias.	LATEST
withAllActive	boolean	No	Specifies whether to list all active instances.	true
instanceStatus	array	No	An array of instance statuses. The operation returns only instances whose status is in this array.
	string	No	The instance status.
startTimeMs	integer	No	The start time of the query range, specified as a UNIX timestamp in milliseconds.
endTimeMs	integer	No	The end time of the query range, specified as a UNIX timestamp in milliseconds.
startKey	string	No	The token that specifies where to start the query. It is returned in a truncated response and can be used to retrieve the next page of results.
limit	string	No	The maximum number of instances to return.
instanceIds	array	No	A list of instance IDs to return.
	string	No	The instance ID.

Response elements

Element	Type	Description	Example
	ListInstancesOutput	The list of function instances.

Examples

Success response

JSON format

{
  "instances": [
    {
      "instanceId": "1ef6b6ff-7f7b-485e-ab49-501ac681****",
      "versionId": "0",
      "qualifier": "",
      "status": "",
      "createdTimeMs": 0,
      "destroyedTimeMs": 0,
      "resourceType": ""
    }
  ],
  "requestId": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.