All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeActiveOperationMaintainConf

Last Updated:Dec 10, 2025

Queries the active Operations and Maintenance (O&M) configuration of a ClickHouse instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

HasConfig

integer

Indicates whether a configuration is set.

  • 1: A configuration is set.

  • 0: No configuration is set.

1

RequestId

string

The request ID.

9A23C87D-87DF-4DA0-A50E-CB13F4F7923D

Config

object

The active O&M configuration items.

CycleType

string

The cycle type.

  • Month

  • Week

Week

Status

integer

The status of the configuration. A value of 1 indicates that the configuration is enabled. A value of 2 indicates that the configuration is disabled.

1

ModifiedTime

string

The time when the configuration was last modified.

2025-06-27T07:12:53Z

MaintainStartTime

string

The start time of the maintenance window.

18:00Z

MaintainEndTime

string

The end time of the maintenance window.

22:00Z

CycleTime

string

The day of the cycle.

  • If CycleType is Month, this parameter returns one or more numbers from 1 to 28 that indicate the day of the month. Multiple numbers are separated by commas (,).

  • If CycleType is Week, this parameter returns one or more numbers from 1 to 7 that indicate the day of the week. Multiple numbers are separated by commas (,).

1

CreatedTime

string

The time when the configuration was created.

2025-03-18T06:51:11+08:00

Examples

Success response

JSON format

{
  "HasConfig": 1,
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "Config": {
    "CycleType": "Week",
    "Status": 1,
    "ModifiedTime": "2025-06-27T07:12:53Z",
    "MaintainStartTime": "18:00Z",
    "MaintainEndTime": "22:00Z",
    "CycleTime": "1",
    "CreatedTime": "2025-03-18T06:51:11+08:00"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.