UpdatePublicNetwork - 开启或关闭实例公网地址

更新时间:
复制 MD 格式

开启或关闭指定Elasticsearch实例的公网地址。

接口说明

调用该接口时,请注意:
当实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdatePublicNetwork

update

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

  • elasticsearch:InstancePublicNetworkSwitch
无

请求语法

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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。