调用ListModels查询指定实例的模型列表-智能开放搜索 OpenSearch-阿里云

通过实例ID查询指定条件下的模型列表。

接口说明

请求说明

本 API 用于从指定实例中获取模型列表，支持通过模型名称、类型以及分页参数进行筛选。请求时需提供实例 ID 作为路径参数，其他筛选条件为可选的查询参数。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

searchengine:ListModels

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求语法

GET /openapi/ha3/instances/{instanceId}/models HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-test
name	string	否	模型名称	test1
type	string	否	模型类别	text_embedding
pageNumber	integer	否	页数，默认为 1	1
pageSize	integer	否	每页显示条数，默认为 10	10

返回参数

名称	类型	描述	示例值
	object	返回参数包括请求 ID 和模型列表，其中模型列表中的每个元素包含模型的详细信息如名称、类型、URL、状态等。
requestId	string	请求 ID	38b079f1-7846-4226-8c90-3e2644b5c52b
totalCount	integer	总数	14
result	array<object>	模型列表参考：Model
	object	模型信息
name	string	模型名称	test
type	string	模型类别 a. 文本向量化：text_embedding b. 文本稀疏向量化：text_sparse_embedding c. 图片向量化：image_embedding d. 图片内容解析：image_analyze	text_embedding
url	string	模型服务的访问地址	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	模型状态。 ok: 模型可用 forbidden: 模型不可用	ok
dimension	integer	模型的维度	128
content	object	模型的内容信息
modelName	string	模型名称	test
modelType	string	模型类别 a. 文本向量化：text_embedding b. 文本稀疏向量化：text_sparse_embedding c. 图片向量化：image_embedding d. 图片内容解析：image_analyze	text_embedding
url	string	模型服务的访问地址	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	模型服务访问的 http method, 支持 PUT 和 POST	POST
request	object	请求配置信息
header	object	访问模型服务的 http header
Authorization	string	认证信息，格式:Bearer access_token	Bearer OS-v0********6vvs
Content-Type	string	HTTP 请求内容类型。	application/json
urlParams	object	url 中的参数，有限模型服务需要从 url 上传递参数。
build	object	构建索引时传递的参数	key: value
search	object	查询时传递的参数	key: value
requestBody	string	请求 Body 体的模板字符串	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
parameters	object	如果 body 中的参数需要区分 build 和 search 阶段，可以定义在这个参数中。
build	object	索引构建阶段的参数
input_type	string	输入类型	query
search	object	查询阶段的参数
input_type	string	输入类型	document
response	object	如何解析结果信息，使用 json path 格式描述
embeddings	string	如何解析结果信息，使用 json path 格式描述	$.result.embeddings[*].embedding
createTime	string	创建时间	2024-05-21 16:05:26
updateTime	string	修改时间	2024-05-21 16:05:26

示例

正常返回示例

JSON格式

{
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "totalCount": 14,
  "result": [
    {
      "name": "test",
      "type": "text_embedding",
      "url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
      "status": "ok",
      "dimension": 128,
      "content": {
        "modelName": "test",
        "modelType": "text_embedding",
        "url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
        "method": "POST",
        "request": {
          "header": {
            "Authorization": "Bearer OS-v0********6vvs\n",
            "Content-Type": "application/json\n"
          },
          "urlParams": {
            "build": {
              "test": "test",
              "test2": 1
            },
            "search": {
              "test": "test",
              "test2": 1
            }
          },
          "requestBody": "{\\\"input\\\": [\\\"%{input}\\\"], \\\"input_type\\\": \\\"%{input_type}\\\"}",
          "parameters": {
            "build": {
              "input_type": "query\n"
            },
            "search": {
              "input_type": "document\n"
            }
          }
        },
        "response": {
          "embeddings": "$.result.embeddings[*].embedding\n"
        }
      },
      "createTime": "2024-05-21 16:05:26",
      "updateTime": "2024-05-21 16:05:26"
    }
  ]
}

错误码

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

变更历史

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