All Products
Search
Document Center

File Storage NAS:ModifyAutoSnapshotPolicy

Last Updated:Dec 11, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
nas:ModifyAutoSnapshotPolicyupdate
*All Resources
*
    none
none

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.

Change history

Change timeSummary of changesOperation
2024-09-05The internal configuration of the API is changed, but the call is not affectedView Change Details