Call the DescribeLogstash to query the details of a specified instance.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request header

This operation uses only common request headers. For more information, see Common parameters.

Request syntax

GET /openapi/logstashes/[InstanceId] HTTPS|HTTP  

Request parameters

Parameter Type Position Required Example Description
InstanceId String Path Yes ls-cn-s9dsk3k4k****

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String C9334241-4837-46C2-B24B-9BDC517318DE

The ID of the request.

Result Struct

Detailed information about the instance.

ExtendConfigs List [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]

The configuration of the cluster extension parameter.

ResourceGroupId String rg-aekzvowej3i****

The ID of the resource group to which the instance belongs.

Tags Array of tags

Details about the tags.

tagKey String env

The tag key.

tagValue String dev

The tag value.

ZoneInfos Array of zoneInfos

Zone information.

status String NORMAL

The status of the zone. Supported:

  • ISOLATION: offline
  • NORMAL: normal
zoneId String cn-hangzhou-b

The zone ID.

config Map {"slowlog.threshold.warn": "2s","": "1s","slowlog.threshold.debug": "500ms","slowlog.threshold.trace": "100ms" }

The configurations of the instance.

createdAt String 2020-02-06T14:12:03.672Z

The time when the instance was created.

description String ls-cn-abc

The description of the instance.

endpointList Array of endpoint

The access information of the node.

host String 172.16. **. **

The IP address of the node.

port String 9600

The port number that is used to connect to the database.

zoneId String cn-hangzhou-b

The ID of the zone where the node resides.

instanceId String ls-cn-abc

The ID of the instance.

networkConfig Struct

The network configuration.

type String vpc

The type of the network. Currently, only Virtual Private Cloud (VPC) is supported.

vpcId String vpc-bp16k1dvzxtmagcva****

The ID of the VPC.

vsArea String cn-hangzhou-*

The zone where the instance is deployed.

vswitchId String vsw-bp1k4ec6s7sjdbudw****

The ID of the vSwitch.

nodeAmount Integer 2

The number of data nodes.

nodeSpec Struct

The configuration of the node.

disk Integer 20

The disk size of the node.

diskEncryption Boolean true

Indicates whether to use cloud disk encryption. Valid values:

  • true: use
  • false: disuse
diskType String cloud_ssd

The disk type of the node.

spec String elasticsearch.sn1ne.large

The specification of the node.

paymentType String prepaid

The payment mode of the instance. Supported: prepaid (subscription) and postpaid (pay-as-you-go).

status String active

The state of the instance. Four states are supported: Normal (active), effective (activating), Frozen (inactive), and ineffective (invalid).

updatedAt String 2020-02-06T14:22:36.850Z

The time when the instance was last updated.

version String 7.4.0_with_X-Pack

The version of the instance.

vpcInstanceId String vpc-bp16k1dvzxtmagcva****

The ID of the VPC to which the instance belongs.

For more information about the parameters, see ListLogstash .


Sample requests

GET /openapi/logstashes/ls-cn-s9dsk3k4k**** HTTP/1.1 
common request header 

Sample success responses

JSON Syntax

    "Result": {
        "instanceId": "ls-cn-m7r1o6cl****",
        "version": "6.7.0_with_X-Pack",
        "description": "ls-cn-abc",
        "nodeAmount": 2,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 20,
            "diskType": "cloud_ssd"
        "networkConfig": {
            "vpcId": "vpc-bp16k1dvzxtmagcva****",
            "vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
            "vsArea": "cn-hangzhou-i",
            "type": "vpc"
        "createdAt": "2020-05-27T11:53:43.104Z",
        "updatedAt": "2020-05-27T11:53:43.104Z",
        "commodityCode": "elasticsearch_logstash_post",
        "extendConfigs": [],
        "endTime": 4746268800000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfm2h5vbzd****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
                "zoneId": "cn-hangzhou-i",
                "status": "NORMAL"
        "instanceType": "logstash",
        "inited": true,
        "tags": [],
        "config": {
            "slowlog.threshold.warn": "2s",
            "": "1s",
            "slowlog.threshold.debug": "500ms",
            "slowlog.threshold.trace": "100ms"
        "endpointList": [
                "host": "172.16.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-i"
                "host": "172.16.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-i"
    "RequestId": "C9334241-4837-46C2-B24B-9BDC517318DE"

Error codes

For a list of error codes, visit the API Error Center.