You need to enable JavaScript to run this app.
导航
数据结构
最近更新时间:2024.06.05 15:29:11首次发布时间:2023.03.30 19:59:24

AccessPolicyObject

SASL 用户权限列表。
被以下接口引用:

  • CreateTopic
  • ModifyTopicAccessPolices
  • DescribeTopicAccessPolicies

名称

类型

是否必选

示例值

描述

UserName

String

test

SASL 用户名称。

AccessPolicy

String

Sub

SASL 用户对于当前 Topic 的访问权限。

  • PubSub:拥有发布、订阅权限。
  • Pub:拥有发布权限。
  • Sub:拥有订阅权限。

AclObject

ACL 详细信息。
被以下接口引用:

  • DescribeAcls

名称

类型

示例值

描述

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

规则配置的访问策略。

AllowListInfo

白名单详细信息。
被以下接口引用:

  • DescribeAllowLists

名称

类型

示例值

描述

AllowListId

String

acl-fda2ed6365b94c909e44198fbbf48****

白名单 ID。

AllowListName

String

测试

白名单名称。

AllowListDesc

String

测试白名单

白名单描述。

AllowListIpNum

Integer

2

白名单指定的 IP 地址或 IP 网段个数。

AssociatedInstanceNum

Integer

3

白名单绑定的实例个数。

AssociatedInstanceInfo

白名单绑定的实例信息。
被以下接口引用:

  • DescribeAllowListDetail

名称

类型

示例值

描述

InstanceId

String

kafka-cnitzqgnk0g4****

白名单绑定的实例 ID。

InstanceName

String

测试实例

白名单绑定的实例名称。

BasicGroupInfo

实例的基本信息,包括实例名称、ID 等信息。
被以下接口引用:

  • DescribeGroups

名称

类型

示例值

描述

GroupId

String

testgroup

消费组 ID。

State

String

Empty

消费组状态。

  • PreparingRebalance:消费准备
  • CompletingRebalance:分配分区中
  • Stable:消费中
  • Empty:未消费

Description

String

new

消费组描述信息。

ProtocolType

String

consumer

消费组指定的消费协议类型。

  • 如果使用标准 Kafka 的消费协议,则显示为 consumer。
  • 如果使用其他协议类型,则显示对应协议名称,例如 Kafka-Connector 接入时显示为 connect 类型。
  • 若使用自定义分区的消费方式,该字段可能为空。

BalanceAlgorithm

String

range

将消费的分区分配给消费者使用的算法,由消费客户端指定,若使用自定义分区的消费方式,该字段可能为空。

Tags

Array of TagObject

[{"Key":"keyA","Value":"valueA"}]

Group 的标签。

BasicInstanceInfoObject

实例的基本信息,包括实例名称、ID等信息。
被以下接口引用:

  • DescribeInstances
  • DescribeInstanceDetail

名称

类型

示例值

描述

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

是否已开启公网解析功能。

  • true:已开启
  • 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>

{
"mode": "http",
"tag-wzx": "11"
}

已绑定的标签。

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 版本。当前支持的版本包括:

  • 2.2.2:Kafka 2.2.2 版本。
  • 2.8.2:Kafka 2.8.2 版本。

VpcId

String

vpc-13fo9gkz6j6683n6nu5ec****

私有网络(VPC) ID。

ZoneId

String

cn-guangzhou-a

实例所在的可用区 ID。对于跨 AZ 的高可用实例,此处会返回多个可用区 ID。

BasicPartitionInfo

Topic 分区的基本信息,包括分区编号、Leader 编号等信息。
被以下接口引用:

  • DescribeTopicPartitions

参数

参数类型

示例值

说明

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。

BasicTopicInfoObject

符合查询条件的Topic列表。
被以下接口引用:

  • DescribeTopics

名称

类型

示例值

描述

CreateTime

String

2023-03-06T12:47:44Z

Topic 的创建时间。

Description

String

newtopic

Topic 描述。

LogRetentionHours

Integer

72

消息保留时长,单位小时。

PartitionNumber

Integer

12

Topic 的分区数。

ReplicaNumber

Integer

3

Topic 的副本数。

Status

String

Running

Topic 的状态。

TopicName

String

my_topic

Topic 的名称。

UsedStoragePercentageInInstance

Double

0.0039

当前 Topic 总数据量占实例总存储空间的比例,控制台页面显示为保留两位小数的百分数。

UsedStorageSpaceInBytes

Long

2521825280

当前 Topic 已使用的总存储空间大小。

Tags

Array of TagObject

[{"Key":"keyA","Value":"valueA"}]

Topic 的标签。

CleanupPolicy

Array of String

["delete","compact"]

