Query automatic snapshot policies using DescribeAutoSnapshotPolicies - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries the automatic snapshot policies that have been created.

Operation description

This feature is in free public preview. During the public preview, the File Storage NAS Service-Level Agreement (SLA) protocol is not guaranteed.
Only Advanced Extreme NAS supports this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeAutoSnapshotPolicies

list

*All Resource

*

None

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 automatic snapshot policies on each page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number of the automatic snapshot policy list. Default value: 1.	1
FileSystemType	string	No	The file system type. Valid value: extreme (Extreme NAS file system). Valid values: extreme : Extreme NAS file system.	extreme

Response elements

Element	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 of the automatic snapshot policy list.	1
AutoSnapshotPolicies	object
AutoSnapshotPolicy	array<object>	The details of automatic snapshot policies.
	object
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
FileSystemType	string	The type of the file system.	extreme

Examples

Success response

JSON format

{
  "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",
        "FileSystemType": "extreme"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.