Skip to content
Guance Docs
ping Service Test
中文
English
日本語
한국어
update-log
Release Notes
Learn More
GET STARTED
Guance Docs
update-log
Release Notes
Release Notes
2025
2024
2023
2022
2021
2020
2019
Getting Started
cache
Product Introduction
Product Introduction
Concepts
Customer Value
Main-title
Plans
Plans
Register Free Plan
Register Commercial Plan
Register Commercial Plan
Register Commercial Plan from Official Website
Register Commercial Plan from Cloud Providers
Register Commercial Plan from Cloud Providers
Activate on Alibaba Cloud Marketplace
Activate on Alibaba Cloud International Marketplace
Activate Exclusive Plan on Alibaba Cloud Marketplace
Activate on AWS Marketplace
Purchase on Huawei Cloud Store
Purchase on Microsoft Azure Store
Plan Differences
FAQ
notebook
Quick Start
Quick Start
Install and Use DataKit
Install and Use DataKit
Install on Linux
Install on Windows
Install on macOS
Install on Kubernetes
Install via Kubernetes Helm
Docker Installation
Datakit Operator
Quickly Create Dashboards
Start Using Monitors
Enable APM Tracing
DataKit
DataKit
Changelog
Changelog
2025
2021~2024
DataKit Installation
DataKit Installation
Host Installation
Containers
Containers
Kubernetes
Helm
Docker
AWS ECS Fargate
AWS EKS
GCP GKE Autopilot
Offline Installation
Batch Installation
Using DataKit
Using DataKit
Service Management
Status Management
Update
DQL Query
Other Commands
Trouble Shooting
Trouble Shooting
No data collected
Bug report
Datakit Metrics
Virtual Internet Access
Virtual Internet Access
Alibaba Cloud
AWS Cloud
Performance
DataKit Configuration
DataKit Configuration
Major Configuration
Collector Configuration
Election Configuration
Proxy Configuration
Operator Configuration
Operator Configuration
Changelog
Asyncprofile
DDTrace
Flameshot
logfwd
logging
pyspy
Other Configurations
Other Configurations
Configuration Overview
DCA
Git
Configuration Support
DataKit Development
DataKit Development
HTTP API
Documentation
Integrate
Integrations
OpenTelemetry
OpenTelemetry
Zero-code Instrumentation
Zero-code Instrumentation
Java
Java Extension
Python
PHP
Node.js
.NET
Go
SDK Instrumentation
SDK Instrumentation
Go
Data Query & Processing
DQL
DQL
DQL
DQL Query Entry
DQL Functions
Advanced Functions
Advanced Functions
DBSCAN
How to Report Custom Advanced Functions from Local Func
DQL VS Other Query Languages
DQL VS Other Query Languages
Getting Started with PromQL
External Data Sources
External Data Sources
TiDB Cloud Lake
TiDB Cloud Lake
Register and Get Lake DSN
Access and Query
FAQ
General Chart Data Returns
General Chart Data Returns
Line Chart
Pie Chart
Table Chart
Topology Chart Data Return
Pipeline
Pipelines
Pipelines
Manage Pipelines
Pipeline Manual
Pipeline Manual
Quick start
Basics and principles
Basics and principles
Data processing of each data category
Grok pattern
Platypus Grammar
Built-in function
Additional features
Additional features
Reference Table
Offload
Performance benchmarks and optimizations
Core Features
Insight
Scenes
Scenes
Dashboards
Dashboards
Workspace
List Management
Page Management
Page Management
History Versions
Visual Charts
Visual Charts
Chart Types
Chart Types
Time Series
Bar Chart
Pie Chart
Overview Chart
Top List
Table Chart
China Map
World Map
Scatter Plot
Bubble Chart
Histogram
Treemap
Cellular Map
Heatmap
Topology Map
SLO
Gauge Chart
Funnel Chart
Sankey Diagram
Data List
Alert Statistics
Monitor Summary
Text
Video
Picture
Command Panel
IFrame
Dashboard List
Chart Configuration
Chart Query
Chart Query
Simple Query
Expression Query
DQL Query
PromQL Query
Data Source Query
Chart JSON
Chart Links
Chart Links
Default Link
Custom Link
Use Cases
Event Association
View Variables
View Variables
Variable Query
Object Mapping
Reports
Notes
Explorer
Explorer
Quick Setup
List Management
Page Management
Built-in Views
Built-in Views
Bind Built-in View
FAQs
Notes
Notes
Create/Edit Notebook
Chart Block Configuration
key
Events
Events
All Events
Unrecovered Events
Change Events
Intelligent Inspection Events
Event Details
FAQ
Error备份 2
Errors
Errors
Create Error Delivery Rules
Error List
Error Rule Details
FAQ
exception-tracking
Incident
Incident
Create
Manage
Analysis Dashboard
Calendar
Configuration Management
Configuration Management
Level Definition
Issue Discovery
Notification Policy
exception-tracking
Incident Center
Incident Center
Incident List
Incident Details
Incident Analysis Dashboard
On-call
Configuration Management
Configuration Management
Level Definition
Level Mapping
Incident Auto Analysis
Incident Aggregation Rules
Webhook Configuration
FAQ
object-sidebar
Infrastructure
Infrastructure
Host
Containers
Containers
Type
Type
Containers
Kubernetes
Kubernetes
Pods
Services
Deployments
Nodes
Replica Sets
Jobs
Cron Jobs
DaemonSet
StatefulSet
Persistent Volumes
PVC
Analysis Dashboard
Process
Database
Database
Explorer
Query Analysis
Network
Network
Summary
Topology
Network Flow
Devices
Network Path
Resource Catalog
Resource Catalog
Data Reporting
FAQ
Unified Catalog备份
Unified Catalog
Unified Catalog
Create Entity
Entity List
Entity Details
Entity Type Management
Topology View
index-sidebar
Metrics
Metrics
Metrics Collection
Metrics Analysis
Metrics Management
Generate Metrics
FAQ
sidebar-journal
Logs
Logs
Log Collection
Browser Log Collection
MiniApp Log Collection
Log Explorer
Log Explorer
Log List
Log Details
BPF Network Log
Error Tracking
Index
Index
Log Index
Full-line Index
Direct Index
External Index
External Index
SLS Logstore
Elasticsearch
OpenSearch
Logease
Volcengine TLS
Cross-Workspace Index Query
FAQ
应用性能监测
APM
APM
Data Collection
Data Collection
Connect Web App Access
Configure APM Sampling
APM Associated Logs
APM Associated Logs
Java Logs Correlation with APM Data
Python Logs Correlation with APM Data
Services
Services
Performance Metrics
Service Map
Service Details
Analysis Dashboard
Traces
Traces
Manual Installation
Manual Installation
Deploy on Host
Deploy on Kubernetes
Auto Injection
Explorer
Explorer
List
Details
Error Tracking
Profiling
RUM
RUM
Web
Web
Web Application Access
Frontend Framework Plugin Access
Accessing in SSR Frameworks
Electron Application Access
Data Collection Description
Page Performance and Experience Analysis
Sampling Configuration
User Actions
Custom Data and Events
Custom Data and Events
User ID
Global Context
Add Custom Action
Report Custom Error
Custom Views
Resource Hook
WebSocket Long Connection Collection
FAQ
Changelog
MiniApp
MiniApp
Changelog
App Access
Remote Configuration and Forced Sampling
Mini Program Access Based on Uniapp Development Framework
App Data Collection
Custom RUM SDK Data Collection Content
Custom RUM SDK Data Collection Content
Custom User ID
Add Additional Tags
Custom Add Action
Custom Add Error
Android
Android
Changelog
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags
Custom Collection Rules
Data Masking
WebView Monitoring
Dynamic Configuration and Update URLs
Symbol File Upload
Privacy and Permissions
Content Provider Settings
Manual Integration
App Data Collection
Troubleshooting
iOS/tvOS/macOS
iOS/tvOS/macOS
Changelog
Migration Guide
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags Usage
Custom Data Collection Rules
Data Collection Masking
URLSession Custom Network Collection
Dynamic Configuration and Dynamic Update Address
Symbol File Upload
Widget Extension Data Collection
WebView Data Monitoring
tvOS Data Collection
App Data Collection
Troubleshooting
HarmonyOS
HarmonyOS
Changelog
Quick Start
App Access
Configuration Instructions
Configuration Instructions
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags and Global Context
Data Collection Masking
Dynamic Configuration and Dynamic Address Update
WebView Data Monitoring
App Data Collection
Troubleshooting
React Native
React Native
Changelog
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags Usage
Custom Data Collection Rules
Data Masking
Dynamic Configuration and Update URLs
Source Map Upload
WebView Data Monitoring
Native and React Native Hybrid Development
Android Resource Manual Configuration
App Data Collection
Troubleshooting
Flutter
Flutter
Changelog
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags Usage
Custom Data Collection Rules
Data Masking
WebView Data Monitoring
Native and Flutter Hybrid Development
Publish Package Configuration
App Data Collection
Troubleshooting
UniApp
UniApp
Changelog
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Mini Program JS SDK Remote Configuration
Custom Tags and BridgeContext
Data Collection Masking
WebView Data Monitoring
App Data Collection
Troubleshooting
Windows
Windows
Changelog
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags
Desktop UI Frameworks
WebView2 Monitoring
Electron Monitoring
Privacy & Permissions
App Data Collection
Troubleshooting
C++
C++
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags
Custom Collection Rules
App Data Collection
Troubleshooting
Unity
Unity
Quick Start
App Access
Configuration
Configuration
SDK Initialization
RUM Configuration
Log Configuration
Trace Configuration
Advanced Scenarios
Advanced Scenarios
Custom Tags Usage
Data Collection Masking
Native and Unity Hybrid Development
Troubleshooting
Explorer
Explorer
Session
View
Resource
Action
Long Task
Error
Analysis Dashboard
Session Replay
Session Replay
Web
Web
How to Integrate SESSION REPLAY
How to Integrate Canvas Recording
Troubleshooting
Mobile
Mobile
Android SESSION REPLAY
iOS SESSION REPLAY
Flutter SESSION REPLAY
React Native SESSION REPLAY
Windows (Experimental)
User Analysis
User Analysis
Session Heatmap
Funnel Analysis
Data Access
Custom Tracing
SourceMap
SourceMap
SourceMap Configuration
Upload SourceMap via Script
Upload SourceMaps via Webpack
Upload SourceMaps via Vite
Custom Environment Variables
Others
Others
Data Interception & Modification
Page Performance
Content Security Policy
test
Synthetic Monitoring
Synthetic Monitoring
TESTING Tasks
TESTING Tasks
API Tests
API Tests
HTTP
ICMP
TCP
WEBSOCKET
SSL
Network Path Tests
Multistep Tests
Browser Tests
Overview
Explorer
Self-built Nodes Management
FAQ
SIEM
Security
Security
Create Detection Rules
Create Detection Rules
Official Detection Library
Custom Creation
Manage Detection Rules
Signals
Execution Logs
Arbiter
Arbiter
Syntax
Built-in Functions
CI
CI Visibility
CI Visibility
Data Collection
Explorer
Overview
trigger
Monitoring
Monitoring
Monitor
Monitor
Official Template Library
Detection Rules
Detection Rules
Threshold Detection
Mutation Detection
Interval Detection
Interval Detection V2
Outlier Detection
Log Detection
Process Anomaly Detection
Infrastructure Liveness Detection V2
Application Performance Detection
Real User Detection
Composite Detection
Synthetic Testing Anomaly Detection
Network Data Detection
Third-Party Event Detection
Infrastructure Change Detection
Programmable Detection
Custom Template Library
Monitor List
Recover Monitor
Operators
Truth Table
Event Levels
Custom Event Notification Template
Monitor Internal Principles
Intelligent Inspection
Intelligent Inspection
Application Intelligent Detection
Cloud Billing Intelligent Monitoring
Host Intelligent Inspection
Kubernetes Intelligent Inspection
Log Intelligent Detection
RUM Intelligent Anomaly Detection
SLO
SLO
Create SLO
Manage SLO
SLO Details
Mute Management
Alert Strategies
Alert Strategies
Create Alert Strategies
Manage Alert Strategies
Alert Aggregation Notification Template
Notification Targets
Notification Targets
DingTalk Bot
WeCom Bot
Lark Bot
Webhook Customization
Webhook Customization
Webhook Custom Body Template
Simple HTTP Request
SMS
Voice Call (IVR)
Slack
Teams
Telegram Bot
FAQ
Workspace
Workspace Management
Workspace Management
Account Settings
Preferences
Other Settings
Workspace Settings
Workspace Settings
Key Metrics
Customized Menu
Log Latency Visibility
Advanced Permissions
MFA Management
Attribute Claims
Field Management
Global Labels
Environment Variables
Member Management
Member Management
Invite Members
Role Management
Role Management
Permissions List
API Keys Management
API Keys Management
Open API
FAQ
Client Token Management
Blacklist
Data Forwarding
Data Forwarding
Create Forwarding Rules
Create Forwarding Rules
Data Forwarding to AWS S3
Data Forwarding to Huawei Cloud OBS
Data Forwarding to Alibaba Cloud OSS
Data Forwarding to Kafka Message Queues
Data Forwarding to Volcengine TOS
Data Forwarding to GCP GCS
Data Forwarding to TiDB Cloud Lake
Manage Forwarding Rules
FAQ
Data Access
Regular Expressions
Regular Expressions
Template Library
Audit Events
Share Management
Cross-workspace Authorization
Field Display Permissions
Sensitive Data Scanning
Sensitive Data Scanning
Create scanning rules
Create scanning rules
Custom creation
Official rule library
Manage scanning rules
Labs
SSO Management
SSO Management
SAML
SAML
Configuration examples
Configuration examples
Alibaba Cloud IDaaS
Authing
Azure AD
IAM Identity Center
Okta
Keycloak
OIDC
Role mapping
FAQ
Support Center
Support Center
Status Page
Ticket Management
Cloud-billing
Cloud Billing
Agent
Agent
Application List
Application List
Create Agent Monitoring Application
obs-agent-connector Command Reference
Create LLM Monitoring Application
Explorer
Analysis Dashboard
Platform Capabilities
Platform Capabilities
Explorer
Explorer
Search
Filter
Time Widget
Dimension Analysis
Display Columns
Snapshot
Snapshot
Save Snapshot
Share Snapshot
AI
obsy
Obsy AI
Obsy AI
Obsy Copilot
Obsy Copilot
Observability Analysis
Data Query
Content Creation
Knowledge Services
plans & credits
agent-teams
Obsy Agent Teams
Obsy Agent Teams
Agent Management
Agent Management
Create an Agent
Agent Container Installation
Agent Forward Proxy
Agent Daily Operations
Skills
MCP Servers
Message Channels
Agent Collaboration (A2A)
My Tasks
Automation
Task Intake
Usage Statistics
Agent Version History
Obscli Manual
mcp server
OWL
OWL
OWL CLI
OWL CLI
Manual Installation
Automatic Installation
Quick Start
Tools Reference
Command Reference
OWL MCP Server
OWL MCP Server
Quick Start
Tools Reference
Troubleshooting
Changelog
Open Capabilities
Open API
Open API
Common Request Parameters
Common Response Structure
API Signature Authentication
Usage Limits
Request Example
OpenAPI SDK
Common Error Definitions
Scenarios
Scenarios
Dashboard
Dashboard
Create
List
Delete
Modify
Get
Export
Import
Set Extended Info
Dashboard Carousel
Dashboard Carousel
List
Get
Create
Modify
Delete
Notes
Notes
List
Get
Delete
Export
Import
Create
Modify
New Notes
New Notes
List
Get
Create
Modify
Delete
Explorer
Explorer
List
Get
Delete
Export
Create
Modify
Import
Built-in Views
Built-in Views
List
Get
Export
Create
Modify
Delete
Service Management
Service Management
List
Get
Create
Modify
Delete
Export
Service Performance
Service Performance
List
Get
Export
Events
Events
List Unrecovered Events
Get Event
Manual Recovery
Create Event
Incident
Incident
Channel
Channel
List
Create
Modify
Delete
Subscribe
Issue
Issue
List
Get
Create
Modify
List Replies
Create Reply
Modify Reply
Delete Reply
List Levels
Add Custom Level
Modify Custom Level
Delete Custom Level
Get Default Configuration Status
Modify Default Configuration Status
Upload Attachment
Delete Attachment
Download Attachment
Schedule
Schedule
List
Get
Create
Modify
Delete
Configuration Management
Configuration Management
Notification Policy
Notification Policy
List
Get
Create
Modify
Delete
Issue Discovery
Issue Discovery
Create Auto Discovery Configuration
Modify Auto Discovery Configuration
Get Auto Discovery Configuration
List Auto Discovery Configurations
Disable/Enable Auto Discovery Configuration
Delete Auto Discovery Configuration
Incident Center
Incident Center
Incident List
Incident List
Get Incident AI Auto-Analysis Configuration
Set Incident AI Auto-Analysis Configuration
List
Get
Create
Modify
List Comments
Create Comment
Modify Comment
List Operation Records
Upload Attachment
Delete Attachment
Download Attachment
On-Call
On-Call
List
Get
Create
Modify
Delete
Configuration Management
Configuration Management
List Levels
Add Custom Level
Modify Custom Level
Delete Custom Level
Get Default Configuration Status
Modify Default Configuration Status
Error Tracking
Error Tracking
Error Tracking
Error Tracking
List
Get
Update
List Operation Records
List Comments
Add Comment
Modify Comment
Error Tracking Rules
Error Tracking Rules
List
Get
Create
Modify
Disable/Enable
Delete
Infrastructure
Infrastructure
Infrastructure
Infrastructure
Get All Labels
Modify Host Labels
Resource Catalog
Resource Catalog
List
Create
Modify
Delete
Export
Unified Catalog
Unified Catalog
Entity List
Entity List
List Entities
Get Entity
Export Entities
Create Entity
Modify Entity
Delete Entity
Get Entity Field Value Count
List Entity Types
Get Entity Type
Create Entity Type
Modify Entity Type
Delete Entity Type
Topology
Topology
Get Entity Field Definitions
Get Filter Options
Query Topology
Logs
Logs
Pattern Query
Pattern Query
Get Query Task Result
Submit Query Task
Index
Index
List
Get Index Info
Export
Import
Create Default Index
Modify Default Index Configuration
Bind Index
Modify Bound Index Configuration
Enable/Disable Index Configuration
Delete Index
Data Forwarding
Data Forwarding
List
Get
Create
Modify
Delete
Create Query Task
Get Query Task Result
Data Access
Data Access
List
Get
Create
Create Single Rule
Modify
Modify Single Rule
Enable/Disable
Delete
Metrics
Metrics
Get Measurement Information
Get Measurement Information
Get Metric and Tag Information
List Measurements (with search)
Get Measurement Schema
Get Measurement Tags
Get Log Schema
Get Log Indexes
Get Log Index Tags
Get Non-Log Text Data Schema
Get Non-Log Text Data Tags
Generate Metrics
Generate Metrics
List
Create
Get
Modify
Disable/Enable
Delete
RUM
RUM
Applications
Applications
Quick List RUM Configurations
Add RUM Configuration
Modify RUM Configuration
Delete RUM Configuration
SourceMap
SourceMap
List
Delete
Initiate Multipart Upload
Upload Part
List Uploaded Parts
List File Tree
Merge Parts
Cancel Upload
Upload File Content
Synthetic Monitoring
Synthetic Monitoring
Synthetic Tests
Synthetic Tests
Create
Delete
Modify
Disable/Enable
Create Multistep Test
Modify Multistep Test
List
Get
List Official Nodes
Self-hosted Node Management
Self-hosted Node Management
List
Get
Delete
Create
Monitoring
Monitoring
Monitor
Monitor
Receive External Event Monitor Events
List
Get
Create
Export
Import
Modify
Replace Import
Delete
Enable/Disable
SLO
SLO
Create
Get
List
Batch Get Daily Availability
Modify
Delete
Batch Delete
Disable/Enable
Batch Disable/Enable
Intelligent Inspection
Intelligent Inspection
List
Get
Create
Modify
Disable
Enable
Delete
Batch Delete
Mute Configuration
Mute Configuration
List
Create
Modify
Disable
Enable
Delete
Alert Policy
Alert Policy
alert-policy
alert-policy
List
Create (deprecated on 2025-12-30, recommended to use v2 API)
Create v2
Get
Modify (deprecated on 2025-12-30, recommended to use v2 API)
Modify v2
Delete
Custom Notification Dates
Custom Notification Dates
List
Create
Get
Modify
Delete
Notification Targets
Notification Targets
List
Create
Get
Modify
Delete
Batch Delete
LLM Monitoring
LLM Monitoring
Applications
Applications
Quick List LLM Configurations
List LLM Configurations
Get LLM Configuration
Add LLM Configuration
Modify LLM Configuration
Delete LLM Configuration
Management
Management
Field Management
Field Management
List
Get
Create
Modify
Delete
Global Tags
Global Tags
List
Get
Create
Modify
Delete
Export
Import
Member Management
Member Management
workspace-member
workspace-member
List Members
Invite Members
Add Members (Deployment Plan)
Delete Members
Batch Enable/Disable Personal API Keys
Modify Members
Role Permissions
Role Permissions
List Permissions
Team Management
Team Management
List
Get
Delete
Create
Modify
SSO Management
SSO Management
sso (deprecated on 2026-05-31)
sso (deprecated on 2026-05-31)
Get SSO Configuration
List SSO Configurations
Create SSO Configuration
Update SSO Configuration
Delete SSO Configuration
List SSO Mappings
Create Mapping Rule
Modify Mapping Rule
Delete Mapping Rule
Enable/Disable Mapping Rule
sso
sso
Get SSO Configuration
List SSO Configurations
Create SSO Configuration
Update SSO Configuration
Delete SSO Configuration
Enable/Disable SSO Configuration
Mapping Rules
Mapping Rules
List Mapping Rules
Create Mapping Rule
Modify Mapping Rule
Delete Mapping Rule
Enable/Disable Mapping Rule
Custom Mapping Rules (Deployment Plan)
Custom Mapping Rules (Deployment Plan)
Add Mapping Configuration
Modify Mapping Configuration
List Custom Mapping Rules
Delete Custom Mapping Rule
Batch Delete Custom Mapping Rules
Role Management
Role Management
List
Get
Create
Modify
Delete
API Key Management
API Key Management
List
Get
Delete
Verify
Create
Rotate
Blacklist
Blacklist
List
Get
Create
Modify
Delete
Import
Export
Enable/Disable
Pipelines
Pipelines
List
Create
Get
Modify
Delete
Enable/Disable
Import
Export
Data Access
Data Access
List
Get
Create
Create Single Rule
Modify
Modify Single Rule
Delete
Disable/Enable
Sensitive Data Masking
Sensitive Data Masking
List
Get
Create
Modify
Enable/Disable
Delete
Workspace
Workspace
Create
Modify
Export Workspace Resources
Query Action Status
Import Workspace Resources
Cancel Task
Get Feature Menu
Set Feature Menu
Get Feature Menu v2
Set Feature Menu v2
Upload Logo Image
Set Workspace Custom Info
Get Role Sensitive Mask Fields
Test Sensitive Data Masking
List Sites
List Accessible Workspaces
Modify Data Retention Duration
Get Current Tenant Info
Get Current Workspace Info
List Same-Org Workspaces
Rotate Current Workspace Token
Workspace Custom Settings
Workspace Custom Settings
Get Index Key Fields
Modify Index Key Fields
Modify Index Acceleration Field Configuration
Attribute Claims
Attribute Claims
Get
Modify
Cross-Workspace Authorization
Cross-Workspace Authorization
List
Get
Add
Modify
Delete
Cross-Site Authorization
Cross-Site Authorization
Generate Cross-Site Authorization Meta
Import Cross-Site Authorization Meta
Account Management
Account Management
Modify Default Configuration Status
Snapshot Management
Snapshot Management
List
Create
Share
Delete
Cancel Share
DQL Query
DQL Query
DQL Asynchronous Query
DQL Query (Legacy)
DQL Query
SLS to DQL Conversion
Same-Org Trace Query
SLS Query Conversion
SLS Query Conversion
SLS to DQL Conversion
Func Functions
Func Functions
List
Execute External Function
Billing Analysis
Billing Analysis
Get Billing Summary
Get Billing Details
Get Account Balance
Offline Token
Offline Token
Generate Token (Legacy, deprecated on 2026-05-31)
Generate Auth Code
Revoke Token (Legacy, deprecated on 2026-05-31)
Revoke Auth Code
Chart Images
Chart Images
Get Time Series Trend Chart
DataFlux Func
DataFlux Func
DataFlux Func (Automata)
Cloud Account Management
Cloud Account Management
AWS
Alibaba Cloud
Huawei Cloud
Tencent Cloud
Azure
Script Market
Script Market
Basics
Cloud Synchronization Scripts
Cloud Synchronization Scripts
How to Enable
Script List
Script List
Alibaba Cloud
Alibaba Cloud
Cloud Monitor (Metrics)
AWS
AWS
Multiple Authentication Methods for AWS Client
CloudWatch (Metrics)
Huawei Cloud
Huawei Cloud
Cloud Monitor (Metrics)
Tencent Cloud
Tencent Cloud
Cloud Monitor (Metrics)
Azure
Azure
Azure Client Authorization
Azure Monitor (Metrics)
Volcengine
Volcengine
Cloud Monitor (Metrics)
Google Cloud
Google Cloud
GCP Client Authorization
Cloud Monitor (Metrics)
OBCloud
OBCloud
Cloud Monitor (Metrics)
FAQs
FAQs
Adding Extra Tags to Cloud Resource Data
Notes
Plans & Billing
ID
Storage & Billing Details
Storage & Billing Details
Data Storage Policy
Commercial Plan
Commercial Plan
Billing Logic
Billing Details
Enterprise Plan
FAQ
Payment-plan-and-bill
Plans & Billing
Plans & Billing
Payment Methods
Payment Methods
Billing Center Account Settlement
Alibaba Cloud Account Settlement
AWS Account Settlement
Huawei Cloud Account Settlement
FAQ
FAQ
Registration & Plans
Settlement & Billing
form_time备份
Billing Center
Billing Center
Glossary
Login Methods
Account Overview
Support Center
Billing Management
Account Management
Workspace Management
FAQ
Private Deployment
私有化部署
Private Deployment
Private Deployment
Release History
Release History
2025
2024
2023
2022
Private Deployment Version Description
Product Deployment
Product Deployment
Prerequisites for Deployment
How to Apply for a License
Infrastructure Deployment
Start Installation
Activate the Product
DataWay
DataWay
Version History
DataWay Installation and Usage
Data Forwarding
Data Aggregation and Sampling
Data Aggregation and Sampling
Aggregation
Sampling
Deployment Plans
Deployment Plans
Cloud Infrastructure Deployment
Cloud Infrastructure Deployment
Resource and System Requirements
Alibaba Cloud Deployment Guide
Huawei Cloud Deployment Guide
Self-hosted Infrastructure Deployment
Self-hosted Infrastructure Deployment
Self-hosted Infrastructure Deployment Guide
Resource and System Requirements
Infrastructure Deployment
Infrastructure Deployment
Proxy
NFS
Ingress-Nginx
Kubernetes Storage NFS
Kubernetes Storage OpenEBS
Kubernetes
MySQL
Log Engine
Doris
OpenSearch High Availability
GuanceDB Engine
Redis
Helm
Obtaining Application Images
Single-Node Environment Deployment
Single-Node Environment Deployment
Resource and System Requirements
Offline Deployment
Getting Started
Getting Started
How to Start
Upgrade to Commercial Plan
SSO Management
SSO Management
Keycloak Single Sign-On (Deployment Plan)
Configure Keycloak Single Sign-On Mapping Rules
Azure AD Single Sign-On (Deployment Plan)
Custom Mapping
LDAP Single Sign-On
OIDC Single Sign-On Custom Domain Replacement Steps (No Longer Recommended)
Custom OIDC Integration (Deployment Plan)
Admin Console Guide
Admin Console Guide
Workspace Management
User Management
Menu Management
Template Management
Field Management
Monitor Management
Settings Management
Operations Guide
Operations Guide
Deployment Configuration Guide
Deployment Configuration Guide
Application Service Configuration Reference
APM Service Topology Cross-Workspace Configuration
Enable Self-Observability
Change Domain Access to IP Access
Configure Email Service
Switch Domain
Switch Log Engine
Switch Time Series Engine
Switch Synthetic Testing Center
Change OpenSearch Disk Type on Huawei Cloud
Configure Data Forwarding
Update Templates in Offline Environment
Manage Workspace Index Configuration
Embed Pages via iframe
Guance Cluster Backup and Restore
Reliability Verification
Studio Self-Observability Configuration and Metrics Description
Customize Frontend Color Scheme
Customize Frontend Language
Reset Admin Password in Admin Console
Use Alibaba Cloud ECI for Auto Scaling kodo-x
Kodo-X Splitting
Switch to HTTPS Access
SMS Template Configuration Guide
Unified Catalog Topology View Configuration Guide
Operations FAQ
Operations FAQ
Kubernetes Cluster
Guance Foundation
Doris
GuanceDB
OpenSearch
Usage FAQ
Usage FAQ
Explorer Reports "View Template Not Found"
Insufficient Log Engine Storage
Monitor Troubleshooting
Data Gap Troubleshooting
DataWay List Empty in Integration
How to Handle Data Write Latency
Synthetic Monitoring Troubleshooting
DataWay Created but Not Visible in Frontend
Error Creating Synthetic Testing Node
Metric Query Error
Deployment Plan kodo Version Expired
Configure kodo-inner Query Concurrency
Upgrade Guance
Capacity Planning
Capacity Planning
Log Engine Capacity Planning
Extended Usage
Extended Usage
Metering Data Structure and Usage
Forwarding-rules
ExternalAPI
ExternalAPI
Public Request Parameters
Public Response Structure
Signature Authentication
Frontend Account
Frontend Account
List
Get
Create
Modify
Enable/Disable
Delete
Modify Brand Key
Management Backend Account
Management Backend Account
List
Create
Get
Modify
Enable/Disable
Delete
Workspace Members
Workspace Members
List
Add Members
Modify
Transfer Workspace Owner
Workspace
Workspace
List
Create
Get
Rotate Workspace Token
Modify
Batch Set Fault AI Auto-Analysis Configuration
Delete
Usage Limit Query
Update Usage Limit
Upload Workspace Image Related Resource
Get Image Related Resource
Custom Workspace Binding Information
Change Brand Key
Workspace - Query Index Information List
Workspace - Index Template Configuration
Workspace API Key
Workspace API Key
Create
Get
Modify
List
Delete
Batch Delete
Workspace Built-in API Key
Workspace Built-in API Key
Initialize and get
Modify
List
Batch delete
Role Management
Role Management
List
Issue
Issue
Get
Modify ISSUE
Group Management
Group Management
List
Create
Modify
Manage Workspace
Delete
Issue Level
Issue Level
Valid Level Lists
Template Management
Template Management
Template-List
Template-Get Template Details
Template-Import Custom System Template
Template-Delete Custom Template
Template-Batch Delete Custom Templates
Data Query
Data Query
DQL Query
Login Mapping Rules
Login Mapping Rules
Add Mapping Configuration
Modify Mapping Configuration
List Mapping Configurations
Delete Mapping Configuration
Set Switch Status
Get Switch Status
Scenario - Dashboard
Scenario - Dashboard
Identifier ID Import
APM
APM
APM Service List
service map
DataKit List
DataKit List
Online Datakit List
Other
mobilephone
Mobile
拓展说明
API Supplementary Notes
API Supplementary Notes
About Built-in Roles
Unrecovered Incident Query
Service Map Chart Interface
Unit Description
Lark SSO (OIDC) Configuration Guide
SourceMap Multipart Upload
Cross-workspace Authorization for Deployment Plan
Trace Query Across Workspaces in Same Organization
Data Security
Data Security
explain
Agreements
Agreements
International Site
International Site
Guance Commercial Plan Subscription Agreement
Legal Declaration
Data Security Confidentiality Agreement
Data Security Agreement
Guance Obsy AI Service Terms
Table of contents
Overview
Parameter Details
Response
Home
Open API
ping Service Test
¶
GET /api/v1/const/ping
Overview
¶
Parameter Details
¶
Response
¶
Feedback
Is this page helpful?
×