Interface Overview

BLS

  • Function Release Records
  • Product Description
    • Usage restrictions
    • Product Introduction
  • Product pricing
  • Quick Start
    • Introduction
    • Install agent
    • Create LogStore
    • Create Transmission Task
    • Log Analysis and Alerting
    • Create Delivery Task
  • Operation guide
    • Baidu Intelligent Cloud Environment Preparation
    • Overview
    • Identity and access management
    • Logset Management
    • Agent
      • Install Agent on Host
      • Install Agent in K8s Environment
      • Agent Management
      • Agent Release Version
      • Set Agent Startup Parameters
    • Log Collection
      • Transmission Task Collection
        • Create Transmission Task
        • Manage Transmission Task
      • Uploading Logs Using Kafka Protocol
    • Query analysis
      • Log query
      • SQL Syntax
      • Search Syntax
    • Dashboard
      • Overview
      • Management Dashboard
      • Management Dashboard Charts
    • Alarm management
      • Alert Overview
      • Alarm strategy
        • Management alarm strategy
        • Trigger conditions
      • Alarm history
      • Alert execution statistics
      • Alarm notification
        • Alarm Notification Template
        • Alarm callback
    • Data processing
      • Log Delivery
        • Log Delivery Overview
        • Create Delivery Task
        • Manage Delivery Task
      • Scheduled SQL Analysis
        • Manage Scheduled SQL Analysis Task
        • Create Scheduled SQL Analysis Task
      • Real-Time Consumption
      • Data processing
        • Data processing
          • Overview of data processing functions
          • Process control function
          • Mapping enrichment functions
          • Event operation functions
          • Field operation functions
          • Field value extraction functions
    • Log Applications
      • Intelligent Diagnostics
  • Best Practices
    • Use Year-Over-Year and Month-Over-Month as Alert Trigger Conditions
    • BLS Integration with Kibana
    • Use BLS via Grafana
  • Development Guide
    • API Reference
      • API function release records
      • API Overview
      • Interface Overview
      • General Description
      • Service domain
      • Common error codes
      • Terminology
      • Project Related APIs
        • Create Project
        • Update Project
        • Describe Project
        • Delete Project
        • List Project
      • LogStore Related APIs
        • Create LogStore
        • Update LogStore
        • Delete LogStore
        • Describe LogStore
        • Batch Get LogStore
        • List LogStore
      • LogStream Related APIs
        • List LogStream
      • LogRecord Related APIs
        • Push log PushLogRecord
        • Obtain logrecord PullLogRecord
        • Search analysis log QueryLogRecord
        • Histogram API QueryLogHistogram
      • Fast Query FastQuery Related Interfaces
        • Create Fast Query CreateFastQuery
        • Update Fast Query UpdateFastQuery
        • Delete Fast Query DeleteFastQuery
        • Get Fast Query Details DescribeFastQuery
        • Get Fast Query List ListFastQuery
      • Index Related APIs
        • Create Index
        • Update Index
        • Delete Index
        • Describe Index
      • Log Shipper LogShipper Related Interfaces
        • Create Log Shipper
        • Update Log Shipper
        • Set Single Log Shipper Status
        • Delete Single Log Shipper
        • Bulk Delete Log Shipper
        • List Log Shipper Records
        • List Log Shipper
        • Bulk Set Log Shipper Status
        • Get Log Shipper
      • Alarm-Related Interfaces
        • CreateAlarmPolicy
        • UpdateAlarmPolicy
        • DeleteAlarmPolicy
        • ValidateAlarmCondition
        • ValidateAlarmPolicySQL
        • EnableAlarmPolicy
        • DescribeAlarmRecord
        • DisableAlarmPolicy
        • DescribeAlarmPolicy
        • ListAlarmPolicy
        • ListAlarmRecord
        • ListAlarmExecutionStats
        • ListAlarmExecutions
      • LogStore Template-Related Interfaces
        • CreateLogStoreTemplate
        • UpdateLogStoreTemplate
        • DeleteLogStoreTemplates
        • DescribeLogStoreTemplates
        • DescribeLogStoreTemplate
      • Download Log Download Related Interfaces
        • Create Download Task CreateDownloadTask
        • Get Download Task List ListDownloadTask
        • Delete Download Task DeleteDownloadTask
        • Get Download Task Address GetDownloadTaskLink
        • Get Download Task Details DescribeDownloadTask
      • LogAlarm Related Interfaces
        • SetLogAlarmStatus
        • deleteLogAlarm
        • createLogAlarm
        • listLogAlarm
        • updateLogAlarm
        • BulkDeleteLogAlarm
        • PreviewAlarmLogRecord
        • getLogAlarm
        • BulkSetLogAlarmStatus
      • Transmission Task Related Interfaces
        • Create Task CreateTask
        • UpdateTask
      • Interfaces Compatible with Elasticsearch
        • ResolveIndex
        • FieldCaps
        • TermsEnum
        • AsyncSearch
    • SDK Reference
      • Go SDK
        • Overview
        • Initialization
        • Version Release Records
        • Project Operations
        • LogStore Operations
        • Install the SDK Package
        • LogStream Operations
        • LogRecord Operations
        • FastQuery Operations
        • LogShipper Operations
        • Index Operations
        • Download Task Operations
      • Java SDK
        • Overview
        • Install the SDK Package
        • LogRecord Operations
      • iOS SDK
        • Overview
        • Quick start
        • Version Release Records
      • Android SDK
        • Overview
        • Quick start
        • Version Release Records
      • Android & iOS SDK Download
      • SDK Privacy Policy
      • SDK Developer Personal Information Protection Compliance Guide
    • Importing SLS Collection Configuration
  • FAQs
    • Common Questions Overview
    • Fault-related questions
    • Configuration-related questions
  • Log Service Level Agreement SLA
