All Products
Search
Document Center

Tair (Redis® OSS-Compatible):ModifyInstanceMaintainTime

Last Updated:Oct 30, 2024

Modifies the maintenance window of an ApsaraDB for Redis instance. Alibaba Cloud maintains ApsaraDB for Redis instances during the specified maintenance window.

Operation description

You can also modify the maintenance window of an instance in the ApsaraDB for Redis console. For more information, see Set a maintenance window.

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
kvstore:ModifyInstanceMaintainTimeupdate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
MaintainStartTimestringYes

The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC. For example, if you want the maintenance to start at 1:00 (UTC+8), set this parameter to 17:00Z. After you call the API operation, you can view the actual time in the ApsaraDB for Redis console. For more information, see Set a maintenance window.

03:00Z
MaintainEndTimestringYes

The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC. For example, if you want the maintenance window to end at 2:00 (UTC+8), set this parameter to 18:00Z.

Note The interval between the start time and the end time cannot be less than 1 hour.
04:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76

Examples

Sample success responses

JSONformat

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidEndTime.FormatSpecified end time is not valid.The incoming end time does not meet the specification requirements.

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

Change history

Change timeSummary of changesOperation
2023-03-02The Error code has changedView Change Details