DescribeAutoSnapshotPolicies--文件存储 NAS-火山引擎

文档中心

导航

DescribeAutoSnapshotPolicies

最近更新时间：2024.06.20 19:04:18首次发布时间：2023.09.20 10:44:05

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

请求参数

参数	类型	是否必选	示例值	描述
AutoSnapshotPolicyId	String	否	asp-15c19547****	需要查询的自动快照策略 ID。
AutoSnapshotPolicyName	String	否	enas-cnbj18bcb923****	需要查询的自动快照策略名称。
PageSize	Integer	否	10	每页记录数。取值为 `1~100` 间的整数。默认为 `10`。
PageNumber	Integer	否	1	策略列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 `1`。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	2	自动快照策略个数。
PageSize	Integer	10	每个分页包含的策略个数。
PageNumber	Integer	1	自动快照策略列表的分页页码。
AutoSnapshotPolicies	Array of AutoSnapshotPolicy	详情请参见返回示例	自动快照策略详情。

AutoSnapshotPolicy

参数	类型	示例值	描述
Status	String	Avaliable	自动快照策略状态，取值说明如下： `Avaliable`：运行中。 `Creating`：创建中。 `Deleting`：删除中。
CreateTime	String	2023-08-30T18:32:25+08:00	自动快照策略创建时间。
TimePoints	String	1,16	自动快照的创建时间点，说明如下：使用 UTC+8 时间，单位为小时。取值范围：`0~23`，表示 00:00 至 23:00 共 24 个时间点，例如 `1` 表示 01:00。
RetentionDays	Integer	30	自动快照的保留时间，单位为天，说明如下： `-1`：永久保存，直至自动快照数量达上限后自动删除。 `1~65536`：指定保存天数。
RepeatWeekdays	String	1,3	自动快照的重复日期，单位为天，周期为星期，例如 `1` 表示周一。
FileSystemCount	Integer	1	启用该策略的文件系统数量。
AutoSnapshotPolicyId	String	asp-61c49dec****	自动快照策略 ID。
AutoSnapshotPolicyName	String	policytest2	自动快照策略名称。

示例

请求示例

POST /?Action=DescribeAutoSnapshotPolicies&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/filenas/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
    "AutoSnapshotPolicyName": "enas-cnbj18bcb923****",
    "AutoSnapshotPolicyId": "asp-15c19547****",
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230831102113DB3C16090CA0A98A332A",
    "Action": "DescribeAutoSnapshotPolicies",
    "Version": "2022-01-01",
    "Service": "FileNAS",
    "Region": "cn-beijing"
  },
  "Result": {
    "AutoSnapshotPolicies": [
      {
        "AutoSnapshotPolicyId": "asp-61c49dec****",
        "AutoSnapshotPolicyName": "policytest2",
        "CreateTime": "2023-08-30T18:32:25+08:00",
        "Description": "test",
        "FileSystemCount": 1,
        "RepeatWeekdays": "1,3",
        "RetentionDays": 30,
        "Status": "Avaliable",
        "TimePoints": "1,16"
      },
      {
        "AutoSnapshotPolicyId": "asp-15c19547****",
        "AutoSnapshotPolicyName": "test",
        "CreateTime": "2023-08-30T11:16:23+08:00",
        "Description": "",
        "FileSystemCount": 1,
        "RepeatWeekdays": "1,2,3,4,5,6,7",
        "RetentionDays": -1,
        "Status": "Avaliable",
        "TimePoints": "0,10,11"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2
  }
}