Torch Log Service
Torch Log Service
Torch Log Service
Document
Product News
Product Overview
Product Billing
User Guide
TLS Agent
AgentLoop
Resource management
Host group
Data collection
LogCollector collection
Introduction to LogCollector
Installation and upgrade
Collect host logs
Collect container logs
LogCollector plugins
Manage LogCollector
general reference
Data import
Cloud product log collection
TOS log collection
DBW log collection
VPN Log collection
VKE log collection
CLB log collection
CloudTrail log collection
CFW log collection
NTA log collection
ALB log collection
APMPlus log collection
veFaaS log collection
VPC log collection
veImageX log collection
TrafficRoute DNS log collection
DDoS log collection
WAF log collection
DCDN log collection
Multi-cloud security platform log collection
APIG log collection
Machine learning task log collection
CR log collection
Volcano Ark application lab log collection
FileNAS log collection
LLM Application Firewall Service log collection
vePFS log collection
Cloud security center log collection
EFS log collection
Data storage
Query and analysis
Configure log indexes
Query log
Analyze logs
Query and analyze logs using third-party tools
Associate external data source for log query
SQL function
SQL syntax
Visualization
Query and analysis charts
Summaries of query and analysis charts
Create dashboard
Use dashboard
Add dashboard filters and variables
Use other systems to analyze logs
Log application
Log applications for product observability
Log applications for large models observability
Coding Agent log app
ModelProvider log app
No-coding Agent log app
Log applications for basic service monitoring
Data processing
Data transformation
Syntax and functions
Global operation function
expression function
Data processing best practices
general reference
Data write processor
Data consumer processor
Data consumption and shipping
Ship logs to TOS
Ship logs to Kafka
Ship logs to Splunk
Alarm
Alarm policy
Alarm notification content
Alarm notification content template
alarm notification channel
Tracing service
Monitor Log Service
API reference
Project management API
Topic management API
Shard management API
Index management API
Log management API
Host group management API
Collection configuration management API
Data import API
Data processor API
Data transformation API
Data backflow API
SQL analysis API
Alarm management API
Consumer group management API
Kafka protocol consumption API
Tag management API
Trace storage API
Account management API
SDK reference
Go SDK
Java SDK
Python SDK
iOS SDK
C++ SDK
CLI reference
Best practices
Data collection
Query and analysis
permission management
Consumption and delivery
Visualization
Alarm
FAQs
Billing and cost FAQ
Data collection FAQ
Data storage FAQ
Index configuration FAQ
Query and analysis FAQ
Scheduled SQL tasks FAQ
Alarm FAQ
- Documentation
Torch Log ServiceAPI referenceAlarm management APIDescribeAlarmWebhookIntegrations
Copy page
Download PDFAlarm management API
DescribeAlarmWebhookIntegrations
Copy pageDownload PDFDescribeAlarmWebhookIntegrations
Call the DescribeAlarmWebhookIntegrations API to query the alarm Webhook integration configuration.
Notes
The call frequency limit for this interface is 20 times per second. If the frequency limit is exceeded, an ExceedQPSLimit error will be returned.
Note
- Request method: GET
- Request URL: https://{tls-endpoint}/DescribeAlarmWebhookIntegrations
Request parameters
The following table lists only the request parameters specific to this interface and some common parameters. For more information, see Public parameters.
Query
Parameter | Type | Required | Example value | Description |
Parameter | Type | Required | Example value | Description |
WebhookID | String | No | 1f4a9e21**** | Alert Webhook integration configuration ID. |
WebhookName | String | No | Feishu alert | Name of alert webhook integration configuration. |
WebhookType | String | No | Lark | Types of alert Webhook integration configurations. |
PageNumber | Integer | No | 1 | Page number for paginated queries. The default value is 1, which means data is returned starting from the first page. |
PageSize | Integer | No | 20 | Page size. The default value is 20, and the maximum is 100. |
Return parameters
The following table lists only the return parameters specific to this interface. For more information, see Return structure.
Parameter | Type | Example value | Description |
Parameter | Type | Example value | Description |
Total | Integer | 10 | Number of webhook integration configurations |
WebhookIntegrations | / | The webhook integration configuration list. |
WebhookIntegrationInfo
Parameter | Type | Example value | Description |
Parameter | Type | Example value | Description |
WebhookID | String | 1f4a9e21**** | Webhook integration configuration ID. |
CreateTime | String | 2024-04-09 20:25:35 | Creation time of the Webhook integration configuration. |
ModifyTime | String | 2024-04-09 20:35:35 | The most recent modification time of the webhook integration configuration. |
WebhookUrl | String | https://open.feishu.cn/open-apis/bot/v2/hook/**** | Webhook request address. |
WebhookName | String | Feishu alert | Webhook integration configuration names |
WebhookType | String | Lark | Webhook types. |
WebhookMethod | String | POST | Custom webhook request methods |
WebhookSecret | String | / | Webhook encryption key. |
WebhookHeaders | / | Custom Webhook request headers. |
GeneralWebhookHeaderKV
Parameter | Type | Example value | Description |
Parameter | Type | Example value | Description |
key | String | Content-Type | The key of a custom request header. |
value | String | application/json | Value of the custom request header. |
Request example
GET https://{tls-endpoint}/DescribeAlarmWebhookIntegrations?&WebhookID=&WebhookName=&WebhookType=&PageNumber=1&PageSize=20 HTTP/1.1
Content-Type: application/json
Return example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Total": 5,
"WebhookIntegrations": [
{
"WebhookID": "0721bde9****",
"WebhookName": "yyj-wei",
"WebhookType": "wechat",
"WebhookUrl": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-04-15 10:30:55",
"ModifyTime": "2024-04-15 10:30:55"
},
{
"WebhookID": "55f51384****",
"WebhookName": "yyj-ding",
"WebhookType": "dingtalk",
"WebhookUrl": "https://oapi.dingtalk.com/robot/send?access_token=xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-04-09 20:25:35",
"ModifyTime": "2024-04-09 20:25:35"
},
{
"WebhookID": "cf667c4c****",
"WebhookName": "aaa",
"WebhookType": "custom",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": "POST",
"WebhookHeaders": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"CreateTime": "2024-03-01 18:11:02",
"ModifyTime": "2024-03-01 18:11:02"
},
{
"WebhookID": "40959044****",
"WebhookName": "alarm-001",
"WebhookType": "lark",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-02-05 11:30:31",
"ModifyTime": "2024-02-05 11:30:31"
},
{
"WebhookID": "ca2eb341-fda5****",
"WebhookName": "yyj-test",
"WebhookType": "lark",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-02-05 11:30:09",
"ModifyTime": "2024-02-05 11:30:09"
}
]
}
Error codes
Last updated: 2025.10.28 18:42:04
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
