DescribeAutoSnapshotPolicies - Apsara File Storage NAS - Alibaba Cloud Documentation Center

Queries automatic snapshot policies.

Operation description

The snapshot feature is in public preview and is provided free of charge. Apsara File Storage NAS Service Level Agreement (SLA) is not guaranteed in public preview.
Only advanced Extreme NAS file systems support this feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AutoSnapshotPolicyId	string	No	The ID of the automatic snapshot policy.	sp-extreme-233e6****
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
FileSystemType	string	Yes	The type of the file system. Valid value: extreme, which indicates Extreme NAS file systems.	extreme

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of automatic snapshot policies.	2
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
AutoSnapshotPolicies	object []	The queried automatic snapshot policies.
TimePoints	string	The points in time at which auto snapshots are created. Unit: hours. Valid values: `0 to 23`. The values from 0 to 23 indicate a total of 24 hours from `00:00 to 23:00`. For example, 1 indicates 01:00. A maximum of 24 points in time can be returned. Multiple points in time are separated with commas (,).	4,19
Status	string	The status of the automatic snapshot policy. Valid values: Creating: The automatic snapshot policy is being created. Available: The automatic snapshot policy is available.	Available
RepeatWeekdays	string	The days of a week on which auto snapshots are created. Auto snapshots are created on a weekly basis. Valid values: 1 to 7. The values from 1 to 7 indicate 7 days in a week from Monday to Sunday.	1,5
AutoSnapshotPolicyName	string	The name of the automatic snapshot policy.	FinanceJoshua
CreateTime	string	The time when the automatic snapshot policy was created. The time follows the ISO8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2014-04-21T12:08:52Z
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy.	sp-extreme-233e6****
RetentionDays	integer	The retention period of auto snapshots. Unit: days. Valid values: -1: Auto snapshots are permanently retained. After the number of auto snapshots exceeds the upper limit, the earliest auto snapshot is automatically deleted. 1 to 65536: Auto snapshots are retained for the specified days. After the retention period of auto snapshots expires, the auto snapshots are automatically deleted.	30
FileSystemNums	integer	The number of file systems to which the automatic snapshot policy applies.	2
RegionId	string	The region ID of the automatic snapshot policy.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 10,
  "PageNumber": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "TimePoints": "4,19",
        "Status": "Available",
        "RepeatWeekdays": "1,5",
        "AutoSnapshotPolicyName": "FinanceJoshua",
        "CreateTime": "2014-04-21T12:08:52Z",
        "AutoSnapshotPolicyId": "sp-extreme-233e6****",
        "RetentionDays": 30,
        "FileSystemNums": 2,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.