Queries automatic snapshot policies.

Usage notes

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.
AutoSnapshotPolicyId String No sp-extreme-233e6****

The ID of the automatic snapshot policy.

PageSize Integer No 10

The number of entries per page.

Valid values: 1 to 100

Default value: 10
PageNumber Integer No 1

The page number.

Pages start from page 1. Default value: 1.
FileSystemType String Yes extreme

The type of the file system.

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

Response parameters

Parameter Type Example Description
TotalCount Integer 2

The total number of automatic snapshot policies.

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

The request ID.

PageSize Integer 10

The number of entries per page.

PageNumber Integer 1

The page number.

AutoSnapshotPolicies Array of AutoSnapshotPolicy

The list of automatic snapshot policies.

AutoSnapshotPolicy
TimePoints String 4,19

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 (,).

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.
RepeatWeekdays String 1,5

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.

AutoSnapshotPolicyName String FinanceJoshua

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

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

The ID of the automatic snapshot policy.

RetentionDays Integer 30

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.
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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAutoSnapshotPolicies
&AutoSnapshotPolicyId=sp-extreme-233e6****
&PageSize=10
&PageNumber=1
&FileSystemType=extreme
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize" : 10,
  "PageNumber" : 1,
  "AutoSnapshotPolicies" : [ {
    "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, see Service error codes.