修改 OpenSearch 应用属性或设置应用在线版本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
opensearch:ModifyAppGroup |
update |
*AppGroup
|
无 | 无 |
请求语法
PUT /v4/openapi/app-groups/{appGroupIdentity} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| appGroupIdentity |
string |
是 |
应用名称。 |
my_app_group_name |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求参数。 |
|
| description |
string |
否 |
描述 |
"实例描述" |
| currentVersion |
string |
否 |
在线版本。 |
1223232 |
| domain |
string |
否 |
行业类型:
|
"ecommerce" |
| resourceGroupId |
string |
否 |
实例所属的资源组 ID。 |
rg-**** |
| dryRun |
boolean |
否 |
是否进行升级前校验。true 表示校验,false 表示不校验。 |
true |
请求体
| 字段 | 类型 | 是否必要 | 示例值 | 描述 |
| chargingWay | Integer | 否 | 1 | 计费模型 - 1 计算资源 - 2 qps |
| description | String | 否 | "my_first_app" | 应用描述 |
| currentVersion | Integer | 否 | 12345678 | 应用版本 ID |
注:优先执行“设置应用在线版本”,即若所有字段都存在,则默认 currentVersion 有效。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应体 |
{} |
|
| requestId |
string |
请求 ID |
D77D0DAF-790D-F5F5-A9C0-133738165014 |
| result |
object |
返回数据 |
{} |
| beaconAppCreated |
integer |
是否开启烽火台业务:0 表示未开启,1 表示已开启。 |
0 |
| chargeType |
string |
付费类型
|
POSTPAY |
| chargingWay |
integer |
计费类型
|
1 |
| commodityCode |
string |
商品 CODE |
opensearch |
| created |
integer |
创建时间戳 |
159013954 |
| currentVersion |
string |
当前在线版本 |
100302903 |
| description |
string |
应用描述 |
1 |
| domain |
string |
行业类型
|
GENERAL |
| domainName |
string |
应用的域名名称。 |
foo-xxxx |
| engineType |
string |
引擎类型 |
ha3 |
| hasPendingQuotaReviewTask |
integer |
是否配额审批中
|
0 |
| id |
string |
应用 ID |
100302881 |
| inDebt |
boolean |
是否欠费。 |
|
| instanceId |
string |
实例 ID |
10030288 |
| lockMode |
string |
锁定状态
|
Unlock |
| name |
string |
应用名称 |
lsh_test_1 |
| produced |
integer |
是否生产完成
|
1 |
| quota |
object |
应用配额信息 |
{} |
| computeResource |
integer |
计算资源(单位:LCU) |
20 |
| docSize |
integer |
存储容量(单位:GB) |
1 |
| spec |
string |
规格
|
opensearch.share.common |
| resourceGroupId |
string |
实例所属的资源组 ID。 |
rg-acfmoiyerh6nzly |
| status |
string |
应用状态
|
normal |
| switchedTime |
integer |
在线版本切换时间戳 |
1590486386 |
| type |
string |
应用类型
|
enhanced |
| updated |
integer |
更新时间戳 |
1590978265 |
| zoneId |
string |
内网可用区
|
nantong |
| components |
array<object> |
应用实例的售卖组件参数。 |
|
|
object |
|||
| code |
string |
售卖组件编码。 |
appname |
| value |
string |
售卖组件取值。 |
zaojiu_test_speaker |
| tags |
array<object> |
应用标签 |
|
|
object |
标签。 |
||
| key |
string |
标签键 |
foo |
| value |
string |
标签值 |
bar |
| versions |
array |
版本集合 |
|
|
string |
应用版本 ID。 |
100302903 |
示例
正常返回示例
JSON格式
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": {
"beaconAppCreated": 0,
"chargeType": "POSTPAY",
"chargingWay": 1,
"commodityCode": "opensearch",
"created": 159013954,
"currentVersion": "100302903",
"description": "1",
"domain": "GENERAL",
"domainName": "foo-xxxx",
"engineType": "ha3",
"hasPendingQuotaReviewTask": 0,
"id": "100302881",
"inDebt": true,
"instanceId": "10030288",
"lockMode": "Unlock",
"name": "lsh_test_1",
"produced": 1,
"quota": {
"computeResource": 20,
"docSize": 1,
"spec": "opensearch.share.common"
},
"resourceGroupId": "rg-acfmoiyerh6nzly",
"status": "normal",
"switchedTime": 1590486386,
"type": "enhanced",
"updated": 1590978265,
"zoneId": "nantong",
"components": [
{
"code": "appname",
"value": "zaojiu_test_speaker"
}
],
"tags": [
{
"key": "foo",
"value": "bar"
}
],
"versions": [
"100302903"
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。