ListLogstash - Elasticsearch

調試

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

要求標頭

/openapi/logstashes

請求文法

GET /openapi/logstashes HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
page	Integer	Query	否	1	執行個體列表的頁碼。預設值：1。
size	Integer	Query	否	10	分頁查詢時設定的每頁條數。預設值：20。
description	String	Query	否	ls-cn-abc	執行個體名稱，支援模糊查詢。例如查詢名稱為abc的執行個體，則可能返回名稱為abc、abcde、xyabc、xabcy的所有執行個體。
instanceId	String	Query	否	ls-cn-n6w1o5jq****	執行個體ID。
version	String	Query	否	5.5.3_with_X-Pack	執行個體版本。
resourceGroupId	String	Query	否	rg-acfm2h5vbzd****	資源群組ID。
tags	String	Query	否	[{"tagKey":"key1","tagValue":"value1"}]	執行個體標籤。

返回資料

名稱	類型	樣本值	描述
RequestId	String	AC442F2F-5068-4434-AA21-E78947A9****	請求ID。
Headers	Object		要求標頭資訊。
X-Total-Count	Integer	10	執行個體總記錄數。
Result	Array of Instance		當前請求返回的執行個體列表。
paymentType	String	postpaid	執行個體的付費模式。支援：prepaid（訂用帳戶）、postpaid（隨用隨付）。
nodeAmount	Integer	2	執行個體的節點個數。
description	String	ls-cn-abc	執行個體名稱。
createdAt	String	2018-07-13T03:58:07.253Z	執行個體建立時間。
status	String	active	執行個體的狀態。支援四種狀態：正常（active）、生效中（activating）、凍結（inactive）和失效（invalid）。
updatedAt	String	2018-07-18T10:10:04.484Z	執行個體最後更新的時間。
instanceId	String	ls-cn-n6w1o5jq****	執行個體ID。
version	String	6.7.0_with_X-Pack	執行個體版本。目前僅支援6.7.0_with_X-Pack、7.4.0_with_X-Pack。
Tags	Array of tags		執行個體標籤。
TagValue	String	dev	標籤值。
TagKey	String	env	標籤鍵。
nodeSpec	Object		資料節點的配置資訊。
spec	String	logstash.n4.small	執行個體規格。
disk	Integer	50	節點磁碟大小。
diskEncryption	Boolean	false	是否使用磁碟加密： true：使用 false：不使用
diskType	String	cloud_ssd	磁碟類型。
networkConfig	Object		網路設定。
vpcId	String	vpc-abc	專用網路ID。
vsArea	String	cn-hangzhou-*	執行個體所在的可用性區域。
type	String	vpc	網路類型，目前僅支援Virtual Private Cloud（Virtual Private Cloud）。
vswitchId	String	vsw-def	交換器ID。

返回資料中還包含以下參數。

名稱	類型	樣本值	描述
enablePublic	Boolean	false	是否開啟公網訪問，預設為false。
commodityCode	String	elasticsearch_logstash_post	產品代碼。
endTime	Long	4749897600000	訂用帳戶執行個體，最後的失效時間。
clusterTasks	Array	[]	執行個體的工作清單。
resourceGroupId	String	rg-acfm2h5vbzd****	執行個體所在的資源群組ID。
zoneCount	Integer	1	執行個體的可用性區域個數。
protocol	String	HTTP	執行個體的訪問協議。
zoneInfos	Array		可用性區域資訊。
└zoneId	String	cn-hangzhou-i	可用性區域ID。
└status	String	NORMAL	可用性區域狀態。支援：ISOLATION（下線）、NORMAL（正常）。
instanceType	String	logstash	執行個體類型。
inited	Boolean	true	執行個體是否已完成初始化。
config	Array	[]	執行個體配置。
endpointList	Array		節點資訊。
└host	String	172.16.xx.xx	節點的IP地址。
└port	Integer	9200	節點的訪問連接埠號碼。
└zoneId	String	cn-hangzhou-i	節點所在的可用性區域ID。

說明 └表示子參數。

樣本

請求樣本

GET /openapi/logstashes?page=1&size=10&description=ls-cn-abc&instanceId=ls-cn-n6w1o5jq****&version=5.5.3_with_X-Pack&resourceGroupId=rg-acfm2h5vbzd****&tags=[{"tagKey":"key1","tagValue":"value1"}] 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-n6w1o5jq****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "test",
    "nodeAmount" : 1,
    "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-27T01:30:15.947Z",
    "updatedAt" : "2020-05-27T01:40:51.333Z",
    "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" : { },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  } ],
  "RequestId" : "918C05D8-4689-4A79-B6D5-D2500991****",
  "Headers" : {
    "X-Total-Count" : 1
  }
}

錯誤碼

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