tencentcloud-sdk-nodejs/tencentcloud/services/trocket/v20230308/trocket_models.d.ts

腾讯云 API NODEJS SDK

/**
 * 商品售卖信息
 */
export interface ProductSKU {
    /**
     * 产品类型，
  EXPERIMENT，体验版
  BASIC，基础版
  PRO，专业版
  PLATINUM，铂金版
     */
    InstanceType?: string;
    /**
     * 规格代码
     */
    SkuCode?: string;
    /**
     * TPS上限
     */
    TpsLimit?: number;
    /**
     * 弹性TPS上限
     */
    ScaledTpsLimit?: number;
    /**
     * 主题数量上限默认值
     */
    TopicNumLimit?: number;
    /**
     * 消费组数量上限
     */
    GroupNumLimit?: number;
    /**
     * 默认消息保留时间，小时为单位
     */
    DefaultRetention?: number;
    /**
     * 可调整消息保留时间上限，小时为单位
     */
    RetentionUpperLimit?: number;
    /**
     * 可调整消息保留时间下限，小时为单位
     */
    RetentionLowerLimit?: number;
    /**
     * 延时消息最大时长，小时为单位
     */
    MaxMessageDelay?: number;
    /**
     * 是否可购买
     */
    OnSale?: boolean;
    /**
     * 计费项信息
     */
    PriceTags?: Array<PriceTag>;
    /**
     * 主题数量上限默认最大值
     */
    TopicNumUpperLimit?: number;
}
/**
 * Topic&Group维度的权限配置
 */
export interface DetailedRolePerm {
    /**
     * 权限对应的资源
  可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
  可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    Resource: string;
    /**
     * 是否开启生产权限
     */
    PermWrite: boolean;
    /**
     * 是否开启消费权限
     */
    PermRead: boolean;
    /**
     * 授权资源类型（Topic:主题; Group:消费组）
     */
    ResourceType: string;
    /**
     * 资源备注
     */
    Remark?: string;
}
/**
 * DescribeProductSKUs请求参数结构体
 */
export type DescribeProductSKUsRequest = null;
/**
 * CreateMigrationTask请求参数结构体
 */
export interface CreateMigrationTaskRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 0 - 未指定（存量）
  1 - 元数据导入
     */
    Type: number;
    /**
     * 待导入的消费组列表
     */
    Topics?: Array<TopicItem>;
    /**
     * 待导入的消费组列表
     */
    Groups?: Array<ConsumeGroupItem>;
    /**
     * 待导入的角色列表
     */
    Roles?: Array<RoleItem>;
}
/**
 * ResetConsumerGroupOffset返回参数结构体
 */
export interface ResetConsumerGroupOffsetResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 路由规则版本
 */
export interface RouteRuleVersion {
    /**
     * <p>版本号</p>
     */
    Version?: number;
    /**
     * <p>切流时间戳</p><p>单位：毫秒（ms）</p>
     */
    CutTimestamp?: number;
    /**
     * <p>更新时间戳</p><p>单位：毫秒（ms）</p>
     */
    UpdatedAt?: number;
    /**
     * <p>路由规则列表</p>
     */
    Rules?: Array<RouteRule>;
}
/**
 * DescribeSmoothMigrationTaskList请求参数结构体
 */
