ListInstances - 查看实例信息

查询函数当前的可用实例列表。

接口说明

ListInstances 接口提供了查询函数当前可用实例的能力。

可用实例是指正在执行请求,或者可被调度以处理请求的实例。ListInstances 接口查询得到的实例与具有相同 ServiceNameFunctionNameQualifier的 InvokeFunction 接口流量链路下的活跃实例保持一致。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
fc:ListInstancesget
  • 全部资源
    *

请求语法

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

请求参数

名称类型必填描述示例值
serviceNamestring

服务的名称。

demoService
functionNamestring

函数的名称。

demoFunction
qualifierstring

版本或者别名。

dev
instanceIdsarray

实例 ID。

string

实例 ID。

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

限定此次返回资源的数量,取值范围[0,1000]。

返回结果可以小于指定的数量,但不能多于指定的数量。

20
X-Fc-Account-Idstring

您的阿里云账号(主账号)ID。

188077086902****

返回参数

名称类型描述示例值
object

查询返回的实例信息列表。

instancesarray<object>

查询返回的实例信息列表。

instancesobject

实例信息。

instanceIdstring

实例 ID。

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

实例所属的服务版本。如果是 LATEST 别名下的函数实例,则返回版本号为 0。

1

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-27API 内部配置变更,不影响调用查看变更详情
2024-02-19API 内部配置变更,不影响调用查看变更详情
2022-06-15新增 OpenAPI查看变更详情