数据结构

Name

String

必选

test

用户名称。

Permission

String

必选

Read

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

• Read：只读。
• Write：只写。
• ReadWrite：读写。

Operator

String

可选

Remove

添加或者删除 ACL 配置。

• Set：添加 ACL 权限配置。
• Remove：删除 ACL 权限配置。

ChargeType

String

PrePaid

实例的计费类型。

• PostPaid：按量计费。
• PrePaid：包年包月。

ChargeSubType

String

Monthly

包年包月实例的购买时指定的时长单位。

• Monthly：以月为单位购买。
• Yearly：以年为单位购买。

OverdueTime

Integer

0

包年包月实例过期时间。Unix 时间戳，单位为秒。

CreatedTime

Integer

0

实例创建时间。Unix 时间戳，单位为秒。

ChargeStatus

String

Normal

实例订单状态。

• Normal：正常收费中
• Unpaid：待付款
• Overdue：已过期
• Expired：已释放
• Reclaim：已回收

StopTime

Integer

0

实例关停时间。Unix 时间戳，单位为秒。

RecycleTime

Integer

0

实例过期回收时间。Unix 时间戳，单位为秒。

AutoReNew

Bool

true

是否自动续费。

• true：自动续费
• false：到期前需手动续费

OrderId

String

order-xxxxxxx

实例订单 ID。

ChargeType

String

必选

PostPaid

实例的计费类型。支持设置为：

• PostPaid：按量计费。
• PrePaid：包年包月。指定包年包月模式时，需要通过 ChargeSubType 和 ChargeUnitNum 参数指定购买的时长单位和数量，并通过AutoReNew参数指定是否自动续费。

ChargeSubType

String

必选

1

包年包月实例购买的时长单位。支持设置为：

• Monthly：以月为单位购买。
• Yearly：以年为单位购买。

ChargeUnitNum

Integer

必选

1

购买的时长数量。仅在计费类型为包年包月时有效，即 ChargeType 指定为 PrePaid。

AutoReNew

Bool

必选

10

是否自动续费，包年包月必传。

PartitionOfBuy

Integer

可选

900

Kafka 实例的分区数量，请根据业务需求合理设置分区数。
不同规格提供数量不同的免费分区额度，超过免费额度的部分将另外收取分区费用。每个规格可创建的分区数量范围请参考产品规格，分区的计费方式请参考计费项。

PartitionNumber

Integer

Topic 分区编号。

ConsumedClient

String

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

ConsumedOffset

Integer

分区消费进度。

StartOffset

Integer

分区最早的消息偏移量。

EndOffset

Integer

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

Accumulation

Integer

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

TopicName

String

Topic 名称。

Accumulation

Integer

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

ID

String

必选

cn-beijing-a

可用区 ID。

Value

String

必选

cn-beijing-a

可用区名称。

Desc

String

必选

华北2（北京）-可用区A

可用区描述信息。

IsSoldOut

Bool

可选

false

当前可用区下的资源是否已售罄。

EndpointType

String

实例访问的连接类型。

• Private：私有网络 VPC 访问。
• Internet：公网访问。

EndpointProtocol

String

实例访问的协议类型，包括：

• PLAINTEXT：默认接入点。
• SASL_PLAINTEXT：SASL 接入点。

AccessAddress

String

Kafka 实例的接入点。

InstanceId

String

kafka-****

实例ID。

InstanceName

String

kafka-test

实例名称。

Status

String

Running

实例状态。

AvaliableZones

List

实例所属的可用区信息。详细信息请参考 Zone。

UsedTopicNumber

Integer

20

当前实例已创建的 Topic 个数。

UsedGroupNumber

Integer

20

当前实例已经创建的消费组个数。

AccountId

Integer

0

实例所属的用户账号 ID。

CreateTime

String

2021-12-14 18:26:56

实例创建时间。格式为 “YYYY-MM-DDTHH:mm:ss+08:00”。

KafkaSpecification

String

kafka.n3.x2.small

实例购买的规格名称。

Description

String

这是一个测试实例

实例描述信息。

VpcInfo

VpcInfo

实例的网络访问信息。详细信息请参考 VPCInfo。

ProjectName

String

test

用户所属的项目名称。若无项目，则为空。

KafkaChargeInfo

BasicChargeInfo

实例的计费信息。详细信息请参考 BasicChargeInfo。

PartitionNum

Integer

必选

300

分区数量。

DiskIncStep

Integer

必选

100

磁盘增长步长，单位为 GiB。

DiskMinSize

Integer

必选

1500

最小磁盘容量，单位为 GiB。

DiskMaxSize

Integer

必选

30000

最大磁盘容量，单位为 GiB。

SpecName

String

必选

kafka.n3.x2.small

规格名称。

IsSoldOut

Map<String,Bool>

可选

{'cn-north-1-a:true'}

该规则在指定可用区是否已售罄。

ElasticIpNumber

Integer

可选

3

如果开启公网访问，此规格需要的弹性 IP（EIP）数量。

Name

String

max_message_length

参数名称。

DefaultValue

String

10

参数默认值。

RunningValue

String

5

参数运行值。

Description

String

kafka 实例最大可写入的消息长度

参数描述。

Restart

Bool

true

修改参数状态是否需要重启实例。

ParamType

String

int

参数的数据类型。

ValueRange

String

0-10

参数的取值范围，string 类型的参数暂不支持显示取值范围。

Unit

String

MB

参数的计量单位。

InstanceId

String

kafka-****

实例ID。

TopicName

String

test

Topic名称。

Partition

Integer

