查看一个 OpenSearch 应用版本详情
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId] HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
appGroupIdentity | String | Path | 是 | my_app_group_name |
应用名称 |
appId | Integer | Path | 是 | 110116134 |
版本ID |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
requestId | String | 33477D76-C380-1D84-A4AD-043F52876CB1 |
请求ID |
result | Struct |
版本信息 |
|
algoDeploymentId | Integer | 0 |
粗排部署 ID |
autoSwitch | Boolean | true |
是否自动切换 |
clusterName | String | - |
簇id |
created | Integer | 1590977140 |
版本创建时间戳 |
description | String | - |
版本描述 |
domain | Struct |
部署领域 |
|
category | String | - |
类型 |
functions | Struct |
功能 |
|
algo | List | - |
算法 |
qp | List | - |
查询分析 |
service | List | - |
服务 |
name | String | - |
名称 |
fetchFields | List | {} |
默认展示字段 |
id | String | 100303063 |
版本ID |
progressPercent | Integer | 100 |
数据导入进度百分比(如83代表83%) |
quota | Struct |
配额信息 |
|
computeResource | Integer | 20 |
计算资源 (单位:LCU) |
docSize | Integer | 1 |
存储容量 (单位:GB) |
qps | Integer | 5 |
搜索请求(单位:次/秒) (老计费模型使用) |
spec | String | opensearch.share.common |
规格
|
schema | Map | {} |
应用结构 |
status | String | ok |
版本状态
|
type | String | enhanced |
版本类型
|
示例
请求示例
GET /v4/openapi/app-groups/os_function_test_v1/apps/100303063
正常返回示例
XML
格式
<requestId>33477D76-C380-1D84-A4AD-043F52876CB1</requestId>
<result>
<id>100303063</id>
<description/>
<status>ok</status>
<fetchFields>id</fetchFields>
<fetchFields>title</fetchFields>
<fetchFields>buy</fetchFields>
<fetchFields>cate_id</fetchFields>
<fetchFields>cate_name</fetchFields>
<type>enhanced</type>
<schema>
<tables>
<main>
<primaryTable>true</primaryTable>
<name>main</name>
<fields>
<id>
<name>id</name>
<type>LITERAL</type>
<primaryKey>true</primaryKey>
</id>
<title>
<name>title</name>
<type>TEXT</type>
<primaryKey>false</primaryKey>
</title>
<buy>
<name>buy</name>
<type>INT</type>
<primaryKey>false</primaryKey>
</buy>
<cate_id>
<name>cate_id</name>
<type>INT</type>
<primaryKey>false</primaryKey>
</cate_id>
<cate_name>
<name>cate_name</name>
<type>LITERAL</type>
<primaryKey>false</primaryKey>
</cate_name>
</fields>
</main>
</tables>
<indexes>
<searchFields>
<id>
<fields>id</fields>
</id>
<default>
<fields>title</fields>
<analyzer>chn_standard</analyzer>
</default>
<buy>
<fields>buy</fields>
</buy>
</searchFields>
<filterFields>id</filterFields>
<filterFields>buy</filterFields>
<filterFields>cate_id</filterFields>
<filterFields>cate_name</filterFields>
</indexes>
</schema>
<algoDeploymentId>0</algoDeploymentId>
<firstRanks>
<id/>
<name>default</name>
<description/>
<active>false</active>
<type>STRUCT</type>
<meta>
<attribute>static_bm25()</attribute>
<arg/>
<weight>1</weight>
</meta>
<created>0</created>
<updated>0</updated>
</firstRanks>
<firstRanks>
<id>887857</id>
<name>first_rank_lsh_1</name>
<description/>
<active>true</active>
<type>STRUCT</type>
<meta>
<attribute>static_bm25()</attribute>
<arg/>
<weight>10</weight>
</meta>
<meta>
<attribute>exact_match_boost()</attribute>
<arg/>
<weight>20</weight>
</meta>
<meta>
<attribute>buy</attribute>
<arg/>
<weight>30</weight>
</meta>
<created>1590977140</created>
<updated>1590977140</updated>
</firstRanks>
<secondRanks>
<id>-1</id>
<name>default</name>
<meta/>
<active>true</active>
<description/>
<created>0</created>
<updated>0</updated>
</secondRanks>
<summaries>
<name>default</name>
<meta>
<field>title</field>
<len>50</len>
<element>em</element>
<ellipsis>...</ellipsis>
<snippet>1</snippet>
</meta>
</summaries>
<created>1590977140</created>
<queryProcessors>
<name>sum_lsh_test_1</name>
<active>true</active>
<indexes>default</indexes>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<interventionDictionary/>
<name>stop_word</name>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<interventionDictionary/>
<name>spell_check</name>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<interventionDictionary/>
<name>term_weighting</name>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<interventionDictionary/>
<name>synonym</name>
</processors>
<domain>GENERAL</domain>
<created>1590977142</created>
<updated>1590977142</updated>
</queryProcessors>
<progressPercent>100</progressPercent>
</result>
JSON
格式
{
"requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
"result": {
"id": 100303063,
"description": "",
"status": "ok",
"fetchFields": [
"id",
"title",
"buy",
"cate_id",
"cate_name"
],
"type": "enhanced",
"schema": {
"tables": {
"main": {
"primaryTable": true,
"name": "main",
"fields": {
"id": {
"name": "id",
"type": "LITERAL",
"primaryKey": true
},
"title": {
"name": "title",
"type": "TEXT",
"primaryKey": false
},
"buy": {
"name": "buy",
"type": "INT",
"primaryKey": false
},
"cate_id": {
"name": "cate_id",
"type": "INT",
"primaryKey": false
},
"cate_name": {
"name": "cate_name",
"type": "LITERAL",
"primaryKey": false
}
}
}
},
"indexes": {
"searchFields": {
"id": {
"fields": "id"
},
"default": {
"fields": "title",
"analyzer": "chn_standard"
},
"buy": {
"fields": "buy"
}
},
"filterFields": [
"id",
"buy",
"cate_id",
"cate_name"
]
}
},
"algoDeploymentId": 0,
"firstRanks": [
{
"id": "",
"name": "default",
"description": "",
"active": false,
"type": "STRUCT",
"meta": {
"attribute": "static_bm25()",
"arg": "",
"weight": 1
},
"created": 0,
"updated": 0
},
{
"id": 887857,
"name": "first_rank_lsh_1",
"description": "",
"active": true,
"type": "STRUCT",
"meta": [
{
"attribute": "static_bm25()",
"arg": "",
"weight": 10
},
{
"attribute": "exact_match_boost()",
"arg": "",
"weight": 20
},
{
"attribute": "buy",
"arg": "",
"weight": 30
}
],
"created": 1590977140,
"updated": 1590977140
}
],
"secondRanks": {
"id": -1,
"name": "default",
"meta": "",
"active": true,
"description": "",
"created": 0,
"updated": 0
},
"summaries": {
"name": "default",
"meta": {
"field": "title",
"len": 50,
"element": "em",
"ellipsis": "...",
"snippet": 1
}
},
"created": 1590977140,
"queryProcessors": {
"name": "sum_lsh_test_1",
"active": true,
"indexes": "default",
"processors": [
{
"useSystemDictionary": true,
"interventionDictionary": "",
"name": "stop_word"
},
{
"useSystemDictionary": true,
"interventionDictionary": "",
"name": "spell_check"
},
{
"useSystemDictionary": true,
"interventionDictionary": "",
"name": "term_weighting"
},
{
"useSystemDictionary": true,
"interventionDictionary": "",
"name": "synonym"
}
],
"domain": "GENERAL",
"created": 1590977142,
"updated": 1590977142
},
"progressPercent": 100
}
}
错误码
访问错误中心查看更多错误码。