Topic 的消息清理策略,支持以下三种取值方式:

  • ["delete"]:默认的消息清理策略。在磁盘容量充足的情况下,保留在最长保留时间范围内的消息;在磁盘容量不足时,将提前删除旧消息,以保证服务可用性。

    说明

    Kafka 实例默认的磁盘清理水位为 90%,具体以实际为准,详情请参见设置磁盘清理水位

  • ["compact"]:COMPACT 消息清理策略针对每个消息的 Key 进行整合,对于有相同 Key 的消息,只保留最新的 value 值,旧的记录则会被清除。
  • ["delete","compact"]:同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时,都将被清除。

BasicMessageInfoObject

符合查询条件的消息列表。
被以下接口引用:

  • QueryMessageByTimestamp

名称

类型

示例值

描述

TopicName

String

test-topic

Topic 名称。

PartitionId

Integer

0

消息所在分区。

MessageOffset

Integer

0

消息 Offset。

MessageSize

Integer

1024

消息大小,单位为(Byte)。

CreateTime

Integer

1717415105339

消息写入时间。

Key

String

test-key

消息 Key 字段。

Message

String

test-value

消息 Body 字段。

BasicUserInfoObject

符合筛选条件的 Kafka SASL 用户列表。
被以下接口引用:

  • DescribeUsers

名称

类型

示例值

描述

AllAuthority

Boolean

true

用户是否默认具备所有 Topic 的读写权限。

  • true:此用户具备所有 Topic 的读写权限。
  • false:此用户不具备所有 Topic 的读写权限。

CreateTime

String

2022-07-18T07:48:58Z

SASL 用户创建时间。

Description

String

PHP-sdk

SASL 用户描述。

PasswordType

String

Scram

SASL 用户类型。目前支持以下类型:

  • Plain
  • Scram

说明

用户类型对应不同的SASL认证机制,详细说明请参考查看接入点

UserName

String

php-sdk

SASL 用户名称。

ChargeDetailObject

实例的计费信息,包括计费方式等信息。
被以下接口引用:

  • DescribeInstances
  • DescribeInstanceDetail

名称

类型

示例值

描述

ChargeType

String

PostPaid

实例的计费类型。支持的类型包括:

  • PostPaid :按量付费
  • PrePaid:包年包月

ChargeStatus

String

Normal

实例的计费状态。包括:

  • Normal:正常
  • Overdue:按量计费欠费
  • Expired:包年包月到期

AutoRenew

Boolean

true

包年包月实例到期后是否自动续费。

  • true:自动续费。
  • false:不自动续费。到期后需要手动续费,否则实例将被关停。

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

包年包月类型实例的生命周期单位,即指定以月或以年为单位购买。其中:

  • Month:(默认)包月
  • Year:包年

ChargeInfoObject

Kafka实例的计费类型等计费信息。
被以下接口引用:

  • CreateInstance
  • ModifyInstanceChargeType

名称

类型

是否必选

示例值

描述

ChargeType

String

PostPaid

实例的计费类型。支持的类型包括:

  • PostPaid :按量付费
  • PrePaid:包年包月

AutoRenew

Boolean

true

包年包月实例到期后是否自动续费。

  • true:自动续费。
  • false:(默认)不自动续费。到期后需要手动续费,否则实例将被关停。

PeriodUnit

String

Month

包年包月类型实例的生命周期单位,即指定以月或以年为单位购买。支持设置为:

  • Month:包月
  • Year:包年

仅包年包月类型的实例需要指定,即 ChargeType 指定为 PrePaid 时必选。

Period

Integer

1

包年包月类型实例的购买时长。

  • PeriodUnit 指定为 Month 时,取值范围为 1~9。
  • PeriodUnit 指定为 Year时,取值范围为 1~3。

仅包年包月类型的实例需要指定,即 ChargeType 指定为 PrePaid 时必选。

ConsumedPartitionInfoObject

指定 Topic 的分区列表。
被以下接口引用:

  • DescribeConsumedPartitions

名称

类型

示例值

描述

Accumulation

Integer

15219375

消费组在分区上的消息堆积量。

ConsumedClient

String

consumer-1/192.168.xxx.xx

分区消费者的信息,由客户端消费时指定,此处可能为空。

ConsumedOffset

Integer

2662697877

分区消费进度。

EndOffset

Integer

2677917252

分区下一条消息的偏移量。

PartitionId

Integer

0

Topic 分区编号。

StartOffset

Integer

2661451497

分区最早的消息偏移量。

ConsumedTopicInfoObject

指定消费组订阅的 Topic 列表。
被以下接口引用:

  • DescribeConsumedTopics

名称

类型

示例值

描述

TopicName

String

test

Topic 名称。

Accumulation

Integer

1804832

消费组在此 Topic 中的消息堆积总量。

EndpointObject