0

分区编号。

MessageOffset

Integer

0

消息在分区中的编号（偏移量）。

MessageSize

Integer

1024

消息大小，单位为（Byte）。

CreateTime

Integer

消息写入时间。

Key

String

消息 Key 字段。

Body

String

消息内容。为了避免特殊字符的影响，消息内容将会以 Base64 的编码的方式返回，需要通过 Base64 解码后才能查看。

Name

String

max_message_length

参数名称。

DefaultValue

String

10

参数默认值。

RunningValue

String

5

参数运行值。

Description

String

kafka实例最大可写入的消息长度

参数描述。

Restart

Bool

true

修改参数状态是否需要重启实例。

PType

String

int

参数的数据类型。

ValueRange

String

0-10

参数的取值范围，string 类型的参数暂不支持显示取值范围。

Unit

String

MB

参数的计量单位。

TopicName

String

必选

my_topic

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

PartitionNumber

Integer

可选

3

需要重置消费位点的分区编号。
当TopicName指定为“*”时，不支持设置 PartitionNumber。不指定PartitionNumber时重置指定T opic 下的所有分区。

ResetType

String

可选

Offset

消费位点重置的方式，可设置为：

• Offset：指定位点进行消费重置，未指定时，此为默认方式。
• Timestamp：指定时间进行消费重置。

ResetValue

Integer

可选

-2

消费位点重置的位置。

• 未指定此参数时，表示重置到最新的消息位置。
• 若 ResetType 设置为 Offset，ResetValue 用于指定消费位点，可设置为：
  • -2：将消费位点重置到最早的一条消息。
  • -1：将消费位点重置到最新的一条消息。
  • 自定义位置：取值不能大于分区 EndOffset，不能小于分区的 StartOffset。 在同时指定 TopicName 和 PartitionNumber 的情况才下支持自定义 Offset。
• 若 ResetType 设置为 Timestamp，ResetValue 用于指定消费时间戳，格式为 Unix 的时间戳，精确到秒。
  • 消费时间戳为消息存储到服务端的时间。
  • 取值最小为当前时间-实例消息保留时长，最大时间为当前时间
  • 若指定时间不存在消息，则会重置到最近的消息位置。

GroupId

String

消费组 ID。

InstanceId

String

实例 ID。

State

String

消费组状态。

• PreparingRebalance：消费准备
• CompletingRebalance：分配分区中
• Stable：消费中
• Empty：未消费
• Dead：已失效

UserName

String

SASL 用户名称。

CreateTime

String

SASL 用户的创建时间。

Description

String

SASL 用户描述信息。

AllAuthority

Bool

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

• true：具备。
• false：不具备。

PasswordType

String

密码类型。

• Plain：Plain 类型。
• Scram：Scram 类型。

Name

String

Topic 名称。

Description

String

Topic 描述。

InstanceId

String

实例 ID。

CreateTime

String

Topic 创建时间。

UpdateTime

String

Topic 更新时间。

PartitionNumber

Integer

分区个数。

Status

String

Topic 状态。

• Fault：异常
• Downgrade：降级
• ExpandPartition：分区扩容中
• ExpandReplica：副本扩容中
• Sync：同步中
• Running：正常运行中
• Creating：创建中

ReplicaNumber

Integer

Topic 副本个数。

MinInsyncReplicaNumber

Integer

Topic 最小同步副本数。

RetentionHour

Integer

消息被保留的时间。单位为小时。

MaxMessageMegabyte

Integer

最大消息大小。单位为 MB。

Region

String

Topic 所在地域。

PartitionNumber

Integer

分区编号。

Leader

Integer

分区 Leader 编号。

Replicas

List

分区的副本列表。

InsyncReplicas

List

分区的同步副本列表。

UnderInsyncReplicas

List

不同步的副本列表。

StartOffset

Integer

分区 Leader 当前最早消息的偏移量。

EndOffset

Integer

分区 Leader 下一条消息的偏移量。
此参数定义为下一条消息的偏移量，则当前最新消息的位置为 EndOffset - 1。

MessageCount

Integer

分区 Leader 内当前的消息个数。
EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。

Zone

JSON Array

必选

可用区信息。详细说明请参考 DataItem。

Name

String

必选

max_byte

参数名称。详细参数含义及说明请参考修改参数配置。支持设置的参数包括：

• MessageMaxByte：最大消息大小。
• LogRetentionHours：消息保留时长。
• OffsetRetentionMinutes：消费位点保留时长。
• LogAutoDeletion：自动删除旧消息。

RunningValue

String

必选

1

参数值。不同参数的取值范围不同：

• MessageMaxByte：单位为 MB，取值范围为 1～12。
• LogRetentionHours：单位为小时，取值范围为 0～2160，即消息最久保留 90天。
• OffsetRetentionMinutes：单位为分钟，取值范围为 1～10080，即消费位点最久保留7天。
• LogAutoDeletion：0 表示关闭，1 表示开启。

ID

String

必选

vpc-testtesttest

VPC ID。

Name

String

必选

kafka-test

VPC 名称。

SubnetId

String

必选

subnet-xxxxxxxxxx

VPC 子网 ID。

EipIds

List

可选

[eip-,eip-]

弹性网卡 ID，即 EIP ID。
调用接口 CreateKafkaInstance 创建实例时，暂不支持参数 EipIds。如果需要开启公网访问，请在创建实例后调用接口 EnableInternetAccess。

ZoneId

String

cn-beijing-a

可用区 ID。

ZoneIdInChinese

String

华北1-可用区A

可用区的中文名称。