ListKibanaPvlNetwork - Elasticsearch - Alibaba Cloud Documentation Center

Call the ListKibanaPvlNetwork operation to query the details about private network access to Kibana.

This API supports only cloud-native instances.

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

GET /openapi/instances/{InstanceId}/actions/get-kibana-private HTTP/1.1

Request parameters

Parameter	Type	Position	Required	Sample value	Description
InstanceId	String	Path	Yes	es-cn-vo93ngti8000a****	The ID of instance N.

Response parameters

Parameter	Type	Sample value	Description
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	The request ID.
Result	Array of Result		An array of result objects is returned.
endpointName	String	es-cn-xxdjfia****-kibana	The name of the endpoint.
vpcId	String	vpc-bp16k1dvzxtma*****	The ID of the virtual private cloud (VPC).
vSwitchIdsZone	Array of vSwitchIdsZone		The information about the vSwitch and zone.
zoneId	String	cn-hangzhou-e	The ID of the zone to query.
vswitchId	String	vsw-xdefafns***	The vSwitch ID.
securityGroups	Array of String	sg-2zegcwar0pq4a****	Details about security groups.
endpointId	String	ep-bp1tah7zbrwmkjef****	The endpoint ID.
endpointStatus	String	Connected	The status of the endpoint. Valid values: Disconnected Connected
createTime	String	2024-03-07T06:26:28Z	The time when the private connection to Kibana was created.
pvlId	String	es-cn-27a3mul6l***-kibana-internal	The ID of the private connection to Kibana.

Examples

Sample requests

GET /openapi/instances/es-cn-vo93ngti8000a****/actions/get-kibana-private HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

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

<ListKibanaPvlNetworkResponse>
    <Result>
        <pvlId>es-cn-vo93ngti8000a****-kibana-internal-internal</pvlId>
        <endpointId>ep-bp1ie6c7aea23549****</endpointId>
        <endpointName>es-cn-vo93ngti8000a****-kibana</endpointName>
        <description> is used to access the Kibana instance whose instance ID is es-cn-vo93ngti8000a**** through a private endpoint in the Virtual Private Cloud. You can go to the Kibana configuration page in the Elasticsearch console. </description>
        <vpcId>vpc-bp19ip2ocyv24w0e2****</vpcId>
        <vSwitchIdsZone>
            <vswitchId>vsw-bp194pz9iezj6h1n5****</vswitchId>
            <zoneId>cn-hangzhou-i</zoneId>
        </vSwitchIdsZone>
        <securityGroups>sg-bp1c6fo9l29ergq****z</securityGroups>
        <endpointStatus>Connected</endpointStatus>
        <createTime>2024-03-14T08:16:48Z</createTime>
    </Result>
    <RequestId>951E58B6-26B8-5583-AAD6-7797D51723DB</RequestId>
</ListKibanaPvlNetworkResponse>

JSON format

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

{
  "Result" : [ {
    "pvlId" : "es-cn-vo93ngti8000a****-kibana-internal-internal",
    "endpointId" : "ep-bp1ie6c7aea23549****",
    "endpointName" : "es-cn-vo93ngti8000a****-kibana",
    "description" : "used to access the Kibana instance whose instance ID is es-cn-vo93ngti8000a**** by using the private endpoint in the Virtual Private Cloud. You can go to the Kibana configuration in the Elasticsearch console to manage it",
    "vpcId" : "vpc-bp19ip2ocyv24w0e2****",
    "vSwitchIdsZone" : [ {
      "vswitchId" : "vsw-bp194pz9iezj6h1n5****",
      "zoneId" : "cn-hangzhou-i"
    } ],
    "securityGroups" : [ "sg-bp1c6fo9l29ergq****z" ],
    "endpointStatus" : "Connected",
    "createTime" : "2024-03-14T08:16:48Z"
  } ],
  "RequestId" : "951E58B6-26B8-5583-AAD6-7797D51723DB"
}

Common error codes

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