DescribeSnapshotGroups_云服务器 ECS_API文档

选择云产品
产品与服务收起分类
产品与服务
文档中心工具中心服务广场了解 OpenAPI
AI
中国站
简体中文English
国际站
简体中文English
API变更订阅已开通产品值班交流群满意度问卷
立即登录
2014-05-26不推荐
DescribeSnapshotGroups - 查询快照一致性组
获取元数据
查询一个或多个快照一致性组的信息。例如状态、所属的实例ID、快照创建进度等。
更新时间: 2024-05-22 06:05
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

InstanceId、SnapshotGroupId.N和Status.N不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作访问级别资源类型条件关键字关联操作
ecs:DescribeSnapshotGroups
Get
SnapshotGroup
acs:ecs:{#regionId}:{#accountId}:snapshotgroup/*
SnapshotGroup
acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}
无无

请求参数

字段名称字段详情
RegionIdstring

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceIdstring

指定的实例 ID。

示例值:i-j6ca469urv8ei629****参考取值来源:
    RunInstances
    StopInstances
    CreateInstance
    StartInstances
    RebootInstances
    DescribeInstances
    ModifyManagedInstance
    RenewReservedInstances
    DetachInstanceRamRole
    AttachInstanceRamRole
    DeregisterManagedInstance
    PurchaseReservedInstancesOffering
Namestring

快照一致性组的名称。

示例值:testName
NextTokenstring

查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。

示例值:caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger<int32>

分页查询时每页行数。展开详情

示例值:10取值 <= 500
SnapshotGroupIdarray<string>

指定的快照一致性组 ID。N 的取值范围为 1~10。

示例值:ssg-j6ciyh3k52qp7ovm****子级条数 <= 10
Statusarray<string>

快照一致性组的状态。N 的取值范围为 1~3。取值如下：展开详情

示例值:accomplished子级条数 <= 10
AdditionalAttributesarray<string>

该参数暂未开放使用。

示例值:hide子级条数 <= 5
Tagarray<object>

快照一致性组的标签键值对。

子级条数 <= 16
ResourceGroupIdstring

快照一致性组所属的资源组 ID。

示例值:rg-bp67acfmxazb4p****参考取值来源:
    DescribeSecurityGroups

返回参数

字段名称字段详情
NextTokenstring

下一个查询起始标志。展开详情

示例值:caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

示例值:3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroupsobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Duplicate.TagKey
The Tag.N.Key contain duplicate key.诊断
403
InvalidSnapshotGroupId.MustBeOne
The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.诊断
403
InvalidStatus.ValueNotSupported
The specified parameter status is not valid. The expected status is progressing, accomplished or failed.诊断
404
InvalidRegionId.NotFound
The RegionId provided does not exist in our records.诊断
404
InvalidInstanceId.NotFound
The InstanceId provided does not exist in our records.诊断

变更历史

变更时间变更内容概要操作
2025-02-26
新增错误码400
2025-02-06
变更错误码404
2024-12-17
变更错误码403
2023-09-18
变更返回参数
2021-09-07
新增请求参数Tag
新增请求参数ResourceGroupId
变更返回参数

相关示例

所有示例
一致性快照组
2022-03-24
接口说明
流控信息
授权信息
请求参数
返回参数
返回示例
错误码
变更历史
相关示例
2024年08月20日