export interface DescribeSmoothMigrationTaskListRequest {
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeConsumerRouteVersionList返回参数结构体
 */
export interface DescribeConsumerRouteVersionListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * <p>版本列表</p>
     */
    Versions?: Array<RouteRuleVersion>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeRoleList返回参数结构体
 */
export interface DescribeRoleListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 角色信息列表
     */
    Data?: Array<RoleItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateConsumerLabel返回参数结构体
 */
export interface CreateConsumerLabelResponse {
    /**
     * <p>实例 ID</p>
     */
    InstanceId?: string;
    /**
     * <p>消费组</p>
     */
    Group?: string;
    /**
     * <p>标签</p>
     */
    Label?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeConsumerRouteConfig请求参数结构体
 */
export interface DescribeConsumerRouteConfigRequest {
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * <p>消费组</p>
     */
    Group: string;
}
/**
 * CreateInstance返回参数结构体
 */
export interface CreateInstanceResponse {
    /**
     * 集群ID
     */
    InstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 源集群主题配置
 */
export interface SourceClusterTopicConfig {
    /**
     * 主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
     */
    TopicName: string;
    /**
     * 主题类型，
  5.x版本
  UNSPECIFIED 未指定
  NORMAL 普通消息
  FIFO 顺序消息
  DELAY 延迟消息
  TRANSACTION 事务消息
  
  4.x版本
  Normal 普通消息
  PartitionedOrder 分区顺序消息
  Transaction 事务消息
  DelayScheduled 延时消息
  
     */
    TopicType: string;
    /**
     * 队列数
     */
    QueueNum: number;
    /**
     * 备注信息
     */
    Remark?: string;
    /**
     * 是否已导入，作为入参时无效
     */
    Imported?: boolean;
    /**
     * 命名空间，仅4.x集群有效
     */
    Namespace?: string;
    /**
     * 导入状态，
  Unknown 未知，
  AlreadyExists 已存在，
  Success 成功，
  Failure 失败
  
  仅作为出参可用
     */
    ImportStatus?: string;
    /**
     * 4.x的命名空间，出参使用
     */
    NamespaceV4?: string;
    /**
     * 4.x的主题名，出参使用
     */
    TopicNameV4?: string;
    /**
     * 4.x的完整命名空间，出参使用
     */
    FullNamespaceV4?: string;
}
/**
 * 消费组信息
 */
export interface ConsumeGroupItem {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 消费组名称
     */
    ConsumerGroup?: string;
    /**
     * 是否开启消费
     */
    ConsumeEnable?: boolean;
    /**
     * 顺序投递：true
  并发投递：false
     */
    ConsumeMessageOrderly?: boolean;
    /**
     * 最大重试次数
     */
    MaxRetryTimes?: number;
    /**
     * 备注
     */
    Remark?: string;
    /**
     * 4.x的集群ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ClusterIdV4?: string;
    /**
     * 4.x的命名空间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NamespaceV4?: string;
    /**
     * 4.x的消费组名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ConsumerGroupV4?: string;
    /**
     * 4.x的完整命名空间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FullNamespaceV4?: string;
    /**
     * 订阅的主题个数
     */
    SubscribeTopicNum?: number;
    /**
     * 创建时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CreateTime?: number;
    /**
     * 绑定的标签列表
     */
    TagList?: Array<Tag>;
    /**
     * 重试策略
     */
    RetryPolicy?: RetryPolicy;
}
/**
 * 主题队列级别的消费详情
 */
export interface TopicStatsDetail {
    /**
     * <p>Broker节点名称</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BrokerName?: string;
    /**
     * <p>队列编号</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    QueueId?: number;
    /**
     * <p>生产消息位点</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BrokerOffset?: number;
    /**
     * <p>最新消费位点</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CommitOffset?: number;
    /**
     * <p>堆积总数</p><p>单位：条</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MessageCount?: number;
    /**
     * <p>最后消费时间</p><p>单位：毫秒</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LastUpdateTimestamp?: number;
}
/**
 * DescribeMessageList请求参数结构体
 */
export interface DescribeMessageListRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 要查询消息的开始时间，**Unix时间戳（毫秒）**
     */
    StartTime: number;
    /**
     * 要查询消息的结束时间，**Unix时间戳（毫秒）**
     */
    EndTime: number;
    /**
     * 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
     */
    TaskRequestId: string;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    ConsumerGroup?: string;
    /**
     * 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
     */
    MsgId?: string;
    /**
     * 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
     */
    MsgKey?: string;
    /**
     * 查询最近N条消息 最大不超过1024，默认-1为其他查询条件
     */
    RecentMessageNum?: number;
    /**
     * 是否查询死信消息，默认为false
     */
    QueryDeadLetterMessage?: boolean;
    /**
     * 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
     */
    Tag?: string;
    /**
     * 轻量主题
     */
    LiteTopic?: string;
}
/**
 * 重试策略
 */
export interface RetryPolicy {
    /**
     * 重试策略类型，枚举值如下：
  
  - EXPONENTIAL：固定间隔
  - CUSTOMIZED：阶梯退避
     */
    PolicyType: string;
    /**
     * 固定重试间隔，仅在重试策略为固定间隔时生效
     */
    RetryInterval?: number;
}
/**
 * ModifyInstance请求参数结构体
 */
export interface ModifyInstanceRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”
     */
    Name?: string;
    /**
     * 备注信息，最多 128 个字符
     */
    Remark?: string;
    /**
     * 消息发送和接收的比例
     */
    SendReceiveRatio?: number;
    /**
     * 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参获得。
     */
    SkuCode?: string;
    /**
     * 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
  
  - 默认值：DefaultRetention 参数
  - 最小值：RetentionLowerLimit 参数
  - 最大值：RetentionUpperLimit 参数
     */
    MessageRetention?: number;
    /**
     * 是否开启弹性TPS
     */
    ScaledTpsEnabled?: boolean;
    /**
     * 是否开启ACL
     */
    AclEnabled?: boolean;
    /**
     * 最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
  
  - 最小值和默认值：TopicNumLimit 参数
  - 最大值：TopicNumUpperLimit 参数
     */
    MaxTopicNum?: number;
    /**
     * 免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参中的 TopicNumLimit 参数。
     */
    ExtraTopicNum?: string;
    /**
     * 是否开启删除保护
     */
    EnableDeletionProtection?: boolean;
    /**
     * 部署可用区列表
     */
    ZoneIds?: Array<string>;
}
/**
 * 迁移任务信息
 */
export interface MigrationTaskItem {
    /**
     * 任务ID
     */
    TaskId?: string;
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 0 - 未指定（存量）
  1 - 元数据导入
     */
    Type?: number;
    /**
     * 主题总数
     */
    TopicNum?: number;
    /**
     * 消费组总数
     */
    GroupNum?: number;
    /**
     * 任务状态： 0，迁移中 1，迁移成功 2，迁移完成，只有部分数据完成迁移
     */
    Status?: number;
    /**
     * 创建时间
     */
    CreateTime?: number;
}
/**
 * 实例列表页中的实例信息
 */
export interface FusionInstanceItem {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 实例名称
     */
    InstanceName?: string;
    /**
     * 实例版本
     */
    Version?: string;
    /**
     * 实例类型，
  EXPERIMENT，体验版
  BASIC，基础版
  PRO，专业版
  PLATINUM，铂金版
     */
    InstanceType?: string;
    /**
     * 实例状态，
  RUNNING, 运行中
  MAINTAINING，维护中
  ABNORMAL，异常
  OVERDUE，欠费
  DESTROYED，已删除
  CREATING，创建中
  MODIFYING，变配中
  CREATE_FAILURE，创建失败
  MODIFY_FAILURE，变配失败
  DELETING，删除中
     */
    InstanceStatus?: string;
    /**
     * 实例主题数上限
     */
    TopicNumLimit?: number;
    /**
     * 实例消费组数量上限
     */
    GroupNumLimit?: number;
    /**
     * 计费模式，枚举值如下：
  
  - POSTPAID：按量计费
  
  - PREPAID：包年包月
     */
    PayMode?: string;
    /**
     * 到期时间，**Unix时间戳（毫秒）**
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ExpiryTime?: number;
    /**
     * 备注信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Remark?: string;
    /**
     * 主题数量
     */
    TopicNum?: number;
    /**
     * 消费组数量
     */
    GroupNum?: number;
    /**
     * 标签列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TagList?: Array<Tag>;
    /**
     * 商品规格
     */
    SkuCode?: string;
    /**
     * TPS限流值
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TpsLimit?: number;
    /**
     * 弹性TPS限流值
     */
    ScaledTpsLimit?: number;
    /**
     * 消息保留时间，小时为单位
     */
    MessageRetention?: number;
    /**
     * 延迟消息最大时长，小时为单位
     */
    MaxMessageDelay?: number;
    /**
     * 预付费集群是否自动续费，枚举值如下：
  
  - 0: 不自动续费
  - 1: 自动续费
     */
    RenewFlag?: number;
    /**
     * 4.x独有数据
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InstanceItemExtraInfo?: InstanceItemExtraInfo;
    /**
     * 预销毁时间，**Unix时间戳（毫秒）**
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DestroyTime?: number;
    /**
     * 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口返回中的 [ZoneInfo](https://cloud.tencent.com/document/api/1596/77932#ZoneInfo) 数据结构。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ZoneIds?: Array<number | bigint>;
    /**
     * 是否开启删除保护
     */
    EnableDeletionProtection?: boolean;
    /**
     * 实例创建时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CreateTime?: number;
    /**
     * 弹性TPS开关
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ScaledTpsEnabled?: boolean;
}
/**
 * 4.x集群和5.0集群列表统一显示 4.x特殊数据承载接口
 */
export interface InstanceItemExtraInfo {
    /**
     * 是否vip
  注意：此字段可能返回 null，表示取不到有效值。
     */
    IsVip?: boolean;
    /**
     * 4.x专享集群状态
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VipInstanceStatus?: number;
    /**
     * 专享集群峰值带宽
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MaxBandWidth?: number;
    /**
     * 专享集群规格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SpecName?: string;
    /**
     * 专享集群节点数量
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NodeCount?: number;
    /**
     * 专享集群最大存储
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MaxStorage?: number;
    /**
     * 专享集群最大保留时间，单位：小时
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MaxRetention?: number;
    /**
     * 专项集群最大保留时间，单位：小时
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MinRetention?: number;
    /**
     * 4.0共享集群状态
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InstanceStatus?: number;
    /**
     * 是否已冻结
     */
    IsFrozen?: boolean;
}
/**
 * DescribeConsumerGroup返回参数结构体
 */
export interface DescribeConsumerGroupResponse {
    /**
     * <p>在线消费者数量</p>
     */
    ConsumerNum?: number;
    /**
     * <p>TPS</p>
     */
    Tps?: number;
    /**
     * <p>消息堆积数量</p>
     */
    ConsumerLag?: number;
    /**
     * <p>消费类型，枚举值如下：</p><ul><li>PULL：PULL 消费类型</li><li>PUSH：PUSH 消费类型</li><li>POP：POP 消费类型</li></ul>
     */
    ConsumeType?: string;
    /**
     * <p>创建时间，<strong>Unix时间戳（毫秒）</strong></p>
     */
    CreatedTime?: number;
    /**
     * <p>顺序投递：true<br>并发投递：false</p>
     */
    ConsumeMessageOrderly?: boolean;
    /**
     * <p>是否开启消费</p>
     */
    ConsumeEnable?: boolean;
    /**
     * <p>最大重试次数</p>
     */
    MaxRetryTimes?: number;
    /**
     * <p>备注</p>
     */
    Remark?: string;
    /**
     * <p>消费模式：<br>BROADCASTING 广播模式<br>CLUSTERING 集群模式</p>
     */
    MessageModel?: string;
    /**
     * <p>重试策略</p>
     */
    RetryPolicy?: RetryPolicy;
    /**
     * <p>消费模式</p><p>枚举值：</p><ul><li>CLUSTERING： 集群/广播消费</li><li>LITE： LiteTopic消费</li></ul><p>默认值：CLUSTERING</p>
     */
    ConsumeModel?: string;
    /**
     * <p>订阅的轻量主题（仅适用于轻量消费模式）</p>
     */
    LiteTopic?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ImportSourceClusterConsumerGroups返回参数结构体
 */
export interface ImportSourceClusterConsumerGroupsResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteTopic请求参数结构体
 */
export interface DeleteTopicRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
}
/**
 * DescribeTopicStats请求参数结构体
 */
export interface DescribeTopicStatsRequest {
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * <p>消费组ID，可通过DescribeConsumerGroupList接口返回的ConsumerGroup字段或控制台查询</p>
     */
    GroupId: string;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
}
/**
 * 迁移中的主题
 */
export interface MigratingTopic {
    /**
     * 主题名称
     */
    TopicName?: string;
    /**
     * 迁移状态
  S_RW_D_NA 源集群读写，
  S_RW_D_R 源集群读写目标集群读，
  S_RW_D_RW 源集群读写目标集群读写，
  S_R_D_RW 源集群读目标集群读写，
  S_NA_D_RW 目标集群读写
     */
    MigrationStatus?: string;
    /**
     * 是否完成健康检查
     */
    HealthCheckPassed?: boolean;
    /**
     * 上次健康检查返回的错误信息，仅在HealthCheckPassed为false时有效。 NotChecked 未执行检查， Unknown 未知错误, TopicNotImported 主题未导入, TopicNotExistsInSourceCluster 主题在源集群中不存在, TopicNotExistsInTargetCluster 主题在目标集群中不存在, ConsumerConnectedOnTarget 目标集群上存在消费者连接, SourceTopicHasNewMessagesIn5Minutes 源集群主题前5分钟内有新消息写入, TargetTopicHasNewMessagesIn5Minutes 目标集群主题前5分钟内有新消息写入, SourceTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, TargetTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, ConsumerGroupCountNotMatch 订阅组数量不一致, SourceTopicHasUnconsumedMessages 源集群主题存在未消费消息,
     */
    HealthCheckError?: string;
    /**
     * 命名空间，仅4.x集群有效
     */
    Namespace?: string;
    /**
     * 4.x的命名空间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NamespaceV4?: string;
    /**
     * 4.x的主题名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TopicNameV4?: string;
    /**
     * 4.x的完整命名空间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FullNamespaceV4?: string;
    /**
     * 上次健康检查返回的错误列表
     */
    HealthCheckErrorList?: Array<string>;
}
/**
 * DescribeSmoothMigrationTaskList返回参数结构体
 */
export interface DescribeSmoothMigrationTaskListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 任务列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: Array<SmoothMigrationTaskItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigrationTaskList返回参数结构体
 */
export interface DescribeMigrationTaskListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 迁移任务列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Tasks?: Array<MigrationTaskItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * VPC信息
 */
export interface VpcInfo {
    /**
     * VPC ID
     */
    VpcId: string;
    /**
     * 子网ID
     */
    SubnetId: string;
}
/**
 * DeleteConsumerRouteConfig返回参数结构体
 */
export interface DeleteConsumerRouteConfigResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeRoleList请求参数结构体
 */
export interface DescribeRoleListRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeMigratingTopicStats返回参数结构体
 */
export interface DescribeMigratingTopicStatsResponse {
    /**
     * 源集群的消费者数量
     */
    SourceClusterConsumerCount?: number;
    /**
     * 目标集群的消费者数量
     */
    TargetClusterConsumerCount?: number;
    /**
     * 源集群消费组列表
     */
    SourceClusterConsumerGroups?: Array<string>;
    /**
     * 目标集群消费组列表
     */
    TargetClusterConsumerGroups?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ImportSourceClusterConsumerGroups请求参数结构体
 */
export interface ImportSourceClusterConsumerGroupsRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
    /**
     * 待导入的消费组列表
     */
    GroupList: Array<SourceClusterGroupConfig>;
}
/**
 * DescribeConsumerLag请求参数结构体
 */
export interface DescribeConsumerLagRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    ConsumerGroup?: string;
    /**
     * 命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口返回的 [RocketMQNamespace](https://cloud.tencent.com/document/api/1179/46089#RocketMQNamespace) 或控制台获得。
     */
    Namespace?: string;
    /**
     * 订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    SubscribeTopic?: string;
}
/**
 * SendMessage请求参数结构体
 */
export interface SendMessageRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 消息内容
     */
    MsgBody: string;
    /**
     * 消息Key
     */
    MsgKey?: string;
    /**
     * 消息Tag
     */
    MsgTag?: string;
    /**
     * 轻量主题
     */
    LiteTopic?: string;
}
/**
 * DescribeMigratingGroupStats请求参数结构体
 */
export interface DescribeMigratingGroupStatsRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
     */
    TaskId: string;
    /**
     * 消费组名称，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。
  
     */
    GroupName: string;
    /**
     * 命名空间，仅迁移至4.x集群有效，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。
     */
    Namespace?: string;
}
/**
 * 标签数据
 */
export interface Tag {
    /**
     * 标签名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TagKey: string;
    /**
     * 标签值
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TagValue: string;
}
/**
 * DescribeSourceClusterGroupList返回参数结构体
 */
export interface DescribeSourceClusterGroupListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 消费组配置列表
     */
    Groups?: Array<SourceClusterGroupConfig>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMessageList返回参数结构体
 */
export interface DescribeMessageListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 消息记录列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: Array<MessageItem>;
    /**
     * 一次查询ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskRequestId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteSmoothMigrationTask请求参数结构体
 */
export interface DeleteSmoothMigrationTaskRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
}
/**
 * DescribeInstanceList返回参数结构体
 */
export interface DescribeInstanceListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 实例列表
     */
    Data?: Array<InstanceItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeConsumerClientList返回参数结构体
 */
export interface DescribeConsumerClientListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 消费客户端
     */
    Data?: Array<ConsumerClient>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyInstance返回参数结构体
 */
export interface ModifyInstanceResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 消费组标签
 */
export interface ConsumerLabel {
    /**
     * <p>标签</p>
     */
    Label?: string;
    /**
     * <p>标签状态</p><p>枚举值：</p><ul><li>ACTIVE： 生效中</li><li>DELETING： 删除中</li><li>UNKNOWN： 未知</li></ul>
     */
    State?: string;
    /**
     * <p>更新时间</p><p>单位：毫秒(ms)</p>
     */
    UpdatedAt?: number;
}
/**
 * CreateConsumerGroup请求参数结构体
 */
export interface CreateConsumerGroupRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * <p>最大重试次数，取值范围0～1000</p>
     */
    MaxRetryTimes: number;
    /**
     * <p>是否开启消费</p>
     */
    ConsumeEnable: boolean;
    /**
     * <p>顺序投递：true<br>并发投递：false</p>
     */
    ConsumeMessageOrderly: boolean;
    /**
     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    ConsumerGroup?: string;
    /**
     * <p>备注信息，最多 128 个字符</p>
     */
    Remark?: string;
    /**
     * <p>标签列表</p>
     */
    TagList?: Array<Tag>;
    /**
     * <p>重试策略</p>
     */
    RetryPolicy?: RetryPolicy;
    /**
     * <p>轻量主题</p>
     */
    LiteTopic?: string;
}
/**
 * 客户端订阅详情，可用于辅助判断哪些客户端订阅关系不一致
 */