实例的接入点列表。
被以下接口引用:

  • DescribeInstanceDetail

名称

类型

示例值

描述

EndpointType

String

PLAINTEXT

实例的接入点类型。关于接入点的详细说明请参考查看接入点
Kafka 实例提供的接入点类型包括:

  • PLAINTEXT:默认接入点。
  • SASL_PLAINTEXT:SASL_PLAINTEXT 接入点。
  • SASL_SSL:SASL_SSL 接入点。

NetworkType

String

PrivateNetwork

接入点的网络类型。统一为 PrivateNetwork。

InternalEndpoint

String

kafka-cnng5ysg5vv9****.kafka.ivolces.com:9093

实例私网访问域名。

PublicEndpoint

String

kafka-cnng5ysg5vv9ps****.kafka.volces.com:9492

实例公网访问域名。实例未开启公网访问时,不提供公网访问域名。

RegionObject

被以下接口引用:

  • DescribeRegions

名称

类型

示例值

描述

RegionId

String

cn-shanghai

地域 ID。

RegionName

String

cn-shanghai

地域名称。

Description

String

华东2(上海)

地域名称(中文)。

Status

String

Available

地域状态。

  • Available:启用。用户可在此地域下进行查看、新建资源等动作
  • Unavailable:停用。

您不可在停用的地域新开通服务,但不可新购此地域下的商品。已开通的服务依然提供支持,直至服务到期。

ResetOffsetInfoObject

需要重置的消费位点信息。
被以下接口引用。

  • ResetConsumedOffsets

参数

参数类型

是否必选

示例值

说明

TopicName

String

my_topic

Topic 名称。
当参数值指定为“*”时,表示重置 Group 消费的所有分区。

PartitionId

Integer

3

需要重置消费位点的分区编号。

  • 不指定 PartitionId 时,重置指定 Topic 下的所有分区。
  • 当 TopicName 指定为“*”时,不支持设置 PartitionId。

ResetType

String

Offset

消费位点重置的方式,默认为 Offset。可设置为:

  • Offset:(默认)根据指定 offset 重置消费位点,即 Group 在当前分区中从指定位点开始消费。此时默认重置到最新的 Offset,也可以通过参数 ResetOffset 指定 Offset。
  • Timestamp:根据指定时间重置消费位点,即从过去的某个指定时段内选择一个时间点开始消费。此时需要通过参数 ResetTimestamp 设置时间点。

ResetOffset

Integer

-2

重置消费位点到指定Offset。仅在 ResetType 为 Offset 时需要设置。未指定此参数时,表示重置到最新的消息位置。
取值范围:

  • -1:(默认)将消费位点重置到最新的一条消息。
  • -2:将消费位点重置到最早的一条消息。
  • 其他整型数值:指定重置消费位点到指定 Topic 的指定分区中某个具体的Offset位置,取值范围为分区的最小Offset和最大Offset之间,即[StartOffset,EndOffset]。

说明

  • 仅在指定 TopicName 和 PartitionId 时,可以将 ResetOffset 指定为其他整型数值。
  • 您可以通过DescribeTopicPartitions查看StartOffset和EndOffset。

ResetTimestamp

Integer

1677502758825

重置消费位点到指定的时间点。时间戳格式,单位为毫秒。仅在 ResetType 为 Timestamp 时需要设置。

  • 消费时间戳为消息存储到服务端的时间。
  • 可重置的时间点范围由 Topic 的消息保留时间决定,即此参数的取值范围为 [当前时间-实例消息保留时长, 当前时间]。
  • 若指定时间不存在消息,则会重置到最近的消息位置。

TagFilterObject

标签详情,用于筛选含有此标签的实例。
被以下接口引用:

  • DescribeTagsByResource
  • DescribeTopics
  • DescribeGroups

名称

类型

示例值

描述

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

TagObject

标签详情。
被以下接口引用:

  • AddTagsToResource
  • CreateTopic
  • CreateGroup

名称

类型

示例值

描述

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

TagResourceObject

标签的详细信息。
被以下接口引用:

  • DescribeTagsByResource

名称

类型

示例值

描述

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

Key

String

key

实例标签的键。

Value

String

value

实例标签的值。

ZoneObject

被以下接口引用:

  • DescribeAvailabilityZones

名称

类型

示例值

描述

ZoneId

String

cn-beijing-a

可用区 ID。

ZoneName

String

cn-beijing-a

可用区名称。

Description

String

可用区A

地域可用区中文名称。

Status

String

Normal

可用区的状态,包含以下状态:

  • Normal:在售。
  • Soldout:售罄。
  • Unavailable:停用。

您不可在停用的可用区新开通服务,但不可新购此可用区下的商品。已开通的服务依然提供支持,直至服务到期。