You need to enable JavaScript to run this app.
导航
DescribeShards
最近更新时间:2024.04.19 13:54:12首次发布时间:2022.05.11 11:26:48

调用 DescribeShards 接口获取日志主题的分区列表。

使用说明

此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

请求说明

  • 请求方式:GET
  • 请求地址:https://tls-{Region}.ivolces.com/DescribeShards

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
TopicIdString4a9bd4bd-53f1-43ff-b88a-64ee1be5****日志主题 ID。
PageNumberInteger1分页查询时的页码。默认为 1,即从第一页数据开始返回。
PageSizeInteger10分页大小。默认为 20,最大为 100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述
TotalInteger9Shard 总个数。
ShardsArray of QueryResp/日志主题信息组。

QueryResp

参数类型示例值描述

Status

String

readwrite

分区状态。

  • readwrite:读写。
  • readonly:只读。
ShardIdInteger0日志主题的分区 ID。
TopicIdString4a9bd4bd-53f1-43ff-b88a-64ee1be5****日志主题的 ID。
ModifyTimeString2021-05-24 16:19:46分区修改时间。
StopWriteTimeString2021-05-24 16:19:46分区停止写入的时间,即此分区最后一次写入日志的时间。
ExclusiveEndKeyString7fffffffffffffffffffffffffffffff分区结束的 key 值。
InclusiveBeginKeyString00000000000000000000000000000000分区起始的 key 值。

请求示例

GET https://tls-{Region}.ivolces.com/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 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
404TopicNotExistTopic does not exist.日志主题不存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。