All Products
Search
Document Center

Function Compute (2.0):ListInstances

Last Updated:Jan 22, 2024

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

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of the service.

demoService
functionNamestringYes

The name of the function.

demoFunction
qualifierstringNo

The version or alias.

dev
instanceIdsarrayNo

The instance ID.

stringNo

The instance ID.

["1ef6b6ff-7f7b-485e-ab49-501ac681****", "04db0821-c6d2-4c10-970b-93e36f1a****"]
limitintegerNo

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-IdstringYes

The ID of your Alibaba Cloud account.

188077086902****

Response parameters

ParameterTypeDescriptionExample
object

The information about instances.

instancesobject []

The information about instances.

instanceIdstring

The instance ID.

1ef6b6ff-7f7b-485e-ab49-501ac681****
versionIdstring

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 timeSummary of changesOperation
2022-06-15Add Operationsee changesets