文档

CreateApp - 创建一个应用版本

更新时间:

创建一个OpenSearch应用版本。

接口说明

  • 若已存在同名标准版应用,则创建新版本;
  • 在新建版本情况下,autoSwitch 和 realtimeShared 也是必填的;
  • 在新建版本情况下,quota 是自动从上一个版本继承的;
  • 在新建版本情况下,修改 quota 是无效的。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:CreateAppWrite
  • App
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/apps

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name
dryRunboolean

是否 dryRun 创建(仅校验数据源是否合法)。取值:-true 是 -false 否

true
bodyApp

请求 Body。

请求体

字段类型是否必要示例值描述
typeString"standard"应用类型
- standard 标准版
- enhanced 高级版
schemaObject应用版本结构
参考: Schema
fetchFieldsArray["id", "name"]默认展示字段
realtimeSharedBooleanfalse是否共享实时流
autoSwitchBooleanfalse是否自动切上线
descriptionString"demo"备注
quotaObject版本配额信息
参考: Quota
dataSources[]Object数据源详情
参考: DataSource
firstRanks[]Object粗排表达式配置详情
参考: FirstRank
secondRanks[]Object精排表达式配置详情
参考: SecondRank
queryProcessors[]Object查询意图理解规则配置详情
参考: QueryProcessor
summaries[]Object搜索结果摘要设置
参考: Summary

返回参数

名称类型描述示例值
object
resultobject

返回结果

{}
requestIdstring

请求 ID

ABCDEFG

示例

正常返回示例

JSON格式

{
  "result": {},
  "requestId": "ABCDEFG"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:body