All Products
Search
Document Center

Elasticsearch:UpdateKibanaPvlNetwork

Last Updated:Mar 15, 2024

Call UpdateKibanaPvlNetwork to update the private network access information of 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/update-kibana-private HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Sample value

Description

InstanceId String Path Yes es-cn-vo93ngti8000a****

The instance ID.

pvlId String Query Yes es-cn-vo93ngti8000a****-kibana-internal-internal

The ID of the private connection to Kibana.

Object Body No

The request body.

endpointName String Body No es-cn-text-kibana

The name of the endpoint.

securityGroups Array of String Body No sg-xdjiow****

Details about security groups.

Response parameters

Parameter

Type

Sample value

Description

Result Boolean true

The following result is returned:

  • true
  • false
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.

Examples

Sample requests

POST /openapi/instances/es-cn-vo93ngti8000a****/actions/update-kibana-private?pvlId=es-cn-vo93ngti8000a****-kibana-internal-internal HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "endpointName" : "es-cn-text-kibana",
  "securityGroups" : [ "sg-xdjiow****" ]
}

Sample success responses

XML format

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

<UpdateKibanaPvlNetworkResponse>
    <Result>true</Result>
    <RequestId>F99407AB-2FA9-489E-A259-40CF6DCC****</RequestId>
</UpdateKibanaPvlNetworkResponse>

JSON format

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

{
  "Result" : true,
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC****"
}

Common error codes

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