> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eorion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取历史记录清理配置

> Retrieves history cleanup batch window configuration (See
[History cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup)).



## OpenAPI

````yaml GET /history/cleanup/configuration
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /history/cleanup/configuration:
    get:
      tags:
        - History Cleanup
      summary: Get History Cleanup Configuration
      description: >-
        Retrieves history cleanup batch window configuration (See

        [History
        cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup)).
      operationId: getHistoryCleanupConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoryCleanupConfigurationDto'
              examples:
                example-1:
                  summary: GET `/history/cleanup/configuration`
                  description: GET `/history/cleanup/configuration`
                  value:
                    batchWindowStartTime: 2017-09-11T23:59:00.000+0200
                    batchWindowEndTime: 2017-09-12T02:00:00.000+0200
                    enabled: 'true'
          description: Request successful.
components:
  schemas:
    HistoryCleanupConfigurationDto:
      type: object
      properties:
        batchWindowStartTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            Start time of the current or next batch window. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,

            e.g., `2013-01-23T14:42:45.000+0200`.
        batchWindowEndTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            End time of the current or next batch window. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,

            e.g., `2013-01-23T14:42:45.000+0200`.
        enabled:
          type: boolean
          nullable: true
          description: >-
            Indicates whether the engine node participates in history cleanup or

            not. The default is `true`. Participation can be disabled via

            [Process Engine
            Configuration](https://docs.camunda.org/manual/7.22/reference/deployment-descriptors/tags/process-engine/#history-cleanup-enabled).


            For more details, see

            [Cleanup Execution Participation per
            Node](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#cleanup-execution-participation-per-node).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````