export interface ClientSubscriptionInfo {
    /**
     * 客户端ID
     */
    ClientId?: string;
    /**
     * 客户端地址
     */
    ClientAddr?: string;
    /**
     * 订阅主题
     */
    Topic?: string;
    /**
     * 订阅表达式
     */
    SubString?: string;
    /**
     * 订阅方式
     */
    ExpressionType?: string;
}
/**
 * ChangeMigratingTopicToNextStage返回参数结构体
 */
export interface ChangeMigratingTopicToNextStageResponse {
    /**
     * 迁移主题状态修改的结果列表
     */
    Results?: Array<TopicStageChangeResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSourceClusterGroupList请求参数结构体
 */
export interface DescribeSourceClusterGroupListRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台上获得。
  
     */
    TaskId: string;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeConsumerRouteConfig返回参数结构体
 */
export interface DescribeConsumerRouteConfigResponse {
    /**
     * <p>版本号</p>
     */
    Version?: number;
    /**
     * <p>路由规格</p>
     */
    Rules?: Array<RouteRule>;
    /**
     * <p>切流时间戳</p>
     */
    CutTimestamp?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigrationTaskList请求参数结构体
 */
export interface DescribeMigrationTaskListRequest {
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
}
/**
 * VerifyMessageConsumption返回参数结构体
 */
export interface VerifyMessageConsumptionResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyRole返回参数结构体
 */
export interface ModifyRoleResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 迁移主题修改状态后的结果
 */
export interface TopicStageChangeResult {
    /**
     * 主题名称
     */
    TopicName?: string;
    /**
     * 是否成功
     */
    Success?: boolean;
    /**
     * 命名空间，仅4.x有效
     */
    Namespace?: string;
}
/**
 * ImportSourceClusterTopics请求参数结构体
 */
export interface ImportSourceClusterTopicsRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
    /**
     * 待导入的主题列表
     */
    TopicList: Array<SourceClusterTopicConfig>;
}
/**
 * DescribeFusionInstanceList请求参数结构体
 */
export interface DescribeFusionInstanceListRequest {
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
    /**
     * 标签过滤器
     */
    TagFilters?: Array<TagFilter>;
}
/**
 * 消费组配置信息
 */
export interface SourceClusterGroupConfig {
    /**
     * 消费组名称，可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)数据中获取。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    GroupName: string;
    /**
     * 备注信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Remark?: string;
    /**
     * 是否已导入，作为入参时无效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Imported?: boolean;
    /**
     * 命名空间，仅4.x集群有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Namespace?: string;
    /**
     * 导入状态
  Unknown 未知
  Success 成功
  Failure 失败
  AlreadyExists 已存在
  
  仅作为出参时使用
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ImportStatus?: string;
    /**
     * 4.x的命名空间，出参使用
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NamespaceV4?: string;
    /**
     * 4.x的消费组名，出参使用
  注意：此字段可能返回 null，表示取不到有效值。
     */
    GroupNameV4?: string;
    /**
     * 4.x的完整命名空间，出参使用
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FullNamespaceV4?: string;
    /**
     * 是否为顺序投递，5.0有效
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ConsumeMessageOrderly?: boolean;
}
/**
 * DeleteInstance返回参数结构体
 */
export interface DeleteInstanceResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeTopic返回参数结构体
 */
export interface DescribeTopicResponse {
    /**
     * <p>实例ID</p>
     */
    InstanceId?: string;
    /**
     * <p>主题名称</p>
     */
    Topic?: string;
    /**
     * <p>主题类型<br>UNSPECIFIED:未指定,<br>NORMAL:普通消息,<br>FIFO:顺序消息,<br>DELAY:延时消息,<br>TRANSACTION:事务消息</p>
     */
    TopicType?: string;
    /**
     * <p>备注</p>
     */
    Remark?: string;
    /**
     * <p>创建时间，<strong>Unix时间戳（毫秒）</strong></p>
     */
    CreatedTime?: number;
    /**
     * <p>最后写入时间，<strong>Unix时间戳（毫秒）</strong></p>
     */
    LastUpdateTime?: number;
    /**
     * <p>订阅数量</p>
     */
    SubscriptionCount?: number;
    /**
     * <p>订阅关系列表</p>
     */
    SubscriptionData?: Array<SubscriptionData>;
    /**
     * <p>消息保留时长，单位：小时</p>
     */
    MsgTTL?: number;
    /**
     * <p>是否自动删除</p><p>仅适用于轻量主题</p>
     */
    AutoExpireDelete?: boolean;
    /**
     * <p>自动过期时间</p><p>单位：分钟</p><p>仅适用于轻量主题</p>
     */
    AutoExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 平滑迁移任务
 */
export interface SmoothMigrationTaskItem {
    /**
     * 任务ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId?: string;
    /**
     * 任务名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskName?: string;
    /**
     * 源集群名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SourceClusterName?: string;
    /**
     * 目标集群实例ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InstanceId?: string;
    /**
     * 网络连接类型，
  PUBLIC 公网
  VPC 私有网络
  OTHER 其他
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ConnectionType?: string;
    /**
     * 源集群NameServer地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SourceNameServer?: string;
    /**
     * 任务状态:
  Configuration 迁移配置,
  SourceConnecting 连接源集群中,
   MetaDataImport 元数据导入,
  EndpointSetup 切换接入点,
  ServiceMigration 切流中,
  Completed 已完成,
  Cancelled 已取消
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskStatus?: string;
    /**
     * 目标集群实例版本，
  4 表示4.x版本
  5 表示5.x版本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InstanceVersion?: string;
}
/**
 * ModifyRole请求参数结构体
 */
export interface ModifyRoleRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口中返回的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。
     */
    Role: string;
    /**
     * 是否开启消费
     */
    PermRead: boolean;
    /**
     * 是否开启生产
     */
    PermWrite: boolean;
    /**
     * 权限类型，默认按集群授权（Cluster：集群维度；TopicAndGroup：主题和消费组维度）
     */
    PermType?: string;
    /**
     * 备注
     */
    Remark?: string;
    /**
     * Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
     */
    DetailedPerms?: Array<DetailedRolePerm>;
}
/**
 * DescribeTopicStats返回参数结构体
 */
export interface DescribeTopicStatsResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * <p>队列级别的消费详情</p>
     */
    Data?: Array<TopicStatsDetail>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFusionInstanceList返回参数结构体
 */
export interface DescribeFusionInstanceListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 实例列表
     */
    Data?: Array<FusionInstanceItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateTopic请求参数结构体
 */
export interface CreateTopicRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 主题类型，枚举值如下：
  
