创建一个OpenSearch应用版本。
接口说明
- 若已存在同名标准版应用,则创建新版本;
- 在新建版本情况下,autoSwitch 和 realtimeShared 也是必填的;
- 在新建版本情况下,quota 是自动从上一个版本继承的;
- 在新建版本情况下,修改 quota 是无效的。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
opensearch:CreateApp |
|
| 无 |
请求语法
POST /v4/openapi/app-groups/{appGroupIdentity}/apps
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
appGroupIdentity | string | 是 | 应用名称 | my_app_group_name |
dryRun | boolean | 否 | 是否dryRun创建(仅校验数据源是否合法)。取值:-true 是 -false 否 | true |
body | App | 否 | 请求Body。 |
请求体
字段 | 类型 | 是否必要 | 示例值 | 描述 |
---|---|---|---|---|
type | String | 是 | "standard" | 应用类型 - standard 标准版 - enhanced 高级版 |
schema | Object | 是 | 应用版本结构 参考:Schema | |
fetchFields | Array | 是 | ["id", "name"] | 默认展示字段 |
realtimeShared | Boolean | 是 | false | 是否共享实时流 |
autoSwitch | Boolean | 是 | false | 是否自动切上线 |
description | String | 否 | "demo" | 备注 |
quota | Object | 否 | 版本配额信息 参考:Quota | |
dataSources[] | Object | 否 | 数据源详情 参考:DataSource | |
firstRanks[] | Object | 否 | 粗排表达式配置详情 参考:FirstRank | |
secondRanks[] | Object | 否 | 精排表达式配置详情 参考:SecondRank | |
queryProcessors[] | Object | 否 | 查询意图理解规则配置详情 参考:QueryProcessor | |
summaries[] | Object | 否 | 搜索结果摘要设置 参考:Summary |
返回参数
示例
正常返回示例
JSON
格式
{
"result": {},
"requestId": "ABCDEFG"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-05-30 | OpenAPI 入参发生变更 | 看变更集 | ||||
|