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 referenceHost group management APIDescribeHosts
Copy page
Download PDFHost group management API
DescribeHosts
Copy pageDownload PDFDescribeHosts
Call the DescribeHosts interface to view the host list in the specified host group.
Usage notes
- This interface is used to view the host list in the specified host group. It supports pagination query, fuzzy query by host IP, and query by host heartbeat status.
- The call frequency limit is 20 times/s, and exceeding the frequency limit will report an error ExceedQPSLimit.
Request syntax
- Request Method: GET
- Request URL: https://{tls-endpoint}/DescribeHosts
Request parameters
The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.
Query
Name | Type | Required | Example | Description |
HostGroupId | String | True | 6622a14b-770f-4171-a385-3b68486f**** | The ID of the host group. |
Ip | String | False | 127.0.0.1 | The IP address of the host, used as a fuzzy query. |
HeartbeatStatus | Integer | False | 1 | The status of the host heartbeat. |
PageNumber | Integer | False | 1 | The page number when paging the query. The default is 1, that is, the return starts from the first page of data. |
PageSize | Integer | False | 20 | The page size. The default is 20, with a maximum of 100. |
Responses
The table below only lists the return parameters specific to this interface. For more information, please refer to the Response message.
Name | Type | Example | Description |
Total | Integer | 2 | The total number of the hosts. |
HostInfos | / | The hosts information. |
HostInfo
Name | Type | Example | Description |
Ip | String | 127.0.0.1 | The IP address of the host. |
HeartbeatStatus | Integer | 1 | The status of the host heartbeat.
|
LogCollectorVersion | String | 1.0.11 | The version of LogCollector installed on the host. |
Sample Request
GET https://{tls-endpoint}/DescribeHosts?HostGroupId=6622a14b-770f-4171-a385-3b68486f*****PageSize=20 HTTP/1.1
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"Total": 1,
"HostInfos": [
{
"Ip": "127.0.0.1",
"LogCollectorVersion": "logcollector-1.0.3",
"HeartbeatStatus": 0
}
]
}
Error code
The following table lists the error codes related to the interface and business logic. For common error codes, please refer to the Common error codes.
HTTP status code | Error code | Error message | Description |
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | The parameter is invalid. |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | Internal server error. |
Last updated: 2025.10.28 18:41:59
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