  - NORMAL: 普通消息
  - FIFO: 顺序消息
  - DELAY: 延时消息
  - TRANSACTION: 事务消息
  - LITE: 轻量消息
     */
    TopicType: string;
    /**
     * 队列数量，取值范围3～16
     */
    QueueNum?: number;
    /**
     * 备注信息，最多 128 个字符
     */
    Remark?: string;
    /**
     * 消息保留时长（单位：小时）
     */
    MsgTTL?: number;
    /**
     * 标签列表
     */
    TagList?: Array<Tag>;
    /**
     * 是否过期自动删除（仅针对轻量主题类型）
     */
    AutoExpireDelete?: boolean;
    /**
     * 过期时间，单位：秒（仅针对轻量主题类型）
     */
    AutoExpireTime?: number;
}
/**
 * DescribeMessage请求参数结构体
 */
export interface DescribeMessageRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * <p>消息 ID，从 <a href="https://cloud.tencent.com/document/api/1493/114593">DescribeMessageList</a> 接口或业务日志中获得。</p>
     */
    MsgId: string;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * <p>是否是死信消息，默认为false</p>
     */
    QueryDeadLetterMessage?: boolean;
    /**
     * <p>是否是延时消息，默认为false</p>
     */
    QueryDelayMessage?: boolean;
}
/**
 * DeleteRole请求参数结构体
 */
export interface DeleteRoleRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口响应中的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。
     */
    Role: string;
}
/**
 * ResendDeadLetterMessage返回参数结构体
 */
