创建一个OpenSearch应用
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /v4/openapi/app-groups HTTP/1.1
请求参数
字段 |
类型 |
是否必要 |
示例值 |
描述 |
---|---|---|---|---|
name |
String |
是 |
"my_app" |
应用名称 |
type |
String |
是 |
"standard" |
应用类型
|
quota |
Object |
是 |
应用配额信息 参考:Quota |
|
chargeType |
String |
否 |
"POSTPAY" |
付费类型
|
order |
Object |
否 |
{"duration": 1,"pricingCycle": "Year"} |
订购周期信息 |
order.duration |
Integer |
-- |
1 |
订购周期 最小值不小于0 |
order.pricingCycle |
String |
-- |
"Year" |
订购周期单位
|
order.autoRenew |
Boolean |
否 |
true |
是否要自动续费。当参数chargeType取值PREPAY时才生效。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
requestId | String | 766CF6DB-CA02-3E12-7CBA-6AC21FC978FD |
请求ID |
result | Struct |
空 |
|
chargeType | String | POSTPAY |
付费类型
|
chargingWay | Integer | 1 |
计费类型
|
commodityCode | String | opensearch |
商品CODE |
created | Integer | 1590139542 |
创建时间戳 |
currentVersion | String | 100302903 |
当前在线版本 |
description | String | - |
应用描述 |
expireOn | String | - |
过期时间 |
firstRankAlgoDeploymentId | Integer | 0 |
粗排部署ID |
hasPendingQuotaReviewTask | Integer | 0 |
是否配额审批中
|
id | String | 100302881 |
应用ID |
instanceId | String | - |
实例ID |
lockMode | String | Unlock |
锁定状态
|
lockedByExpiration | Integer | 0 |
实例过期自动锁定 |
name | String | lsh_test_1 |
应用名称 |
pendingSecondRankAlgoDeploymentId | Integer | 0 |
部署中的精排部署ID |
processingOrderId | String | - |
未结束订单号 |
produced | Integer | 1 |
是否生产完成
|
projectId | String | - |
abtest project 名称 |
quota | Struct |
应用配额信息 |
|
computeResource | Integer | 20 |
计算资源 (单位:LCU) |
docSize | Integer | 1 |
存储容量 (单位:GB) |
spec | String | opensearch.share.common |
规格
|
secondRankAlgoDeploymentId | Integer | 0 |
精排部署ID |
status | String | normal |
应用状态
|
switchedTime | Integer | 1590486386 |
在线版本切换时间戳 |
type | String | 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": []
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交