EnableKibanaPvlNetwork - Elasticsearch - Alibaba Cloud Documentation Center

Call the EnableKibanaPvlNetwork operation to enable private network access for Kibana.

1. This API only supports cloud-native instances. For instances of the old architecture, use the TriggerNetwork method.

2. The Kibana specification must be greater than 1 core and 2 GB of memory.

Debug

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request parameters.

Request syntax

POST /openapi/instances/{InstanceId}/actions/enable-kibana-private HTTP/1.1

Request parameters

Parameter	Type	Position	Required	Sample value	Description
InstanceId	String	Path	Yes	es-cn-n6w1oxxx****	The ID of the current instance.
	Object	Body	No		The request body.
endpointName	String	Body	Yes	es-cn-27a3mul6l000xxx-kibana-endpoint	The name of the endpoint.
securityGroups	Array of String	Body	Yes	sg-2sjfaoafee****	The name of the security group.
vSwitchIdsZone	Array	Body	Yes		The information about the vSwitch and the zone.
vswitchId	String	Body	Yes	vsw-bp194pz9iezj6h1n5****	The vSwitch ID.
zoneId	String	Body	Yes	cn-hangzhou-h	The zone ID.
vpcId	String	Body	Yes	vpc-bp19ip2ocyv24w0e2****	The ID of the VPC.

Response parameters

Parameter

Type

Sample value

Description

Result

Boolean

true

Check whether the private network access of Kibana is created.

true
false

RequestId

String

0DC92CFE-62AF-51AF-9D5B-F1078D7C451E

The ID of the request.

Examples

Sample requests

POST /openapi/instances/es-cn-n6w1oxxx****/actions/enable-kibana-private HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "endpointName" : "es-cn-27a3mul6l000xxx-kibana-endpoint",
  "securityGroups" : [ "sg-2sjfaoafee****" ],
  "vSwitchIdsZone" : [ {
    "vswitchId" : "vsw-bp194pz9iezj6h1n5****",
    "zoneId" : "cn-hangzhou-h"
  } ],
  "vpcId" : "vpc-bp19ip2ocyv24w0e2****"
}

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<EnableKibanaPvlNetworkResponse>
    <Result>true</Result>
    <RequestId>0DC92CFE-62AF-51AF-9D5B-F1078D7C451E</RequestId>
</EnableKibanaPvlNetworkResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "0DC92CFE-62AF-51AF-9D5B-F1078D7C451E"
}

Common error codes

For a list of error codes, see Service error codes.