使用ListFunctionInstances获取功能实例列表-智能开放搜索 OpenSearch-阿里云-智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取用户下，符合条件的所有实例。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:DescribeFunction

get

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

无

请求语法

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	app_group_name
functionName	string	是	功能名称	ctr

请求参数

名称	类型	必填	描述	示例值
modelType	string	否	模型类型	tf_checkpoint
functionType	string	否	功能类型	"PAAS"
source	string	否	实例来源 builtin 系统实例 user 用户实例（默认） all 全部实例	user
pageNumber	integer	否	页码，默认值为 1	1
pageSize	integer	否	每页大小，默认值为 10	10
output	string	否	返回信息的丰富度 normal：显示 createParameters, cron 等信息（默认） simple：只显示基本信息 detail：返回训练任务详细信息	normal

示例

GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple

返回参数

名称	类型	描述	示例值
	object	响应体
status	string
httpCode	integer
totalCount	integer
requestId	string
message	string
code	string
result	array<object>
	array<object>
belongs	object
category	string
domain	string
language	string
createParameters	array<object>
	object
name	string
value	string
usageParameters	array<object>
	object
	string
createTime	integer
description	string
functionName	string
functionType	string
instanceName	string
modelType	string
source	string
status	string
versionId	integer
extendInfo	string
cron	string
task	object
dagStatus	string
lastRunTime	integer
modifyTime	integer
latency	integer

正常返回结果：

{
    "status": "OK",
    "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "totalCount": 2,
    "result": [
        {
            "versionId": 100,
            "instanceName": "instance_1",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 100010,
            "source": "user"
        },
        {
            "versionId": 100,
            "instanceName": "instance_2",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 200020,
            "source": "user",
            "default": true
        }
    ]
}

示例

正常返回示例

JSON格式

{
  "status": "",
  "httpCode": 0,
  "totalCount": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "result": [
    {
      "belongs": {
        "category": "",
        "domain": "",
        "language": ""
      },
      "createParameters": [
        {
          "name": "",
          "value": ""
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ],
      "createTime": 0,
      "description": "",
      "functionName": "",
      "functionType": "",
      "instanceName": "",
      "modelType": "",
      "source": "",
      "status": "",
      "versionId": 0,
      "extendInfo": "",
      "cron": "",
      "task": {
        "dagStatus": "",
        "lastRunTime": 0
      },
      "modifyTime": 0
    }
  ],
  "latency": 0
}

错误码

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

变更历史

更多信息，参考变更详情。