All documents
menu
No results found, please re-enter

BLS

  • Function Release Records
  • Product Description
    • Usage restrictions
    • Product Introduction
  • Product pricing
  • Quick Start
    • Introduction
    • Install agent
    • Create LogStore
    • Create Transmission Task
    • Log Analysis and Alerting
    • Create Delivery Task
  • Operation guide
    • Baidu Intelligent Cloud Environment Preparation
    • Overview
    • Identity and access management
    • Logset Management
    • Agent
      • Install Agent on Host
      • Install Agent in K8s Environment
      • Agent Management
      • Agent Release Version
      • Set Agent Startup Parameters
    • Log Collection
      • Transmission Task Collection
        • Create Transmission Task
        • Manage Transmission Task
      • Uploading Logs Using Kafka Protocol
    • Query analysis
      • Log query
      • SQL Syntax
      • Search Syntax
    • Dashboard
      • Overview
      • Management Dashboard
      • Management Dashboard Charts
    • Alarm management
      • Alert Overview
      • Alarm strategy
        • Management alarm strategy
        • Trigger conditions
      • Alarm history
      • Alert execution statistics
      • Alarm notification
        • Alarm Notification Template
        • Alarm callback
    • Data processing
      • Log Delivery
        • Log Delivery Overview
        • Create Delivery Task
        • Manage Delivery Task
      • Scheduled SQL Analysis
        • Manage Scheduled SQL Analysis Task
        • Create Scheduled SQL Analysis Task
      • Real-Time Consumption
      • Data processing
        • Data processing
          • Overview of data processing functions
          • Process control function
          • Mapping enrichment functions
          • Event operation functions
          • Field operation functions
          • Field value extraction functions
    • Log Applications
      • Intelligent Diagnostics
  • Best Practices
    • Use Year-Over-Year and Month-Over-Month as Alert Trigger Conditions
    • BLS Integration with Kibana
    • Use BLS via Grafana
  • Development Guide
    • API Reference
      • API function release records
      • API Overview
      • Interface Overview
      • General Description
      • Service domain
      • Common error codes
      • Terminology
      • Project Related APIs
        • Create Project
        • Update Project
        • Describe Project
        • Delete Project
        • List Project
      • LogStore Related APIs
        • Create LogStore
        • Update LogStore
        • Delete LogStore
        • Describe LogStore
        • Batch Get LogStore
        • List LogStore
      • LogStream Related APIs
        • List LogStream
      • LogRecord Related APIs
        • Push log PushLogRecord
        • Obtain logrecord PullLogRecord
        • Search analysis log QueryLogRecord
        • Histogram API QueryLogHistogram
      • Fast Query FastQuery Related Interfaces
        • Create Fast Query CreateFastQuery
        • Update Fast Query UpdateFastQuery
        • Delete Fast Query DeleteFastQuery
        • Get Fast Query Details DescribeFastQuery
        • Get Fast Query List ListFastQuery
      • Index Related APIs
        • Create Index
        • Update Index
        • Delete Index
        • Describe Index
      • Log Shipper LogShipper Related Interfaces
        • Create Log Shipper
        • Update Log Shipper
        • Set Single Log Shipper Status
        • Delete Single Log Shipper
        • Bulk Delete Log Shipper
        • List Log Shipper Records
        • List Log Shipper
        • Bulk Set Log Shipper Status
        • Get Log Shipper
      • Alarm-Related Interfaces
        • CreateAlarmPolicy
        • UpdateAlarmPolicy
        • DeleteAlarmPolicy
        • ValidateAlarmCondition
        • ValidateAlarmPolicySQL
        • EnableAlarmPolicy
        • DescribeAlarmRecord
        • DisableAlarmPolicy
        • DescribeAlarmPolicy
        • ListAlarmPolicy
        • ListAlarmRecord
        • ListAlarmExecutionStats
        • ListAlarmExecutions
      • LogStore Template-Related Interfaces
        • CreateLogStoreTemplate
        • UpdateLogStoreTemplate
        • DeleteLogStoreTemplates
        • DescribeLogStoreTemplates
        • DescribeLogStoreTemplate
      • Download Log Download Related Interfaces
        • Create Download Task CreateDownloadTask
        • Get Download Task List ListDownloadTask
        • Delete Download Task DeleteDownloadTask
        • Get Download Task Address GetDownloadTaskLink
        • Get Download Task Details DescribeDownloadTask
      • LogAlarm Related Interfaces
        • SetLogAlarmStatus
        • deleteLogAlarm
        • createLogAlarm
        • listLogAlarm
        • updateLogAlarm
        • BulkDeleteLogAlarm
        • PreviewAlarmLogRecord
        • getLogAlarm
        • BulkSetLogAlarmStatus
      • Transmission Task Related Interfaces
        • Create Task CreateTask
        • UpdateTask
      • Interfaces Compatible with Elasticsearch
        • ResolveIndex
        • FieldCaps
        • TermsEnum
        • AsyncSearch
    • SDK Reference
      • Go SDK
        • Overview
        • Initialization
        • Version Release Records
        • Project Operations
        • LogStore Operations
        • Install the SDK Package
        • LogStream Operations
        • LogRecord Operations
        • FastQuery Operations
        • LogShipper Operations
        • Index Operations
        • Download Task Operations
      • Java SDK
        • Overview
        • Install the SDK Package
        • LogRecord Operations
      • iOS SDK
        • Overview
        • Quick start
        • Version Release Records
      • Android SDK
        • Overview
        • Quick start
        • Version Release Records
      • Android & iOS SDK Download
      • SDK Privacy Policy
      • SDK Developer Personal Information Protection Compliance Guide
    • Importing SLS Collection Configuration
  • FAQs
    • Common Questions Overview
    • Fault-related questions
    • Configuration-related questions
  • Log Service Level Agreement SLA
  • Document center
  • arrow
  • BLS
  • arrow
  • Development Guide
  • arrow
  • API Reference
  • arrow
  • Interface Overview

