最近更新时间:2024.03.07 20:35:48
首次发布时间:2023.03.30 19:59:24
SASL 用户权限列表。
被以下接口引用:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
UserName | String | 是 | test | SASL 用户名称。 |
AccessPolicy | String | 是 | Sub | SASL 用户对于当前 Topic 的访问权限。
|
ACL 详细信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserName | String | test | 规则绑定的用户名。 |
Ip | String | 192.168.0.1/18 | 规则指定的 IP 地址或者网段。 |
ResourceType | String | Topic | 规则配置的资源类型。 |
PatternType | String | Literal | 规则配置的资源匹配方式。 |
Resource | String | test | 规则配置的 Topic 或者 Group 名称或前缀。 |
AccessPolicy | String | Read | 规则配置的访问策略。 |
白名单详细信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AllowListId | String | acl-fda2ed6365b94c909e44198fbbf48**** | 白名单 ID。 |
AllowListName | String | 测试 | 白名单名称。 |
AllowListDesc | String | 测试白名单 | 白名单描述。 |
AllowListIpNum | Integer | 2 | 白名单指定的 IP 地址或 IP 网段个数。 |
AssociatedInstanceNum | Integer | 3 | 白名单绑定的实例个数。 |
白名单绑定的实例信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | kafka-cnitzqgnk0g4**** | 白名单绑定的实例 ID。 |
InstanceName | String | 测试实例 | 白名单绑定的实例名称。 |
实例的基本信息,包括实例名称、ID 等信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
GroupId | String | testgroup | 消费组 ID。 |
State | String | Empty | 消费组状态。
|
Description | String | new | 消费组描述信息。 |
ProtocolType | String | consumer | 消费组指定的消费协议类型。
|
BalanceAlgorithm | String | range | 将消费的分区分配给消费者使用的算法,由消费客户端指定,若使用自定义分区的消费方式,该字段可能为空。 |
Tags | Array of TagObject | [{"Key":"keyA","Value":"valueA"}] | Group 的标签。 |
实例的基本信息,包括实例名称、ID等信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountId | String | 200000**** | 创建实例的火山引擎主账号 ID。 |
ChargeDetail | ChargeDetailObject | / | 实例的计费方式等计费信息。详细说明请参考 ChargeDetailObject。 |
ComputeSpec | String | kafka.60xrate.hw | Kafka 实例的计算规格。 |
CreateTime | String | 2022-07-18T07:48:58Z | 实例的创建时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。 |
EipId | String | eip-mjhulvqza6805smt1bnc**** | EIP 的 ID。 |
InstanceDescription | String | 这是一个测试实例 | 实例的简单描述。 |
InstanceId | String | kafka-cnngqkfgdudt**** | Kafka 实例 ID。 |
InstanceName | String | kafkainstance | Kafka实例名称。 |
InstanceStatus | String | Running | 实例状态。 |
PrivateDomainOnPublic | Boolean | false | 是否已开启公网解析功能。
|
ProjectName | String | newproject | 实例所属的 IAM 项目。如果实例不属于任何 IAM 项目,则不返回此参数。 |
RegionId | String | cn-beijing | 实例所在的地域 ID。 |
StorageSpace | Integer | 200 | 实例总存储空间。单位为 GiB。 |
StorageType | String | ESSD_PL0 | Kafka 实例数据存储的云盘类型。即 ESSD_FlexPL 或 ESSD_PL0。关于不同存储类型的详细性能说明,请参考云盘规格。 |
SubnetId | String | subnet-min6uy01kuf45smt1a2i**** | VPC 的子网 ID。 |
Tags | Map<String, String> | { | 已绑定的标签。 |
UsablePartitionNumber | Integer | 20 | 当前实例剩余可用分区数。 |
UsableGroupNumber | Integer | 100 | 当前实例剩余可用消费组数。 |
UsedGroupNumber | Integer | 20 | 当前实例已经创建的消费组(Group)个数。 |
UsedPartitionNumber | Integer | 120 | 当前实例已经使用的分区个数。 |
UsedStorageSpace | Integer | 100 | 实例已用储空间。单位为 GiB。 |
UsedTopicNumber | Integer | 20 | 当前实例已创建的 Topic 个数。 |
Version | String | 2.2.2 | 支持的 Kafka 版本。当前支持的版本包括:
|
VpcId | String | vpc-13fo9gkz6j6683n6nu5ec**** | 私有网络(VPC) ID。 |
ZoneId | String | cn-guangzhou-a | 实例所在的可用区 ID。对于跨 AZ 的高可用实例,此处会返回多个可用区 ID。 |
Topic 分区的基本信息,包括分区编号、Leader 编号等信息。
被以下接口引用:
参数 | 参数类型 | 示例值 | 说明 |
---|---|---|---|
PartitionId | Integer | 0 | 分区编号。 |
Leader | Integer | 2 | 分区 Leader 编号。 |
Replicas | Array of Integer | [2,0,1] | 分区的副本列表。 |
InsyncReplicas | Array of Integer | [2,0,1] | 分区的同步副本列表。 |
UnderInsyncReplicas | Array of Integer | [] | 不同步的副本列表。 |
StartOffset | Integer | 7758654122 | 分区 Leader 当前最早消息的偏移量。 |
EndOffset | Integer | 7774940552 | 分区 Leader 下一条消息的偏移量,当前最新消息的位置为 EndOffset - 1。 |
MessageCount | Integer | 16286430 | 分区 Leader 内当前的消息个数。其中,MessageCount=EndOffset-StartOffset。 |
符合查询条件的Topic列表。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CreateTime | String | 2023-03-06T12:47:44Z | Topic 的创建时间。 |
Description | String | newtopic | Topic 描述。 |
PartitionNumber | Integer | 12 | Topic 的分区数。 |
ReplicaNumber | Integer | 3 | Topic 的副本数。 |
Status | String | Running | Topic 的状态。 |
TopicName | String | my_topic | Topic 的名称。 |
Tags | Array of TagObject | [{"Key":"keyA","Value":"valueA"}] | Topic 的标签。 |
符合筛选条件的 Kafka SASL 用户列表。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AllAuthority | Boolean | true | 用户是否默认具备所有 Topic 的读写权限。
|
CreateTime | String | 2022-07-18T07:48:58Z | SASL 用户创建时间。 |
Description | String | PHP-sdk | SASL 用户描述。 |
PasswordType | String | Scram | SASL 用户类型。目前支持以下类型:
说明 用户类型对应不同的SASL认证机制,详细说明请参考查看接入点。 |
UserName | String | php-sdk | SASL 用户名称。 |
实例的计费信息,包括计费方式等信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ChargeType | String | PostPaid | 实例的计费类型。支持的类型包括:
|
ChargeStatus | String | Normal | 实例的计费状态。包括:
|
AutoRenew | Boolean | true | 包年包月实例到期后是否自动续费。
|
ChargeStartTime | String | 2022-07-18T07:48:58Z | 实例的开始计费时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。 |
ChargeExpireTime | String | 2022-07-18T07:48:58Z | 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。 |
OverdueTime | String | 2022-07-18T07:48:58Z | 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。 |
OverdueReclaimTime | String | 2022-07-18T07:48:58Z | 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。 |
PeriodUnit | String | Month | 包年包月类型实例的生命周期单位,即指定以月或以年为单位购买。其中:
|
Kafka实例的计费类型等计费信息。
被以下接口引用:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ChargeType | String | 是 | PostPaid | 实例的计费类型。支持的类型包括:
|
AutoRenew | Boolean | 否 | true | 包年包月实例到期后是否自动续费。
|
PeriodUnit | String | 否 | Month | 包年包月类型实例的生命周期单位,即指定以月或以年为单位购买。支持设置为:
仅包年包月类型的实例需要指定,即 ChargeType 指定为 PrePaid 时必选。 |
Period | Integer | 否 | 1 | 包年包月类型实例的购买时长。
仅包年包月类型的实例需要指定,即 ChargeType 指定为 PrePaid 时必选。 |
指定 Topic 的分区列表。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Accumulation | Integer | 15219375 | 消费组在分区上的消息堆积量。 |
ConsumedClient | String | consumer-1/192.168.xxx.xx | 分区消费者的信息,由客户端消费时指定,此处可能为空。 |
ConsumedOffset | Integer | 2662697877 | 分区消费进度。 |
EndOffset | Integer | 2677917252 | 分区下一条消息的偏移量。 |
PartitionId | Integer | 0 | Topic 分区编号。 |
StartOffset | Integer | 2661451497 | 分区最早的消息偏移量。 |
指定消费组订阅的 Topic 列表。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TopicName | String | test | Topic 名称。 |
Accumulation | Integer | 1804832 | 消费组在此 Topic 中的消息堆积总量。 |
实例的接入点列表。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
EndpointType | String | PLAINTEXT | 实例的接入点类型。关于接入点的详细说明请参考查看接入点。
|
NetworkType | String | PrivateNetwork | 接入点的网络类型。统一为 PrivateNetwork。 |
InternalEndpoint | String | kafka-cnng5ysg5vv9****.kafka.ivolces.com:9093 | 实例私网访问域名。 |
PublicEndpoint | String | kafka-cnng5ysg5vv9ps****.kafka.volces.com:9492 | 实例公网访问域名。实例未开启公网访问时,不提供公网访问域名。 |
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RegionId | String | cn-shanghai | 地域 ID。 |
RegionName | String | cn-shanghai | 地域名称。 |
Description | String | 华东2(上海) | 地域名称(中文)。 |
Status | String | Available | 地域状态。
您不可在停用的地域新开通服务,但不可新购此地域下的商品。已开通的服务依然提供支持,直至服务到期。 |
需要重置的消费位点信息。
被以下接口引用。
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
TopicName | String | 是 | my_topic | Topic 名称。 |
PartitionId | Integer | 否 | 3 | 需要重置消费位点的分区编号。
|
ResetType | String | 否 | Offset | 消费位点重置的方式,默认为 Offset。可设置为:
|
ResetOffset | Integer | 否 | -2 | 重置消费位点到指定Offset。仅在 ResetType 为 Offset 时需要设置。未指定此参数时,表示重置到最新的消息位置。
说明
|
ResetTimestamp | Integer | 否 | 1677502758825 | 重置消费位点到指定的时间点。时间戳格式,单位为毫秒。仅在 ResetType 为 Timestamp 时需要设置。
|
标签详情,用于筛选含有此标签的实例。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | owner | 标签的键。 |
Value | String | zhangsan | 标签的值。 |
标签详情。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | owner | 标签的键。 |
Value | String | zhangsan | 标签的值。 |
标签的详细信息。
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | rocketmq-cnai1f0c29ca**** | 实例 ID。 |
Key | String | key | 实例标签的键。 |
Value | String | value | 实例标签的值。 |
被以下接口引用:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-a | 可用区 ID。 |
ZoneName | String | cn-beijing-a | 可用区名称。 |
Description | String | 可用区A | 地域可用区中文名称。 |
Status | String | Normal | 可用区的状态,包含以下状态:
您不可在停用的可用区新开通服务,但不可新购此可用区下的商品。已开通的服务依然提供支持,直至服务到期。 |