DescribeLogstash - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

GET /openapi/logstashes/{InstanceId} HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-s9dsk3k4k****	執行個體ID。

返回資料

名稱	類型	樣本值	描述
RequestId	String	C9334241-4837-46C2-B24B-9BDC517318DE	請求ID。
Result	Object		當前執行個體的詳細資料。
config	Map		執行個體配置資訊。
paymentType	String	prepaid	執行個體的付費模式。支援： prepaid：訂用帳戶 postpaid：隨用隨付
ResourceGroupId	String	rg-aekzvowej3i****	執行個體所屬的資源群組ID。
nodeAmount	Integer	2	執行個體的節點個數。
description	String	ls-cn-abc	執行個體名稱。
createdAt	String	2020-02-06T14:12:03.672Z	執行個體建立時間。
status	String	active	執行個體的狀態。支援四種狀態：正常：active 生效中：activating 凍結：inactive 失效：invalid
vpcInstanceId	String	vpc-bp16k1dvzxtmagcva****	執行個體所屬的VPC ID。
updatedAt	String	2020-02-06T14:22:36.850Z	執行個體最後更新的時間。
version	String	7.4.0_with_X-Pack	執行個體版本。
instanceId	String	ls-cn-abc	執行個體ID。
endpointList	Array of endpoint		節點的訪問資訊。
zoneId	String	cn-hangzhou-b	節點所在的可用性區域ID。
port	String	9600	連接埠號碼。
host	String	172.16..	節點的IP地址。
Tags	Array of tags		執行個體標籤。
tagKey	String	env	標籤鍵。
tagValue	String	dev	標籤值。
ZoneInfos	Array of zoneInfos		可用性區域資訊。
status	String	NORMAL	可用性區域狀態。支援： ISOLATION：下線 NORMAL：正常
zoneId	String	cn-hangzhou-b	可用性區域ID。
ExtendConfigs	Array of Object	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]	叢集擴充參數配置。
nodeSpec	Object		節點的配置資訊。
spec	String	elasticsearch.sn1ne.large	節點的規格。
disk	Integer	20	節點的磁碟大小。
diskEncryption	Boolean	true	是否使用雲端硬碟加密： true：使用 false：不使用
diskType	String	cloud_ssd	節點的磁碟類型。
networkConfig	Object		網路設定。
vpcId	String	vpc-bp16k1dvzxtmagcva****	專用網路ID。
vsArea	String	cn-hangzhou-*	執行個體所在的可用性區域。
type	String	vpc	網路類型。目前只支援Virtual Private Cloud（Virtual Private Cloud）。
vswitchId	String	vsw-bp1k4ec6s7sjdbudw****	虛擬交換器ID。

更多參數說明請參見ListLogstash。

樣本

請求樣本

GET /openapi/logstashes/ls-cn-s9dsk3k4k**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回樣本

JSON格式

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

{
  "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",
      "slowlog.threshold.info" : "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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。