Modifies an automatic snapshot policy. 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.

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 ModifyAutoSnapshotPolicy

The operation that you want to perform.

Set the value to ModifyAutoSnapshotPolicy.

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

The ID of the automatic snapshot policy.

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

AutoSnapshotPolicyName String No FinanceJoshua

The name of the automatic snapshot policy.

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

RepeatWeekdays String No 1,7

The day on which an auto snapshot is created.

Auto snapshots are created on a weekly basis.

Valid values: 1 to 7. The value 1 indicates Monday. If you want to create multiple auto snapshots 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.

RetentionDays Integer No 30

The number of days for which you want to retain the automatic snapshot.

Unit: days.

Valid values:

  • -1: the default value. 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.
TimePoints String No 0,1

The point in time at which an auto snapshot is 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.

Response parameters

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

The ID of the request.

The request ID is returned regardless of whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ModifyAutoSnapshotPolicy
&AutoSnapshotPolicyId=sp-extreme-233e6****
&<Common request parameters>

Sample success responses

XML format

<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>

JSON format

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

Error codes

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