全部產品
Search
文件中心

Elasticsearch:DescribeSnapshotSetting

更新時間:Jan 15, 2025

調用DescribeSnapshotSetting,擷取叢集的資料備份配置。

調試

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

要求標頭

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

請求文法

GET /openapi/instances/[InstanceId]/snapshot-setting HTTP/1.1

請求參數

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

執行個體ID。

返回資料

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

請求ID。

Result Struct

返回結果。

Enable Boolean true

是否開啟自動備份。

QuartzRegex String 0 0 01 ? * * *

自動備份時間配置,採用Quartz Cron運算式。

樣本

請求樣本

GET /openapi/instances/es-cn-0pp1jxvcl000z****/snapshot-setting HTTP/1.1
公用要求標頭

正常返回樣本

JSON格式

{
	"RequestId": "B2A05BB2-7B66-4D0F-BEDE-5033AFFE****",
	"Result": {
		"Enable": true,
		"QuartzRegex": "0 0 01 ? * * *"
	}
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
404 InstanceNotFound The specified cluster does not exist. Check the cluster status and try again. 執行個體找不到,請核對執行個體狀態。

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