All Products
Search
Document Center

Apsara File Storage NAS:ModifyAutoSnapshotPolicy

Last Updated:Mar 14, 2024

An automatic snapshot policy is modified. After you modify an automatic snapshot policy that is applied to a file system, the modification immediately applies to subsequent snapshots that are created for the file system.

Operation description

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AutoSnapshotPolicyIdstringYes

The ID of the automatic snapshot policy.

You can call the DescribeAutoSnapshotPolicies operation to view available automatic snapshot policies.

sp-extreme-233e6****
AutoSnapshotPolicyNamestringNo

The name of the automatic snapshot policy. If you do not specify this parameter, the policy name is not changed.

Limits:

  • The name must be 2 to 128 characters in length.
  • The name must start with a letter.
  • The name can contain digits, letters, colons (:), underscores (_), and hyphens (-). It cannot start with http:// or https://.
FinanceJoshua
RepeatWeekdaysstringNo

The days of a week on which auto snapshots are created.

Cycle: week.

Valid values: 1 to 7. The value 1 indicates Monday. If you want to create multiple auto snapshots within a week, you can specify multiple days from Monday to Sunday and separate the days with commas (,). You can specify a maximum of seven days.

1,7
RetentionDaysintegerNo

The retention period of auto snapshots.

Unit: days.

Valid values:

  • -1 (default): 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 number of days. After the retention period of auto snapshots expires, the auto snapshots are automatically deleted.
30
TimePointsstringNo

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, the value 1 indicates 01:00. If you want to create multiple auto snapshots within 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.

0,1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

Every response returns a unique request ID regardless of whether the request is successful.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

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