Queries the information about 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 automatically 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 the file system.

Valid value: extreme, which indicates Extreme NAS file systems.

AutoSnapshotPolicyId String No sp-extreme-233e6****

The ID of the automatic snapshot policy.

PageSize Integer No 10

The number of entries to return on each page.

Valid values: 1 to 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
AutoSnapshotPolicies Array of AutoSnapshotPolicy

The list of automatic snapshot policies.

AutoSnapshotPolicy
AutoSnapshotPolicyId String FinanceJoshua

The ID of the 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 UTC. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format.

FileSystemNums Integer 2

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

RegionId String cn-hangzhou

The ID of the region where the automatic snapshot policy resides.

RepeatWeekdays String 1,5

The day on which an auto snapshot was 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.

RetentionDays Integer 30

The number of days for which you want to retain 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.
Status String Available

The status of the automatic snapshot policy.

Valid values:

  • Creating: The automatic snapshot policy is being created.
  • Available: The automatic snapshot policy is available.
TimePoints String 4,19

The point in time at which an auto snapshot was 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. If you want to create multiple auto snapshots a day, you can specify multiple points in time and separate the points in time with commas (,). You can specify a maximum of 24 points in time.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 2

The total number of automatic snapshot policies.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeAutoSnapshotPolicies
&FileSystemType=extreme
&<Common request parameters>

Sample success responses

XML format

<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageNumber>1</PageNumber>
<AutoSnapshotPolicies>
    <AutoSnapshotPolicy>
        <Status>Available</Status>
        <TimePoints>4,19</TimePoints>
        <FileSystemNums>2</FileSystemNums>
        <CreateTime>2014-04-21T12:08:52Z</CreateTime>
        <RetentionDays>30</RetentionDays>
        <AutoSnapshotPolicyId>FinanceJoshua</AutoSnapshotPolicyId>
        <RepeatWeekdays>1,5</RepeatWeekdays>
        <RegionId>cn-hangzhou</RegionId>
        <AutoSnapshotPolicyName>p-23f2i9s4t</AutoSnapshotPolicyName>
    </AutoSnapshotPolicy>
</AutoSnapshotPolicies>

JSON format

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

Error codes

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