DescribeActiveOperationMaintenanceConfig - Tair (Redis® OSS-Compatible)

Queries the O\\\&M task configurations of an instance.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeActiveOperationMaintenanceConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
HasConfig	integer	Indicates whether the O&M task is configured. Valid values: 1: The O&M task is configured. 0: The O&M task is not configured.	0
RequestId	string	The request ID.	794120D1-E0CF-4713-BAE4-EBAEA04506AF
Config	object	The configuration details of the O&M task.
CycleType	string	The unit of the O&M task cycle. Valid values: Month Week	Week
Status	integer	Indicates whether the configurations take effect. Valid values: 1: The configurations are in effect. 2: The configurations are invalid.	1
ModifiedTime	string	The time when the last O&M task configurations are modified. The time follows the ISO 8601 standard in the yyyy-mm-ddThh:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).	2024-05-30T14:30:00Z
MaintainStartTime	string	The start time of the O&M window. The time follows the ISO 8601 standard in the hh:mm:ss Z format. The time is displayed in UTC.	18:00:00Z
MaintainEndTime	string	The end time of the O&M window. The time follows the ISO 8601 standard in the hh:mm:ss Z format. The time is displayed in UTC.	20:00:00Z
CycleTime	string	The interval between two O&M tasks. If the CycleType parameter is set to Month, the CycleTime parameter returns a string of numbers ranging from 1 to 28, which indicates the specific days of the month. The numbers are separated with commas (,). The CycleTime parameter returns 0 when the configurations do not take effect. If the CycleType parameter is set to Week, the CycleTime parameter returns a string of numbers ranging from 1 to 7, which indicates the specific days of the week. The numbers are separated with commas (,). The CycleTime parameter returns 0 when the configurations do not take effect.	1,2,3
CreatedTime	string	The time when the O&M task was created. The time follows the ISO 8601 standard in the yyyy-mm-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-05-30T14:30:00Z

Examples

Sample success responses

JSONformat

{
  "HasConfig": 0,
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "Config": {
    "CycleType": "Week",
    "Status": 1,
    "ModifiedTime": "2024-05-30T14:30:00Z\n",
    "MaintainStartTime": "18:00:00Z",
    "MaintainEndTime": "20:00:00Z\n",
    "CycleTime": "1,2,3",
    "CreatedTime": "2018-05-30T14:30:00Z\n"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-10-23	Add Operation	View Change Details