通过实例ID和模型名称查询特定模型的详细配置信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetModel | get | *Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/models/{modelName} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
| modelName | string | 是 | 模型名称 | test |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
"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}\\\"}\n",
"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"
}
}错误码
访问错误中心查看更多错误码。