调用UpdateApp接口，更新Elasticsearch Serverless应用相关信息，包括备注、网络开关、IP白名单组、账号密码等。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
es-serverless:UpdateApp |
update |
*全部资源
|
无 | 无 |
请求语法
PATCH /openapi/es-serverless/instances/{appName} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| appName |
string |
是 |
应用名称。调用 ListApps 获取应用名称。 |
test |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
body 参数。 |
|
| description |
string |
否 |
应用备注。 |
test |
| network |
array<object> |
否 |
公网信息。 |
|
|
array<object> |
否 |
公网信息具体结构。 |
||
| type |
string |
否 |
IP 白名单的类型：
|
PUBLIC_ES |
| enabled |
boolean |
否 |
是否开启公网访问。 |
true |
| domain |
string |
否 |
域名信息。（暂不支持修改） |
test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com |
| port |
integer |
否 |
端口号。（暂不支持修改） |
9200 |
| whiteIpGroup |
array<object> |
否 |
白名单列表。 |
|
|
object |
否 |
白名单具体结构。 |
||
| groupName |
string |
否 |
白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。 |
default |
| ips |
array |
否 |
白名单组中的 IP 地址列表。 |
|
|
string |
否 |
具体 IP 或 IP 段。 |
127.0.0.1 |
|
| authentication |
object |
否 |
认证信息。 |
|
| basicAuth |
array<object> |
否 |
BasicAuth 信息。 |
|
|
object |
否 |
基础信息。 |
||
| username |
string |
否 |
用户名。（目前默认为应用 ID， 暂时不支持修改） |
test-123 |
| password |
string |
否 |
密码。 |
****** |
| privateNetwork |
array<object> |
否 |
私网信息。 |
|
|
array<object> |
否 |
私网信息具体结构。 |
||
| type |
string |
否 |
IP 白名单的类型，可选值：
|
PRIVATE_ES |
| enabled |
boolean |
否 |
是否开启私网访问。 |
true |
| vpcId |
string |
否 |
终端节点 VPC 的 ID。 |
vpc-bp1jy348ibzulk6hn**** |
| pvlEndpointId |
string |
否 |
终端节点 ID。 |
ep-bp1id41dd116e52e**** |
| whiteIpGroup |
array<object> |
否 |
白名单列表。 |
|
|
object |
否 |
白名单具体结构。 |
||
| groupName |
string |
否 |
白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。 |
default |
| ips |
array |
否 |
白名单组中的 IP 地址列表。 |
|
|
string |
否 |
具体 IP 或 IP 段。 |
127.0.0.1 |
|
| limiterInfo |
object |
否 |
系统限制信息。 说明
推荐通过控制台修改，提交修改后会生成规格审批工单。 |
|
| limiters |
array<object> |
否 |
限制列表。 |
|
|
object |
否 |
限制。 |
||
| maxValue |
integer |
否 |
最大阈值。 |
1 |
| minValue |
integer |
否 |
最小阈值。 |
3 |
| type |
string |
否 |
系统限制类型。 |
MAX_CU_PER_SHARD |
| values |
array |
否 |
限制取值列表。 |
|
|
string |
否 |
限制取值。 |
true |
|
| applyReason |
string |
否 |
申请理由。 |
申请系统限制。 |
| contactInfo |
string |
否 |
联系方式，电话或邮箱 |
1370247**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应体结构。 |
||
| requestId |
string |
请求 ID。 |
6B297235-FC5B-590D-8218-8A5ED90AAE99 |
| result |
object |
返回结果。 |
|
| instanceId |
string |
应用对应的实例 ID。 |
es-serverless-cn-8tr6u27483859**** |
示例
正常返回示例
JSON格式
{
"requestId": "6B297235-FC5B-590D-8218-8A5ED90AAE99",
"result": {
"instanceId": "es-serverless-cn-8tr6u27483859****"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。