全部產品
Search
文件中心

Elasticsearch:DescribePipelineManagementConfig

更新時間:Jan 16, 2025

調用DescribePipelineManagementConfig,擷取Logstash管道管理配置。

調試

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

要求標頭

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

請求文法

GET /openapi/logstashes/[InstanceId]/pipeline-management-config HTTP/1.1

請求參數

名稱 類型 位置 是否必選 樣本值 描述
InstanceId String Path ls-cn-oew1qbgl****

Logstash執行個體ID。

clientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。

返回資料

名稱 類型 樣本值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

請求ID。

Result Struct

返回結果。

endpoints String ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]

Elasticsearch執行個體的訪問地址清單,格式為:網域名稱:連接埠號碼

esInstanceId String es-cn-n6w1o1x0w001c****

Elasticsearch執行個體ID。

pipelineIds List ["testKibanaManagement"]

管道名稱列表。

pipelineManagementType String MULTIPLE_PIPELINE

管道管理方式。支援Kibana和MULTIPLE_PIPELINE。

userName String elastic

訪問執行個體的使用者名稱。

樣本

請求樣本

GET /openapi/logstashes/ls-cn-oew1qbgl****/pipeline-management-config HTTP/1.1
公用要求標頭

正常返回樣本

JSON格式

{
	"Result": {
		"pipelineManagementType": "MULTIPLE_PIPELINE",
		"esInstanceId": "es-cn-n6w1o1x0w001c****",
		"endpoints": [
			"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
		],
		"pipelineIds": [
			"testKibanaManagement"
		],
		"userName": "elastic"
	},
	"RequestId": "6822F07C-A896-4A2C-A430-BC01D5D1****"
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 InstanceNotFound The instanceId provided does not exist. 執行個體找不到,請核對執行個體狀態。

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