创建一个OpenSearch应用

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /v4/openapi/app-groups HTTP/1.1

请求参数

请求体

字段

类型

是否必要

示例值

描述

name

String

"my_app"

应用名称

type

String

"standard"

应用类型

  • standard 标准版
  • enhanced 高级版

quota

Object

应用配额信息

参考:Quota

chargeType

String

"POSTPAY"

付费类型

  • POSTPAY 后付费(按量付费)
  • PREPAY 预付费(包年包月)

order

Object

{"duration": 1,"pricingCycle": "Year"}

订购周期信息

order.duration

Integer

--

1

订购周期

最小值不小于0

order.pricingCycle

String

--

"Year"

订购周期单位

  • Year
  • Month

order.autoRenew

Boolean

true

是否要自动续费。当参数chargeType取值PREPAY时才生效。取值范围:

  • true:自动续费。
  • false(默认):不自动续费。

返回数据

名称 类型 示例值 描述
requestId String 766CF6DB-CA02-3E12-7CBA-6AC21FC978FD

请求ID

result Struct

chargeType String POSTPAY

付费类型

  • POSTPAY 后付费(按量付费)
  • PREPAY 预付费(包年包月)
chargingWay Integer 1

计费类型

  • 1:计算资源
  • 2:qps
commodityCode String opensearch

商品CODE

created Integer 1590139542

创建时间戳

currentVersion String 100302903

当前在线版本

description String -

应用描述

expireOn String -

过期时间

firstRankAlgoDeploymentId Integer 0

粗排部署ID

hasPendingQuotaReviewTask Integer 0

是否配额审批中

  • 0:正常
  • 1:配额审批中
id String 100302881

应用ID

instanceId String -

实例ID

lockMode String Unlock

锁定状态

  • Unlock 正常
  • LockByExpiration 实例过期自动锁定
  • ManualLock 手动触发锁定
lockedByExpiration Integer 0

实例过期自动锁定

name String lsh_test_1

应用名称

pendingSecondRankAlgoDeploymentId Integer 0

部署中的精排部署ID

processingOrderId String -

未结束订单号

produced Integer 1

是否生产完成

  • 0:生产中
  • 1:生产完成
projectId String -

abtest project 名称

quota Struct

应用配额信息

computeResource Integer 20

计算资源 (单位:LCU)

docSize Integer 1

存储容量 (单位:GB)

spec String opensearch.share.common

规格

  • opensearch.share.junior 入门型
  • opensearch.share.common 共享通用型
  • opensearch.share.compute 共享计算型
  • opensearch.share.storage 共享存储型
  • opensearch.private.common 独享通用型
  • opensearch.private.compute 独享计算型
  • opensearch.private.storage 独享存储型
secondRankAlgoDeploymentId Integer 0

精排部署ID

status String normal

应用状态

  • producing 生产中
  • review_pending 生产审批中
  • config_pending 待配置
  • normal 正常
  • frozen 已冻结
switchedTime Integer 1590486386

在线版本切换时间戳

type String enhanced

应用类型

  • standard 标准版
  • advance 老高级版(新应用不支持此类型)
  • enhanced 新高级版
updated Integer 1590978265

更新时间戳

示例

请求示例

POST /v4/openapi/app-groups 

{
    "name": "foo",
    "type": "standard",
    "chargeType": "PREPAY",
    "quota": {
        "docSize": 1,
        "computeResource": 20,
        "spec": "opensearch.share.common"
    },
    "order": {
        "duration": 1,
        "pricingCycle": "Year"
    }
}

正常返回示例

XML格式

<requestId>766CF6DB-CA02-3E12-7CBA-6AC21FC978FD</requestId>

JSON格式

{
    "requestId": "766CF6DB-CA02-3E12-7CBA-6AC21FC978FD",
    "result": []
}

错误码

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