export interface ResendDeadLetterMessageResponse {
    /**
     * 重发消息结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ResendResult?: boolean;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyConsumerGroup返回参数结构体
 */
export interface ModifyConsumerGroupResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigratingTopicStats请求参数结构体
 */
export interface DescribeMigratingTopicStatsRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
    /**
     * 主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
  
     */
    TopicName: string;
    /**
     * 命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
     */
    Namespace?: string;
}
/**
 * DeleteConsumerGroup请求参数结构体
 */
export interface DeleteConsumerGroupRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    ConsumerGroup?: string;
}
/**
 * CreateConsumerGroup返回参数结构体
 */
export interface CreateConsumerGroupResponse {
    /**
     * <p>集群ID</p>
     */
    InstanceId?: string;
    /**
     * <p>消费组名称</p>
     */
    ConsumerGroup?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RollbackMigratingTopicStage请求参数结构体
 */
export interface RollbackMigratingTopicStageRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
    /**
     * 主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
  
     */
    TopicName: string;
    /**
     * 命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
     */
    Namespace?: string;
}
/**
 * DescribeTopicListByGroup返回参数结构体
 */
export interface DescribeTopicListByGroupResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 主题列表
     */
    Data?: Array<SubscriptionData>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMessageTrace返回参数结构体
 */
