You can call this operation to enable or disable public or private network access for a Elasticsearch or Kibana cluster.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
POST /openapi/instances/{InstanceId}/actions/network-trigger HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
InstanceId | String | Path | Yes | es-cn-n6w1o1x0w001c**** |
The ID of the instance. |
clientToken | String | Query | No | 407d02b74c49beb5bfdac7ec8bde2488 |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. |
Object | Body | No |
The request body parameters. |
||
nodeType | String | Body | Yes | KIBANA |
The edition of the instance. Default value: no. Valid values:
|
networkType | String | Body | Yes | PUBLIC |
The type of the network. Default value: no. Valid values:
|
actionType | String | Body | Yes | OPEN |
The action type. Default value: no. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Result | Boolean | true |
Result
|
RequestId | String | 5A5D8E74-565C-43DC-B031-29289FA**** |
The ID of the request. |
Examples
Sample requests
POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/network-trigger?clientToken=407d02b74c49beb5bfdac7ec8bde2488 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
"nodeType" : "KIBANA",
"networkType" : "PUBLIC",
"actionType" : "OPEN"
}
Sample success responses
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : true,
"RequestId" : "5A5D8E74-565C-43DC-B031-29289F****"
}
Error codes
For a list of error codes, see Service error codes.