文档

ListSnapshots - 获取快照列表

更新时间:

调用ListSnapshots接口,获取ES Serverless应用的快照列表。

调试

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

授权信息

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

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

请求语法

GET /openapi/es-serverless/instances/{appName}/snapshots

请求参数

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

应用名称。

test
repositorystring

快照仓库名称。

aliyun_auto_snapshot
pageNumberinteger

页码,默认值:1。

1
pageSizeinteger

每页记录数,默认值:10。

10
snapshotstring

快照备份名称。

qingning

返回参数

名称类型描述示例值
object

请求结果。

requestIdstring

请求 ID。

22E9EE78-F567-550A-8F7C-20E9CD3DE489
resultarray<object>

返回结果。

object

单项返回结果。

{ "snapshot": "qingning", "uuid": "_ULkbfoHREaJ0Gdcza****", "version_id": 7100099, "version": "7.10.0", "indices": [ "product_info" ], "data_streams": [], "include_global_state": false, "state": "SUCCESS", "start_time": "2024-05-30T07:51:58.973Z", "start_time_in_millis": 1717055518973, "end_time": "2024-05-30T07:51:59.373Z", "end_time_in_millis": 1717055519373, "duration_in_millis": 400, "failures": [], "shards": { "total": 6, "failed": 0, "successful": 6 }, "repository": "aliyun_auto_snapshot" }
nextTokenstring

分页 token。(暂时没有启用)

ODgyObrnP3
totalCountinteger

总条数。

1

示例

正常返回示例

JSON格式

{
  "requestId": "22E9EE78-F567-550A-8F7C-20E9CD3DE489",
  "result": [
    {
      "snapshot": "qingning",
      "uuid": "_ULkbfoHREaJ0Gdcza****",
      "version_id": 7100099,
      "version": "7.10.0",
      "indices": [
        "product_info"
      ],
      "data_streams": [],
      "include_global_state": false,
      "state": "SUCCESS",
      "start_time": "2024-05-30T07:51:58.973Z",
      "start_time_in_millis": 1717055518973,
      "end_time": "2024-05-30T07:51:59.373Z",
      "end_time_in_millis": 1717055519373,
      "duration_in_millis": 400,
      "failures": [],
      "shards": {
        "total": 6,
        "failed": 0,
        "successful": 6
      },
      "repository": "aliyun_auto_snapshot"
    }
  ],
  "nextToken": "ODgyObrnP3",
  "totalCount": 1
}

错误码

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