Tencent Cloud Observability Platform
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Application Performance Management
- Pay-as-you-go (Postpaid)
- Packages (Prepaid)
- Mobile App Performance Monitoring
- Real User Monitoring
- Cloud Automated Testing
- Prometheus Monitoring
- Pay-as-You-Go (Postpaid)
- Quick Start
- EventBridge
- Cloud Product Monitoring
- Tencent Cloud Service Metrics
- Microservice
- Networking
- TencentDB
- TencentDB for Redis Monitoring Metrics
- CPM
- CDN And EdgeOne
- Operation Guide
- Cloud Monitoring Overview
- Monitoring View
- CM Connection to Grafana
- Troubleshooting
- Application Performance Management
- Access Guide
- Accessing Go Application
- Accessing Java Application
- Accessing Python Application
- Accessing Node.js Application
- Accessing PHP Application
- Accessing .NET Application
- Operation Guide
- Resource Management
- Application Monitoring
- Application Diagnosis
- Database Call Monitoring
- Access Management
- Alarm Service
- System Configuration
- Associate Logs
- Inject TraceID Into Logs
- Practical Tutorial
- Parameter Information
- APM Data Protocol Standard
- Mobile App Performance Monitoring
- Access Guide
- Android Use Cases
- iOS Use Cases
- Tencent Cloud Real User Monitoring
- Operation Guide
- Application Management
- Access Management
- Resource Tag
- Connection Guide
- Web Use Cases
- Cloud Automated Testing
- Operation Guide
- Creating Test Task
- Testing Statistics
- Access Management
- References
- Testing Nodes
- FAQs
- Performance Testing Service
- Operation Guide
- Performance Testing in Script Mode
- Script Examples
- HTTP-based Performance Testing
- Performance Testing in JMeter Mode
- Project Management
- Scenario Management
- Advanced Configuration
- Export Stress Test Indicators
- Traffic Recording
- Performance Testing Report
- Access Control
- Alarm Management
- Tag Management
- Practice Tutorial
- JavaScript API List
- pts/http
- Response
- pts/dataset
- pts/grpc
- pts/jsonpath
- pts/redis
- pts/url
- URL
- pts/util
- pts/ws
- pts/socketio
- socketio
- pts/socket
- Prometheus Monitoring
- Product Introduction
- Access Guide
- EMR Integration
- Java Application Integration
- Exporter Integration
- Operation Guide
- Instance
- Recording Rule
- Alerting Rule
- Access Control
- TKE Metrics
- Practical Tutorial
- Terraform
- Grafana
- Operation Guide
- Instance
- Tencent Cloud Service Integration
- Plugin Management
- Dashboard
- Operation Guide
- Configuring Dashboard
- Monitoring Charts
- Creating Chart
- Use Cases of Different Chart Types
- Alarm Management
- Console Operation Guide
- Alarm Policy
- Configuring alert trigger conditions
- Alarm Notification
- Alarm Callback
- Alarm Receiving Channels and SMS Quota
- Dynamic Threshold Alarm
- Silencing Alarm
- EventBridge
- Product Introduction
- Practical Tutorial
- Migrating Event Alarm
- FAQs
- Related Agreements
- API Documentation
- Making API Requests
- Monitoring Data Query APIs
- Alarm APIs
- Notification Template APIs
- Legacy Alert APIs
- Prometheus Service APIs
- Grafana Service APIs
- Event Center APIs
- TencentCloud Managed Service for Prometheus APIs
- Monitoring APIs
DocumentationTencent Cloud Observability PlatformPrometheus MonitoringOperation GuideAPI GuideOverview
Overview
Last updated: 2024-08-07 22:06:58
HTTP API
All stable HTTP APIs of Prometheus are under the path
/api/v1. When you need to query monitoring data, you can request data through query APIs. To submit data, you can use the remote write protocol or Pushgateway.Supported APIs
API | Description | Authentication Required | Method |
/api/v1/query | Query | Yes | GET/POST |
/api/v1/query_range | Range query | Yes | GET/POST |
/api/v1/series | Series query | Yes | GET/POST |
/api/v1/labels | Labels query | Yes | GET/POST |
/api/v1/label/<label_name>/values | Label value query | Yes | GET |
/api/v1/prom/write | Data submission through remote write | Yes | remote write |
Pushgateway | Data submission through Pushgateway | Yes | SDK |
Authentication Method
Authentication is enabled by default, so all APIs require authentication, and all authentication methods support bearer token and basic authentication.
Bearer token
A bearer token is generated as an instance is generated and can be queried in the console. For more information on bearer token, please see Bearer Authentication.
Basic auth
Basic auth is compatible with the native Prometheus query authentication method. The username is your
APPID, and the password is the bearer token (generated when the instance is generated), which can be queried in the console. For more information on basic auth, please see Basic Authentication. Data Return Format
The response data of all APIs is in JSON format. Every successful request will return a status code of
2xx.An invalid request will return a piece of JSON data containing an error object and a status code as described below:
Status Code | Description |
401 | Authentication failed |
400 | A parameter was missing or incorrect |
422 | An invalid expression couldn't be specified (RFC4918) |
503 | The query was unavailable or canceled |
Below is a response template for invalid requests:
{"status": "success" | "error","data": <data>,// When the `status` is `error`, the following data will be returned"errorType": "<string>","error": "<string>",// When there is a warning message during request execution, this field will be filled and returned"warnings": ["<string>"]}
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No