Queries the details of automatic snapshot policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAutoSnapshotPolicies

The operation that you want to perform. Set the value to DescribeAutoSnapshotPolicies.

FileSystemType String Yes extreme

The type of file system. Valid value: extreme.

AutoSnapshotPolicyId String No sp-extreme-233e6ylv0

The ID of the automatic snapshot policy.

PageSize Integer No 10

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10.
PageNumber Integer No 1

The number of the page to return.

  • Pages start from page 1.
  • Default value: 1.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 2

The total number of automatic snapshot policies.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer   1

The page number of the returned page.

AutoSnapshotPolicies Array

The IDs of automatic snapshot policies.

AutoSnapshotPolicyId String FinanceJoshua

The ID of each automatic snapshot policy.

AutoSnapshotPolicyName String p-23f2i9s4t

The name of the automatic snapshot policy.

CreateTime String 2014-04-21T12:08:52Z

The time when the automatic snapshot policy was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

FileSystemNums Integer 2

The number of file systems to which the automatic snapshot policy applies.

RegionId String cn-hangzhou

The ID of the region to which the automatic snapshot policy belongs.

RepeatWeekdays String 1,5

The days when the automatic snapshot policy recurs within a week. Unit: days. Valid values: 1 to 7. For example, 1 indicates Monday.

RetentionDays Integer 30

The retention period of an automatic snapshot. Unit: days. Default value: -1. Valid values:

  • -1: specifies that an automatic snapshot is created for persistent storage. If the number of automatic snapshots exceeds the maximum limit, the automatic snapshot is automatically deleted.
  • 1-65536: specifies the number of days to retain an automatic snapshot. If the retention period expires, the automatic snapshot is automatically deleted.
Status String Available

The status of the snapshot. Valid values: Creating and Available.

TimePoints String 4,19

The points in time when the automatic snapshot policy recurs. Unit: points in time. Valid values: 0 to 23, representing 24 points in time that range from 00:00 to 23:00. For example, 1 indicates 01:00. Unit: points in time. You can specify a maximum of 24 points in time. Separate multiple points in time with commas (,).

Examples

Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeAutoSnapshotPolicies
&FileSystemType=extreme
& <Common request parameters>
...

Sample success responses

JSON format

{
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 10,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "AutoSnapshotPolicyName": "",
        "TimePoints": "0,1,2",
        "RetentionDays": -1,
        "FileSystemNums": 0,
        "AutoSnapshotPolicyId": "sp-extreme-6i0brwewjt0gfylh0",
        "RepeatWeekdays": "1,2"
      }
    ]
  },
  "RequestId": "B208E2EA-E9CC-40E3-BE0B-4FFDDD9CB54B"
}

Error codes

For a list of error codes, visit the API Error Center.