Interface Overview

Updated at：2025-11-03

To facilitate users in managing BLS LogStores, writing, downloading, querying and analyzing log data via APIs, the platform provides developers with the following APIs:

Object Method
Project [ Project CreateProject](BLS/Development Guide/API Reference/Project-related APIs/CreateProject.md), [Project UpdateProject](BLS/Development Guide/API Reference/Project-related APIs/UpdateProject.md), [Project DeleteProject](BLS/Development Guide/API Reference/Project-related APIs/DeleteProject.md), [Project DescribeProject](BLS/Development Guide/API Reference/Project-related APIs/DescribeProject.md), [Project ListProject](BLS/Development Guide/API Reference/Project-related APIs/ListProject.md)
LogStore [Logstore CreateLogStore](BLS/Development Guide/API Reference/LogStore-related APIs/CreateLogStore.md), [Logstore UpdateLogStore](BLS/Development Guide/API Reference/LogStore-related APIs/UpdateLogStore.md), [Logstore DeleteLogStore](BLS/Development Guide/API Reference/LogStore-related APIs/DeleteLogStore.md), [Logstore DescribeLogStore](BLS/Development Guide/API Reference/LogStore-related APIs/DescribeLogStore.md), [Logstore ListLogStore](BLS/Development Guide/API Reference/LogStore-related APIs/ListLogStore.md)
LogStream [Logstream ListLogStream](BLS/Development Guide/API Reference/LogStream-related APIs/ListLogStream.md)
LogRecord [PushLogRecord](BLS/Development Guide/API Reference/LogRecord-related APIs/PushLogRecord.md)、[PullLogRecord](BLS/Development Guide/API Reference/LogRecord-related APIs/PullLogRecord.md)、[QueryLogRecord](BLS/Development Guide/API Reference/LogRecord-related APIs/QueryLogRecord.md)
FastQuery [CreateFastQuery](BLS/Development Guide/API Reference/FastQuery-related APIs/CreateFastQuery.md)、[UpdateFastQuery](BLS/Development Guide/API Reference/FastQuery-related APIs/UpdateFastQuery.md)、[DeleteFastQuery](BLS/Development Guide/API Reference/FastQuery-related APIs/DeleteFastQuery.md)、[DescribeFastQuery](BLS/Development Guide/API Reference/FastQuery-related APIs/DescribeFastQuery.md)、[ListFastQuery](BLS/Development Guide/API Reference/FastQuery-related APIs/ListFastQuery.md)
Index [CreateIndex](BLS/Development Guide/API Reference/Index-related APIs/CreateIndex.md)、[UpdateIndex](BLS/Development Guide/API Reference/Index-related APIs/UpdateIndex.md)、[DeleteIndex](BLS/Development Guide/API Reference/Index-related APIs/DeleteIndex.md)、[DescribeIndex](BLS/Development Guide/API Reference/Index-related APIs/DescribeIndex.md)
LogShipper [CreateLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/CreateLogShipper.md)、[UpdateLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/UpdateLogShipper.md)、[GetLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/GetLogShipper.md)、[ListLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/ListLogShipper.md)、[ListLogShipperRecord](BLS/Development Guide/API Reference/LogShipper-related APIs/ListLogShipperRecord.md)、[DeleteSingleLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/DeleteSingleLogShipper.md)、[BulkDeleteLogShipper](BLS/Development Guide/API Reference/LogShipper-related APIs/BulkDeleteLogShipper.md)、SetSingleLogShipperStatus、[BulkSetLogShipperStatus](BLS/Development Guide/API Reference/LogShipper-related APIs/BulkSetLogShipperStatus.md)
DownloadTask [CreateDownloadTask](BLS/Development Guide/API Reference/Download-related APIs/CreateDownloadTask.md)、[DeleteDownloadTask](BLS/Development Guide/API Reference/Download-related APIs/DeleteDownloadTask.md)、[DescribeDownloadTask](BLS/Development Guide/API Reference/Download-related APIs/DescribeDownloadTask.md)、[GetDownloadTaskLink](BLS/Development Guide/API Reference/Download-related APIs/GetDownloadTaskLink.md)、[ListDownloadTask](BLS/Development Guide/API Reference/Download-related APIs/ListDownloadTask.md)
Alarm (alarm management) CreateAlarmPolicy、UpdateAlarmPolicy、DescribeAlarmPolicy、ListAlarmPolicy、DeleteAlarmPolicy、EnableAlarmPolicy、DisableAlarmPolicy、ValidateAlarmPolicySQL、ValidateAlarmCondition、ListAlarmRecord、DescribeAlarmRecord、ListAlarmExecutions、ListAlarmExecutionStats
LogStoreTemplate (logstore template) CreateLogStoreTemplate、UpdateLogStoreTemplate、DeleteLogStoreTemplate、DescribeLogStoreTemplate、DescribeLogStoreTemplates

Previous
API Overview
Next
General Description