Enables or disables Internet or intranet access to Elasticsearch and Kibana.
Debugging
Request header
This operation uses common request parameters only. For more information, see Common parameters.
Request syntax
POST /openapi/instances/[InstanceId]/actions/network-trigger HTTPS|HTTP
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
InstanceId | String | Yes | es-cn-n6w1o1x0w001c**** |
The ID of the instance. |
clientToken | String | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. |
RequestBody
The following parameters must also be filled in in RequestBody:
HTTP status code |
Type |
Required |
Example |
Description |
---|---|---|---|---|
nodeType |
String |
Yes |
KIBANA |
The instance type of the node. Valid values: KIBANA (for Kibana clusters) and WORKER (for Elasticsearch clusters). |
networkType |
String |
Yes |
PUBLIC |
The network type of the instance. Valid values: PUBLIC and PRIVATE. |
actionType |
String |
Yes |
OPEN |
The type of the action. Valid values: CLOSE and OPEN. |
Example:
{
"nodeType":"WORKER",
"networkType":"PUBLIC",
"actionType":"OPEN"
}
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC**** |
The ID of the request. |
Result | Boolean | true |
The returned results. |
Examples
Sample requests
POST /openapi/instances/[InstanceId]/actions/network-trigger HTTP/1.1
Common request parameters
{
"InstanceId": "es-cn-n6w1o1x0w001c****"
}
Sample success responses
JSON
format
{
"Result": true,
"RequestId": "5A5D8E74-565C-43DC-B031-29289F*****"
}
Error codes
For a list of error codes, visit the API Error Center.