You need to enable JavaScript to run this app.
导航

DescribeShards

最近更新时间2023.11.13 16:31:27

首次发布时间2022.05.11 11:26:48

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

使用说明

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

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeShards

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

TopicId

String

必选

4a*********

日志主题 ID。

PageNumber

Integer

可选

1

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Integer

可选

10

分页大小。默认为 20,最大为 100。

响应参数

参数
类型
示例值
描述

Total

Integer

9

Shard 总个数。

Shards

Array of QueryResp

/

日志主题信息组。详细信息请参考 QueryResp

示例

请求示例

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"
        }
    ]
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

TopicNotExist

404

Topic does not exist.

日志主题不存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码