export interface DescribeMessageTraceResponse {
    /**
     * <p>主题名称</p>
     */
    ShowTopicName?: string;
    /**
     * <p>轻量主题名称</p>
     */
    LiteTopic?: string;
    /**
     * <p>轨迹详情</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: Array<MessageTraceItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DoHealthCheckOnMigratingTopic请求参数结构体
 */
export interface DoHealthCheckOnMigratingTopicRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
  
     */
    TaskId: string;
    /**
     * 主题名称，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
  
     */
    TopicName: string;
    /**
     * 是否忽略当前检查
     */
    IgnoreCheck?: boolean;
    /**
     * 命名空间，仅迁移至4.x集群有效，可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
     */
    Namespace?: string;
}
/**
 * DescribeProducerList请求参数结构体
 */
export interface DescribeProducerListRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
}
/**
 * DescribeMigratingTopicList返回参数结构体
 */
export interface DescribeMigratingTopicListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 主题列表
     */
    MigrateTopics?: Array<MigratingTopic>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 实例列表页中的实例信息
 */
export interface InstanceItem {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 实例名称
     */
    InstanceName?: string;
    /**
     * 实例版本
     */
    Version?: string;
    /**
     * 实例类型，
  EXPERIMENT，体验版
  BASIC，基础版
  PRO，专业版
  PLATINUM，铂金版
     */
    InstanceType?: string;
    /**
     * 实例状态，
  RUNNING, 运行中
  MAINTAINING，维护中
  ABNORMAL，异常
  OVERDUE，欠费
  DESTROYED，已删除
  CREATING，创建中
  MODIFYING，变配中
  CREATE_FAILURE，创建失败
  MODIFY_FAILURE，变配失败
  DELETING，删除中
     */
    InstanceStatus?: string;
    /**
     * 实例主题数上限
     */
    TopicNumLimit?: number;
    /**
     * 实例消费组数量上限
     */
    GroupNumLimit?: number;
    /**
     * 计费模式，枚举值如下：
  
  - POSTPAID：按量计费
  
  - PREPAID：包年包月
     */
    PayMode?: string;
    /**
     * 到期时间戳，**Unix时间戳（毫秒）**
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ExpiryTime?: number;
    /**
     * 备注信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Remark?: string;
    /**
     * 主题数量
     */
    TopicNum?: number;
    /**
     * 消费组数量
     */
    GroupNum?: number;
    /**
     * 标签列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TagList?: Array<Tag>;
    /**
     * 商品规格
     */
    SkuCode?: string;
    /**
     * TPS限流值
     */
    TpsLimit?: number;
    /**
     * 弹性TPS限流值
     */
    ScaledTpsLimit?: number;
    /**
     * 消息保留时间，小时为单位
     */
    MessageRetention?: number;
    /**
     * 延迟消息最大时长，小时为单位
     */
    MaxMessageDelay?: number;
    /**
     * 是否自动续费，仅针对预付费集群（0: 不自动续费；1:自动续费）
     */
    RenewFlag?: number;
}
/**
 * VerifyMessageConsumption请求参数结构体
 */
export interface VerifyMessageConsumptionRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 消息ID
     */
    MsgId: string;
    /**
     * 客户端 ID，不指定该参数时消息将被发送到对应消费组内任意客户端
     */
    ClientId?: string;
    /**
     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
     */
    ConsumerGroup?: string;
}
/**
 * DescribeTopic请求参数结构体
 */
export interface DescribeTopicRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
     */
    Filters?: Array<Filter>;
    /**
     * 查询起始位置，默认为0。
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20。
     */
    Limit?: number;
}
/**
 * DescribeMessageTrace请求参数结构体
 */
export interface DescribeMessageTraceRequest {
    /**
     * 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
     */
    Topic: string;
    /**
     * <p>消息 ID，从 <a href="https://cloud.tencent.com/document/api/1493/114593">DescribeMessageList</a> 接口返回的 <a href="https://cloud.tencent.com/document/api/1493/96031#MessageItem">MessageItem</a> 或业务日志中获得。</p>
     */
    MsgId: string;
    /**
     * <p>是否是死信消息，默认为false</p>
     */
    QueryDeadLetterMessage?: boolean;
    /**
     * <p>是否是延时消息，默认为false</p>
     */
    QueryDelayMessage?: boolean;
}
/**
 * DeleteSmoothMigrationTask返回参数结构体
 */
export interface DeleteSmoothMigrationTaskResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateTopic返回参数结构体
 */
export interface CreateTopicResponse {
    /**
     * 集群ID
     */
    InstanceId?: string;
    /**
     * 主题名
     */
    Topic?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigratingGroupStats返回参数结构体
 */
export interface DescribeMigratingGroupStatsResponse {
    /**
     * 源集群消费组堆积
     */
    SourceConsumeLag?: number;
    /**
     * 目标集群消费组堆积
     */
    TargetConsumeLag?: number;
    /**
     * 源集群连接客户端列表
     */
    SourceConsumerClients?: Array<ConsumerClient>;
    /**
     * 目标集群连接客户端列表
     */
    TargetConsumerClients?: Array<ConsumerClient>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 主题消费进度
 */
export interface TopicConsumeStats {
    /**
     * 主题名称
     */
    Topic?: string;
    /**
     * 主题类型，枚举值如下：
  
  - UNSPECIFIED：未指定
  - NORMAL：普通消息
  - FIFO：顺序消息
  - DELAY：延时消息
  - TRANSACTION：事务消息
     */
    TopicType?: string;
    /**
     * 单节点主题队列数量
     */
    QueueNum?: number;
    /**
     * 消费堆积
     */
    ConsumerLag?: number;
    /**
     * 订阅规则，`*`表示订阅全部TAG
     */
    SubString?: string;
    /**
     * 最后消费进度更新时间，**Unix时间戳（毫秒）**
     */
    LastUpdateTime?: number;
}
/**
 * RemoveMigratingTopic请求参数结构体
 */
export interface RemoveMigratingTopicRequest {
    /**
     * 任务ID，可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
     */
    TaskId: string;
    /**
     * 主题名称，可在[DescribeMigratingTopicList