文档

GetSnapshotSetting - 获取自动备份配置

更新时间:

调用GetSnapshotSetting接口,获取ES Serverless应用的自动备份配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:GetSnapshotSetting
  • 全部资源
    *

请求语法

GET /openapi/es-serverless/instances/{appName}/auto-snapshot-setting

请求参数

名称类型必填描述示例值
appNamestring

应用名称。

test

返回参数

名称类型描述示例值
object

请求结果。

requestIdstring

请求 ID。

7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC
resultobject

返回结果。

quartzRegexstring

自动备份执行策略。

0 0 01 ? * * *
enableboolean

是否开启自动备份。

  • true:开启
  • false:不开启
true

示例

正常返回示例

JSON格式

{
  "requestId": "7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC",
  "result": {
    "quartzRegex": "0 0 01 ? * * *",
    "enable": true
  }
}

错误码

访问错误中心查看更多错误码。