日志服务
日志服务
日志服务
文档指南
请输入
用户指南
TLS Agent
资源管理
数据采集
LogCollector 采集
LogCollector 简介
安装与升级（Linux）
安装与升级（Windows）
采集容器日志
LogCollector 插件
管理 LogCollector
云产品日志采集
TOS 日志采集
CDN 日志采集
DBW 日志采集
VPN 日志采集
VKE 日志采集
CLB 日志采集
CloudTrail 日志采集
CFW 日志采集
NTA 日志采集
ALB 日志采集
APMPlus 日志采集
veFaaS 日志采集
VPC 日志采集
veImageX 日志采集
TrafficRoute DNS 日志采集
DDos 日志采集
WAF 日志采集
DCDN 日志采集
多云安全平台日志采集
APIG 日志采集
机器学习任务日志采集
采集火山方舟应用实验室日志
CR 日志采集
FileNAS 日志采集
大模型应用防火墙日志采集
vePFS 日志采集
云安全中心日志采集
EFS 日志采集
检索分析
使用第三方工具检索分析日志
关联外部数据源检索分析日志
SQL 函数
可视化
日志应用
云产品观测日志应用
大模型观测日志应用
Coding Agent 日志应用
ModelProvider 日志应用
No-coding Agent 日志应用
Framework 日志应用
基础服务监控日志应用
数据处理
数据加工
消费与投递
告警
Trace 存储
API 参考
日志管理
机器组管理
采集配置管理
数据处理器
定时 SQL 分析
告警管理
消费组管理
Trace 存储
SDK 参考
Go SDK
Java SDK
Android SDK
Node.js SDK
CLI 参考
最佳实践
消费与投递
可视化
常见问题
数据采集常见问题
索引配置常见问题
- 文档首页
日志服务API 参考分区管理DescribeShards
复制全文
下载 pdfDescribeShards
文档反馈
问问助手调用 DescribeShards 接口获取日志主题的分区列表。
使用说明
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。
请求说明
- 请求方式：GET
- 请求地址：https://{tls-endpoint}/DescribeShards
请求参数
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
TopicId | String | 是 | 4a9bd4bd-53f1-43ff-b88a-64ee1be5**** | 日志主题 ID。 |
PageNumber | Integer | 否 | 1 | 分页查询时的页码。默认为 1，即从第一页数据开始返回。 |
PageSize | Integer | 否 | 10 | 分页大小。默认为 20，最大为 100。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 9 | Shard 总个数。 |
Shards | / | 日志主题信息组。 |
QueryResp
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Status | String | readwrite | 分区状态。
|
ShardId | Integer | 0 | 日志主题的分区 ID。 |
TopicId | String | 4a9bd4bd-53f1-43ff-b88a-64ee1be5**** | 日志主题的 ID。 |
ModifyTime | String | 2021-05-24 16:19:46 | 分区修改时间。 |
StopWriteTime | String | 2021-05-24 16:19:46 | 分区停止写入的时间，即此分区最后一次写入日志的时间。 |
ExclusiveEndKey | String | 7fffffffffffffffffffffffffffffff | 分区结束的 key 值。 |
InclusiveBeginKey | String | 00000000000000000000000000000000 | 分区起始的 key 值。 |
请求示例
GET https://{tls-endpoint}/DescribeShards?TopicId=1e***** HTTP/1.1
返回示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Total": 2,
"Shards": [
{
"TopicId": "b62********",
"ShardId": 0,
"InclusiveBeginKey": "00000000000000000000000000000000",
"ExclusiveEndKey": "7fffffffffffffffffffffffffffffff",
"Status": "readwrite",
"ModifyTime": "2021-08-12 16:56:18",
"StopWriteTime": "2021-08-12 16:56:18"
},
{
"TopicId": "b6*********",
"ShardId": 1,
"InclusiveBeginKey": "7fffffffffffffffffffffffffffffff",
"ExclusiveEndKey": "ffffffffffffffffffffffffffffffff",
"Status": "readwrite",
"ModifyTime": "2021-08-12 16:56:19",
"StopWriteTime": "2021-08-12 16:56:18"
}
]
}
错误码
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
404 | TopicNotExist | Topic does not exist. | 日志主题不存在。 |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |
最近更新时间：2025.10.14 14:20:20
这个页面对您有帮助吗？
有用
有用
无用
无用