UpdateNetwork - 更新应用公网配置

更新时间:
复制为 MD 格式

修改应用公网配置。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:UpdateNetworkupdate
*全部资源
*

请求语法

PUT /openapi/es-serverless/instances/{appName}/networks HTTP/1.1

请求参数

名称类型必填描述示例值
appNamestring

实例 ID。

autotest-8k8a8
bodyarray<object>

body 参数。

object

请求体结构。

typestring

IP 白名单的类型:

PUBLIC_ES:Elasticsearch 公网访问白名单 PUBLIC_KIBANA:Kibana 公网访问白名单

PUBLIC_ES
enabledboolean

是否开启公网访问。

true
domainstring

域名信息。(暂不支持修改)

autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com
portinteger

端口号。(暂不支持修改)

9200
whiteIpGrouparray<object>

白名单列表。

object

白名单具体结构。

groupNamestring

白名单组的组名。如果选填了 whiteIpGroup 参数,则该参数必填。

default
ipsarray

白名单组中的 IP 地址列表。

string

具体 IP 或 IP 段。

127.0.0.1
modifyModestring

修改方式,可选值:

  • Cover(默认):使用 ips 参数的值覆盖原白名单的 IP 地址。

  • Append:在原白名单的 IP 地址中增加 ips 参数中输入的 IP 地址。

  • Delete:在原白名单的 IP 地址中删除 ips 参数中输入的 IP 地址,至少需要保留一个 IP 地址。

Cover

返回参数

名称类型描述示例值
object

响应体结构。

requestIdstring

请求 ID。

2C5DAA30-****-5181-9B87-9D6181016197
resultarray<object>

返回结果。

resultobject

返回结构。

typestring

IP 白名单的类型。

PUBLIC_ES
enabledstring

是否开启私网访问。

true
domainstring

域名。

test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com
portstring

端口号。

9200
whiteIpGrouparray<object>

白名单信息。

whiteIpGroupobject

白名单具体结构。

groupNamestring

白名单组的组名。

default
ipsarray

白名单组中的 IP 地址列表。

ipsstring

具体 IP 或 IP 段。

127.0.0.1

示例

正常返回示例

JSON格式

{
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "result": [
    {
      "type": "PUBLIC_ES",
      "enabled": true,
      "domain": "test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com\n",
      "port": 9200,
      "whiteIpGroup": [
        {
          "groupName": "default",
          "ips": [
            "127.0.0.1"
          ]
        }
      ]
    }
  ]
}

错误码

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