开启或关闭指定Elasticsearch实例的公网地址。
接口说明
调用该接口时,请注意:
当实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:UpdatePublicNetwork |
update |
*Instance
|
|
无 |
请求语法
PATCH /openapi/instances/{InstanceId}/public-network HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
es-cn-nif1q9o8r0008**** |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| clientToken |
string |
否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
| body |
string |
否 |
实例公网访问开关配置。 |
{"enablePublic":true} |
RequestBody
您还可以在 RequestBody 中填入 enablePublic 参数(可选,默认为 false)。Boolean 类型,为 true 时表示开启公网地址访问,为 false 时表示关闭公网地址访问,示例如下。
{
"enablePublic": true
}
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
2A88ECA1-D827-4581-AD39-05149586**** |
| Result |
object |
返回结果。 |
|
| enablePublic |
boolean |
公网地址开关状态。 |
false |
下文返回示例中,本文只保证包含返回数据列表中的参数,而未提到的参数仅供参考,参数说明请参见 ListInstance 。程序中不能强制依赖获取这些参数。
示例
正常返回示例
JSON格式
{
"RequestId": "2A88ECA1-D827-4581-AD39-05149586****",
"Result": {
"enablePublic": false
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。