DescribeAutoSnapshotPolicy--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeAutoSnapshotPolicy

最近更新时间：2024.11.01 18:49:57首次发布时间：2022.06.02 15:47:48

调用DescribeAutoSnapshotPolicy接口，查询您在某个地域下，所有已创建的符合查询条件的自动快照策略。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAutoSnapshotPolicy	要执行的操作，取值：DescribeAutoSnapshotPolicy。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
AutoSnapshotPolicyIds.N	String	否	AutoSnapshotPolicyIds.1=asp-anj249wubz9kakc8** AutoSnapshotPolicyIds.2=asp-ancejlwubz9kakc8**	需要查询的自动快照策略ID列表。
PageNumber	Integer	否	1	实例信息列表的页码，取值为不超过Integer数据类型的最大值，起始值为1。
PageSize	Integer	否	1	每页记录数。取值为1～100间的整数。默认为15。
ProjectName	String	否	default	根据自动快照策略所属的Project（项目）名筛选快照。
TagFilters.N.Key	String	否	TagFilters.1.Key=tag	根据标签查询资源时指定的标签键。说明如下： TagFilters.N.Key：`N`表示标签键的序号。取值范围：1～10。多个标签键之间用`&`分隔，不允许重复。不传入该参数则表示查询所有标签。传入空字符串时，则返回错误码`InvalidTagFilterKey.Malformed`。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test	根据标签查询资源时指定的标签值。说明如下： TagFilters.N.Values.N：第一个`N`表示标签键的序号。取值范围：1～10。 TagFilters.N.Values.N：第二个`N`表示标签值的序号。取值范围：1～3。多个标签值之间用`&`分隔。如果传入该参数，则必须先传入`TagFilters.N.Key`。不传入该参数则表示查询同一标签键下的所有标签值。传入空字符串时，表示查询标签值为空的标签。

返回数据

名称	类型	示例值	描述
AutoSnapshotPolicies	Array	-	符合条件自动快照策略列表。具体请参见下表“AutoSnapshotPolicy结构”。
TotalCount	Integer	3	符合条件的自动快照策略总数。
PageNumber	Integer	1	实例信息列表的页码。
PageSize	Integer	15	每页记录数。

AutoSnapshotPolicy结构

名称	类型	示例值	描述
AutoSnapshotPolicyName	String	testName	自动快照策略的名称。
AutoSnapshotPolicyId	String	asp-anj249wubz9kakc8****	自动快照策略ID。
Status	String	-	保留参数。
VolumeNums	Integer	3	自动快照策略关联的云盘数量。
TimePoints	String	"2", "8", "9"	自动快照的创建时间点。
RepeatWeekdays	String	"3", "5", "7"	按周重复创建快照，即在周一至周日之间选择一个或多个日期创建快照。
RepeatDays	Integer	2	按天重复创建快照，即间隔一定的天数创建快照。
RetentionDays	Integer	50	自动快照的保留时间，单位为天，取值说明如下： -1：永久保存 1~65536：指定保存天数
CreatedAt	String	2021-06-28T15:10:47+08:00	自动快照策略的创建时间。
UpdatedAt	String	2021-06-28T15:10:47+08:00	自动快照策略的更新时间。
ProjectName	String	default	自动快照策略所属项目。
Tags	Array of Struct	-	自动快照策略的标签信息，具体请参见下表“ Tag结构 ”。

Tag结构

名称	类型	示例值	描述
Key	String	tag	自动快照策略的标签键。
Value	String	test	自动快照策略的标签值。

请求示例

GET /?Action=DescribeAutoSnapshotPolicy&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022050518000501021206303202BF****",
        "Action": "DescribeAutoSnapshotPolicy",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "AutoSnapshotPolicies": [
            {
                "AccountId": "2000006376",
                "AutoSnapshotPolicyId": "asp-anj1nuju6w9gsaqi****",
                "AutoSnapshotPolicyName": "modify_****autosanpshot_policy",
                "CreatedAt": "2022-04-28T18:46:36+08:00",
                "ProjectName": "default",
                "RepeatWeekdays": [
                    "3",
                    "5",
                    "7"
                ],
                "RetentionDays": 50,
                "Status": "",
                "TimePoints": [
                    "2",
                    "8",
                    "9"
                ],
                "Tags": [
				            {
				                "Key": "tag",
				                "Value": "value"
				            }
				        ],
                "UpdatedAt": "2022-04-28T18:46:37+08:00",
                "VolumeNums": 0
            },
            {
                "AccountId": "2000006376",
                "AutoSnapshotPolicyId": "asp-anj2a9gwj49gsbso****",
                "AutoSnapshotPolicyName": "****test",
                "CreatedAt": "2022-04-28T14:49:01+08:00",
                "ProjectName": "default",
                "RepeatWeekdays": [
                    "1"
                ],
                "RetentionDays": -1,
                "Status": "",
                "TimePoints": [
                    "0"
                ],
                "Tags": [
				            {
				                "Key": "tag",
				                "Value": "value"
				            }
				        ],
                "UpdatedAt": "2022-04-28T14:49:01+08:00",
                "VolumeNums": 0
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "RequestId": "2022050518000501021206303202BFE158-cc****",
        "TotalCount": 2
    }
}

错误码

HttpCode	错误码	错误信息
500	InternalError	内部错误，请提工单解决