修改应用私网信息。
接口说明
系统将自动创建服务关联角色，允许访问 OSS 等其他云产品服务。 OSS 地址要求：目录名称需包含 es-serverless，或为 OSS Bucket 添加 es-serverless:es-serverless 标签。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| es-serverless:UpdatePrivateNetwork | update | *全部资源 * |
| 无 |
请求语法
PUT /openapi/es-serverless/instances/{appName}/private-networks HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appName | string | 是 | 应用名称。 | test |
| body | array<object> | 否 | body 参数 | |
| object | 否 | body 参数。 | ||
| type | string | 否 | IP 白名单的类型： PRIVATE_ES：Elasticsearch 私网访问白名单 PRIVATE_KIBANA：Kibana 私网访问白名单 | PRIVATE_ES |
| enabled | boolean | 否 | 是否开启私网访问。 | true |
| domain | string | 否 | 域名信息。（暂不支持修改） | autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com |
| port | integer | 否 | 端口号。（暂不支持修改） | 9200 |
| whiteIpGroup | array<object> | 否 | 白名单具体结构。 | |
| object | 否 | 白名单具体结构。 | ||
| groupName | string | 否 | 白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。 | default |
| ips | array | 否 | 具体 IP 或 IP 段。 | |
| string | 否 | 具体 IP 或 IP 段。 | 127.0.0.1 | |
| modifyMode | string | 否 | 修改方式，可选值：
| Cover |
| vpcId | string | 否 | 专有网络实例 ID | vpc-uf664nyle5khp5*** |
| pvlEndpointId | string | 否 | 终端节点 ID。 | ep-bp1id6dc2568**** |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
"result": [
{
"type": "PRIVATE_ES",
"enabled": true,
"domain": "test-**.private.cn-hangzhou.es-serverless.aliyuncs.com",
"port": 9200,
"whiteIpGroup": [
{
"groupName": "default",
"ips": [
"127.0.0.1"
]
}
],
"vpcId": "vpc-uf6gykvwcirp886ef****",
"pvlEndpointId": "ep-bp1id6dc2568****"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-08 | 新增 OpenAPI | 查看变更详情 |