tencentcloud-sdk-nodejs
Version:
2,634 lines (2,631 loc) • 308 kB
TypeScript
/**
* RocketMQ命名空间信息
*/
export interface RocketMQNamespace {
/**
* 命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_”
*/
NamespaceId?: string;
/**
* 已废弃，未消费消息的保留时间，以毫秒单位，范围60秒到15天
*/
Ttl?: number;
/**
* 消息持久化后保留的时间，以毫秒单位
*/
RetentionTime?: number;
/**
* 说明
注意：此字段可能返回 null，表示取不到有效值。
*/
Remark?: string;
/**
* 公网接入点地址
注意：此字段可能返回 null，表示取不到有效值。
*/
PublicEndpoint?: string;
/**
* VPC接入点地址
注意：此字段可能返回 null，表示取不到有效值。
*/
VpcEndpoint?: string;
/**
* 内部接入点地址
注意：此字段可能返回 null，表示取不到有效值。
*/
InternalEndpoint?: string;
}
/**
* CreateRabbitMQBinding返回参数结构体
*/
export interface CreateRabbitMQBindingResponse {
/**
* 实例 ID
*/
InstanceId?: string;
/**
* vhost名称
*/
VirtualHost?: string;
/**
* 路由关系Id
*/
BindingId?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRocketMQInstanceSpec请求参数结构体
*/
export interface ModifyRocketMQInstanceSpecRequest {
/**
* <p>专享实例ID</p>
*/
InstanceId: string;
/**
* <p>实例规格，<br>rocket-vip-basic-1 基础型<br>rocket-vip-basic-2 标准型<br>rocket-vip-basic-3 高阶Ⅰ型<br>rocket-vip-basic-4 高阶Ⅱ型</p>
*/
Specification?: string;
/**
* <p>节点数量</p>
*/
NodeCount?: number;
/**
* <p>存储空间，GB为单位</p>
*/
StorageSize?: number;
/**
* <p>部署可用区列表</p>
*/
ZoneIds?: Array<string>;
}
/**
* DeleteCluster返回参数结构体
*/
export interface DeleteClusterResponse {
/**
* 集群的ID
*/
ClusterId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCmqTopic请求参数结构体
*/
export interface CreateCmqTopicRequest {
/**
* 主题名字，在单个地域同一账号下唯一。主题名称只能包含字母、数字、“-”及“_”，最大64字符，创建后不能修改，不区分大小写。
*/
TopicName: string;
/**
* 消息最大长度。取值范围 1024-65536 Byte（即1-64K），默认值 65536。
*/
MaxMsgSize?: number;
/**
* 用于指定主题的消息匹配策略。1：表示标签匹配策略；2：表示路由匹配策略，默认值为标签匹配策略。
*/
FilterType?: number;
/**
* 消息保存时间。取值范围60 - 86400 s（即1分钟 - 1天），默认值86400。
*/
MsgRetentionSeconds?: number;
/**
* 是否开启消息轨迹标识，true表示开启，false表示不开启，不填表示不开启。
*/
Trace?: boolean;
/**
* 标签数组
*/
Tags?: Array<Tag>;
}
/**
* ModifyRabbitMQVipInstance请求参数结构体
*/
export interface ModifyRabbitMQVipInstanceRequest {
/**
* 实例Id
*/
InstanceId: string;
/**
* 集群名称，不填则不修改。非空字符串时必须 3-64 个字符，只能包含数字、字母、“-”和“_”
*/
ClusterName?: string;
/**
* 备注，不填则不修改
*/
Remark?: string;
/**
* 是否开启删除保护，不填则不修改
*/
EnableDeletionProtection?: boolean;
/**
* 是否删除所有标签，默认为false
*/
RemoveAllTags?: boolean;
/**
* 修改实例的标签信息，全量标签信息，非增量
*/
Tags?: Array<Tag>;
/**
* 是否开启集群风险提示
*/
EnableRiskWarning?: boolean;
}
/**
* RocketMQ专享实例信息
*/
export interface RocketMQVipInstance {
/**
* <p>实例id</p>
*/
InstanceId?: string;
/**
* <p>实例名称</p>
*/
InstanceName?: string;
/**
* <p>实例版本</p>
*/
InstanceVersion?: string;
/**
* <p>实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败</p>
*/
Status?: number;
/**
* <p>节点数量</p>
*/
NodeCount?: number;
/**
* <p>实例配置规格名称</p>
*/
ConfigDisplay?: string;
/**
* <p>峰值TPS</p>
*/
MaxTps?: number;
/**
* <p>峰值带宽，Mbps为单位</p>
*/
MaxBandWidth?: number;
/**
* <p>存储容量，GB为单位</p>
*/
MaxStorage?: number;
/**
* <p>实例到期时间，毫秒为单位</p>
*/
ExpireTime?: number;
/**
* <p>自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置)</p>
*/
AutoRenewFlag?: number;
/**
* <p>0-后付费，1-预付费</p>
*/
PayMode?: number;
/**
* <p>备注信息</p>
*/
Remark?: string;
/**
* <p>实例规格</p><p>枚举值：</p><ul><li>rocket-vip-basic-0： 通用集群</li><li>rocket-vip-basic-1： 专享集群-基础型</li><li>rocket-vip-basic-2： 专享集群-标准型</li><li>rocket-vip-basic-3： 专享集群-高阶I型</li><li>rocket-vip-basic-4： 专享集群-高阶II型</li></ul>
*/
SpecName?: string;
/**
* <p>最大可设置消息保留时间，小时为单位</p>
*/
MaxRetention?: number;
/**
* <p>最小可设置消息保留时间，小时为单位</p>
*/
MinRetention?: number;
/**
* <p>实例消息保留时间，小时为单位</p>
*/
Retention?: number;
/**
* <p>是否开启ACL鉴权</p>
*/
AclEnabled?: boolean;
/**
* <p>销毁时间</p>
*/
DestroyTime?: number;
}
/**
* DescribeCmqQueues返回参数结构体
*/
export interface DescribeCmqQueuesResponse {
/**
* 数量
*/
TotalCount?: number;
/**
* 队列列表
*/
QueueList?: Array<CmqQueue>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAllTenants返回参数结构体
*/
export interface DescribeAllTenantsResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 虚拟集群列表
*/
Tenants?: Array<InternalTenant>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 消费者详情中的主题信息
*/
export interface RocketMQConsumerTopic {
/**
* 主题名称
*/
Topic?: string;
/**
* 主题类型，Normal表示普通，GlobalOrder表示全局顺序，PartitionedOrder表示局部顺序，Transaction表示事务，Retry表示重试，DeadLetter表示死信
*/
Type?: string;
/**
* 分区数
*/
PartitionNum?: number;
/**
* 消息堆积数
*/
Accumulative?: number;
/**
* 最后消费时间，以毫秒为单位
*/
LastConsumptionTime?: number;
/**
* 订阅规则
注意：此字段可能返回 null，表示取不到有效值。
*/
SubRule?: string;
}
/**
* DescribeRabbitMQNodeList请求参数结构体
*/
export interface DescribeRabbitMQNodeListRequest {
/**
* 实例 ID，形如amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。
*/
InstanceId: string;
/**
* 偏移量，默认值 0
*/
Offset?: number;
/**
* 一页限制，默认值 20
*/
Limit?: number;
/**
* 模糊搜索节点名字
*/
NodeName?: string;
/**
* 过滤参数的名字和数值，当前仅支持根据节点状态筛选。
"Name": "nodeStatus"
"Value": running or down
*/
Filters?: Array<Filter>;
/**
* 按指定元素排序，现在只有2个
cpuUsage：节点CPU利用率
diskUsage：节点磁盘利用率
*/
SortElement?: string;
/**
* 升序/降序
ascend/descend
*/
SortOrder?: string;
}
/**
* DeleteCmqQueue返回参数结构体
*/
export interface DeleteCmqQueueResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 消费详情
*/
export interface ConsumerStats {
/**
* 主题名
注意：此字段可能返回 null，表示取不到有效值。
*/
TopicName?: string;
/**
* 所属Broker
注意：此字段可能返回 null，表示取不到有效值。
*/
BrokerName?: string;
/**
* 队列编号
注意：此字段可能返回 null，表示取不到有效值。
*/
QueueId?: number;
/**
* 消费者ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ConsumerClientId?: string;
/**
* 消费位点
注意：此字段可能返回 null，表示取不到有效值。
*/
ConsumerOffset?: number;
/**
* 服务端位点
注意：此字段可能返回 null，表示取不到有效值。
*/
BrokerOffset?: number;
/**
* 消息堆积条数
注意：此字段可能返回 null，表示取不到有效值。
*/
DiffTotal?: number;
/**
* 最近消费时间
注意：此字段可能返回 null，表示取不到有效值。
*/
LastTimestamp?: number;
}
/**
* DescribeRocketMQEnvironmentRoles请求参数结构体
*/
export interface DescribeRocketMQEnvironmentRolesRequest {
/**
* 必填字段，RocketMQ集群的ID
*/
ClusterId: string;
/**
* 命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
EnvironmentId?: string;
/**
* 起始下标，不填默认为0。
*/
Offset?: number;
/**
* 返回数量，不填则默认为10，最大值为20。
*/
Limit?: number;
/**
* 角色名称
*/
RoleName?: string;
/**
* RoleName按照角色名进行过滤，精确查询。类型：String必选：否
*/
Filters?: Array<Filter>;
}
/**
* DeleteRocketMQGroup请求参数结构体
*/
export interface DeleteRocketMQGroupRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
NamespaceId: string;
/**
* 消费组名称
*/
GroupId: string;
}
/**
* RocketMQ消费组信息
*/
export interface RocketMQGroup {
/**
* 消费组名称
*/
Name?: string;
/**
* 在线消费者数量
*/
ConsumerNum?: number;
/**
* 消费TPS
* @deprecated
*/
TPS?: number;
/**
* 总堆积数量
* @deprecated
*/
TotalAccumulative?: number;
/**
* 0表示集群消费模式，1表示广播消费模式，-1表示未知
*/
ConsumptionMode?: number;
/**
* 是否允许消费
*/
ReadEnabled?: boolean;
/**
* 重试队列分区数
注意：此字段可能返回 null，表示取不到有效值。
*/
RetryPartitionNum?: number;
/**
* 创建时间，以毫秒为单位
*/
CreateTime?: number;
/**
* 修改时间，以毫秒为单位
*/
UpdateTime?: number;
/**
* 客户端协议
*/
ClientProtocol?: string;
/**
* 说明信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Remark?: string;
/**
* 消费者类型，枚举值ACTIVELY, PASSIVELY
注意：此字段可能返回 null，表示取不到有效值。
*/
ConsumerType?: string;
/**
* 是否开启广播消费
*/
BroadcastEnabled?: boolean;
/**
* Group类型
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupType?: string;
/**
* 重试次数
注意：此字段可能返回 null，表示取不到有效值。
*/
RetryMaxTimes?: number;
/**
* 实例ID
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceId?: string;
/**
* 命名空间
注意：此字段可能返回 null，表示取不到有效值。
*/
Namespace?: string;
/**
* 订阅的主题个数
*/
SubscribeTopicNum?: number;
/**
* 绑定的标签列表
*/
TagList?: Array<Tag>;
}
/**
* ModifyRabbitMQUser请求参数结构体
*/
export interface ModifyRabbitMQUserRequest {
/**
* <p>实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 <a href="https://console.cloud.tencent.com/trabbitmq/cluster?rid=1">TDMQ RabbitMQ 控制台</a>查询。</p>
*/
InstanceId: string;
/**
* <p>用户名，形如rabbitmq。有效的 User 名称可通过登录 <a href="https://console.cloud.tencent.com/trabbitmq/cluster?rid=1">TDMQ RabbitMQ 控制台</a>查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。当前不支持修改admin的密码。</p>
*/
User: string;
/**
* <p>密码，登录时使用。规范：不能为空，8-64个字符，至少要包含小写字母、大写字母、数字、特殊字符【()`~!@#$%^&*_=|{}[]:;',.?/】中的两项</p>
*/
Password: string;
/**
* <p>描述，不传则不修改</p>
*/
Description?: string;
/**
* <p>用户标签，用于决定改用户访问 RabbitMQ Management 的权限范围<br>management：普通控制台用户，monitoring：管理型控制台用户，其他值：非控制台用户</p>
*/
Tags?: Array<string>;
/**
* <p>该用户的最大连接数，不传则不修改</p>
*/
MaxConnections?: number;
/**
* <p>该用户的最大channel数，不传则不修改</p>
*/
MaxChannels?: number;
/**
* <p>是否开启cam验证</p>
*/
EnableCamAuth?: boolean;
}
/**
* CreateSubscription请求参数结构体
*/
export interface CreateSubscriptionRequest {
/**
* 环境（命名空间）名称。
*/
EnvironmentId: string;
/**
* 主题名称。
*/
TopicName: string;
/**
* 订阅者名称，不超过128个字符。
*/
SubscriptionName: string;
/**
* 是否幂等创建，若否不允许创建同名的订阅关系。
*/
IsIdempotent: boolean;
/**
* Pulsar 集群的ID
*/
ClusterId: string;
/**
* 备注，128个字符以内。
*/
Remark?: string;
/**
* 是否自动创建死信和重试主题，True 表示创建，False表示不创建，默认自动创建死信和重试主题。
*/
AutoCreatePolicyTopic?: boolean;
/**
* 指定死信和重试主题名称规范，LEGACY表示历史命名规则，COMMUNITY表示Pulsar社区命名规范
*/
PostFixPattern?: string;
}
/**
* RabbitMQ 托管版实例信息
*/
export interface RabbitMQVipInstance {
/**
* <p>实例 ID</p>
*/
InstanceId?: string;
/**
* <p>实例名称</p>
*/
InstanceName?: string;
/**
* <p>实例版本</p>
*/
InstanceVersion?: string;
/**
* <p>实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败</p>
*/
Status?: number;
/**
* <p>节点数量</p>
*/
NodeCount?: number;
/**
* <p>实例配置规格名称</p>
*/
ConfigDisplay?: string;
/**
* <p>峰值TPS</p>
*/
MaxTps?: number;
/**
* <p>峰值带宽，Mbps为单位</p>
*/
MaxBandWidth?: number;
/**
* <p>存储容量，GB为单位</p>
*/
MaxStorage?: number;
/**
* <p>实例到期时间，按量付费的资源该值为 0，毫秒为单位。unix 时间戳</p>
*/
ExpireTime?: number;
/**
* <p>自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置)</p>
*/
AutoRenewFlag?: number;
/**
* <p>1 表示预付费，0 表示后付费</p>
*/
PayMode?: number;
/**
* <p>备注信息</p>
*/
Remark?: string;
/**
* <p>集群的节点规格，对应的规格标识：<br>2C8G：rabbit-vip-profession-2c8g<br>4C16G：rabbit-vip-profession-4c16g<br>8C32G：rabbit-vip-profession-8c32g<br>16C32G：rabbit-vip-basic-4<br>16C64G：rabbit-vip-profession-16c64g<br>2C4G：rabbit-vip-basic-5<br>4C8G：rabbit-vip-basic-1<br>8C16G（已售罄）：rabbit-vip-basic-2<br>不传默认为 4C8G：rabbit-vip-basic-1</p>
*/
SpecName?: string;
/**
* <p>集群异常信息</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ExceptionInformation?: string;
/**
* <p>实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败<br>为了和计费区分开，额外开启一个状态位，用于显示。</p>
*/
ClusterStatus?: number;
/**
* <p>公网接入点</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
PublicAccessEndpoint?: string;
/**
* <p>VPC 接入点列表</p>
*/
Vpcs?: Array<VpcEndpointInfo>;
/**
* <p>创建时间，毫秒为单位。unix 时间戳</p>
*/
CreateTime?: number;
/**
* <p>实例类型</p><p>枚举值：</p><ul><li>0： 托管版实例</li></ul>
*/
InstanceType?: number;
/**
* <p>隔离时间，毫秒为单位。unix 时间戳</p>
*/
IsolatedTime?: number;
/**
* <p>是否已开启删除保护</p>
*/
EnableDeletionProtection?: boolean;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
/**
* <p>公有数据流Stream接入点</p>
*/
PublicStreamAccessEndpoint?: string;
/**
* <p>集群类型</p><p>枚举值：</p><ul><li>NORMAL： 公有云</li><li>CDC： 本地专用集群</li></ul>
*/
ClusterType?: string;
/**
* <p>CDC 集群 ID</p>
*/
CdcClusterId?: string;
}
/**
* RabbitMQ 集群基本信息
*/
export interface RabbitMQClusterInfo {
/**
* <p>集群 ID</p>
*/
ClusterId?: string;
/**
* <p>集群名称</p>
*/
ClusterName?: string;
/**
* <p>地域信息</p>
*/
Region?: string;
/**
* <p>创建时间，毫秒为单位。unix 时间戳</p>
*/
CreateTime?: number;
/**
* <p>集群说明信息</p>
*/
Remark?: string;
/**
* <p>VPC及网络信息</p>
*/
Vpcs?: Array<VpcEndpointInfo>;
/**
* <p>可用区信息</p>
*/
ZoneIds?: Array<number | bigint>;
/**
* <p>虚拟主机数量</p>
*/
VirtualHostNumber?: number;
/**
* <p>队列数量</p>
*/
QueueNumber?: number;
/**
* <p>每秒生产消息数 单位：条/秒</p>
*/
MessagePublishRate?: number;
/**
* <p>堆积消息数 单位：条</p>
*/
MessageStackNumber?: number;
/**
* <p>实例到期时间，按量付费的资源该值为 0，毫秒为单位。unix 时间戳</p>
*/
ExpireTime?: number;
/**
* <p>Channel数量</p>
*/
ChannelNumber?: number;
/**
* <p>Connection数量</p>
*/
ConnectionNumber?: number;
/**
* <p>Consumer数量</p>
*/
ConsumerNumber?: number;
/**
* <p>Exchang数量</p>
*/
ExchangeNumber?: number;
/**
* <p>集群异常信息</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ExceptionInformation?: string;
/**
* <p>实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败</p>
*/
ClusterStatus?: number;
/**
* <p>自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置)</p>
*/
AutoRenewFlag?: number;
/**
* <p>是否开启镜像队列策略。1表示开启，0表示没开启。</p>
*/
MirrorQueuePolicyFlag?: number;
/**
* <p>每秒消费消息数 单位：条/秒</p>
*/
MessageConsumeRate?: number;
/**
* <p>集群版本信息</p>
*/
ClusterVersion?: string;
/**
* <p>计费模式，0-后付费，1-预付费</p>
*/
PayMode?: number;
/**
* <p>实例类型，0 专享版、1 Serverless 版</p>
*/
InstanceType?: number;
/**
* <p>开始隔离时间。unix 时间戳</p>
*/
IsolatedTime?: number;
/**
* <p>是否为容器实例，默认 true</p>
*/
Container?: boolean;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
/**
* <p>是否已开启删除保护</p>
*/
EnableDeletionProtection?: boolean;
/**
* <p>是否有vhost未开启镜像队列风险</p>
*/
MirroredQueueRisk?: boolean;
/**
* <p>是否提示风险</p>
*/
EnableRiskWarning?: boolean;
/**
* <p>消费超时时间</p>
*/
ConsumeTimeout?: number;
/**
* <p>最大Channel数</p>
*/
ChannelMax?: number;
/**
* <p>集群类型</p><p>枚举值：</p><ul><li>NORMAL： 公有云</li><li>CDC： 本地专用集群</li></ul>
*/
ClusterType?: string;
/**
* <p>CDC集群ID</p>
*/
CdcClusterId?: string;
}
/**
* vhost概览统计信息
*/
export interface RabbitMQVirtualHostStatistics {
/**
* 当前vhost的queue数量
*/
CurrentQueues?: number;
/**
* 当前vhost的exchange数量
*/
CurrentExchanges?: number;
/**
* 当前vhost的连接数量
*/
CurrentConnections?: number;
/**
* 当前vhost的channel数量
*/
CurrentChannels?: number;
/**
* 当前vhost的用户数量
*/
CurrentUsers?: number;
}
/**
* DescribeRabbitMQQueues返回参数结构体
*/
export interface DescribeRabbitMQQueuesResponse {
/**
* 队列列表信息
*/
QueueInfoList?: Array<RabbitMQQueueListInfo>;
/**
* 队列数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnvironments请求参数结构体
*/
export interface DescribeEnvironmentsRequest {
/**
* Pulsar 集群的ID
*/
ClusterId: string;
/**
* 命名空间名称，模糊搜索。
*/
EnvironmentId?: string;
/**
* 起始下标，不填默认为0。
*/
Offset?: number;
/**
* 返回数量，不填则默认为10，最大值为20。
*/
Limit?: number;
/**
* * EnvironmentId
按照名称空间进行过滤，精确查询。
类型：String
必选：否
*/
Filters?: Array<Filter>;
}
/**
* DescribeRocketMQNamespaces请求参数结构体
*/
export interface DescribeRocketMQNamespacesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 偏移量
*/
Offset: number;
/**
* 限制数目
*/
Limit: number;
/**
* 按名称搜索
*/
NameKeyword?: string;
}
/**
* ModifyRocketMQCluster返回参数结构体
*/
export interface ModifyRocketMQClusterResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRocketMQTopicStats返回参数结构体
*/
export interface DescribeRocketMQTopicStatsResponse {
/**
* 生产详情列表
*/
TopicStatsList?: Array<TopicStats>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateEnvironment请求参数结构体
*/
export interface CreateEnvironmentRequest {
/**
* 环境（命名空间）名称，不支持中字以及除了短线和下划线外的特殊字符且不超过16个字符。
*/
EnvironmentId: string;
/**
* 未消费消息过期时间，单位：秒，取值范围：60秒~15天。
*/
MsgTTL: number;
/**
* Pulsar 集群的ID
*/
ClusterId: string;
/**
* 说明，128个字符以内。
*/
Remark?: string;
/**
* 消息保留策略
*/
RetentionPolicy?: RetentionPolicy;
/**
* 是否开启自动创建订阅
*/
AutoSubscriptionCreation?: boolean;
/**
* 离线订阅过期自动清理时间
*/
SubscriptionExpirationTime?: number;
/**
* 离线订阅过期自动清理时间开关
*/
SubscriptionExpirationTimeEnable?: boolean;
/**
* 命名空间标签
*/
Tags?: Array<Tag>;
}
/**
* CreateCmqSubscribe返回参数结构体
*/
export interface CreateCmqSubscribeResponse {
/**
* 订阅id
*/
SubscriptionId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusters请求参数结构体
*/
export interface DescribeClustersRequest {
/**
* 起始下标，不填默认为0。
*/
Offset?: number;
/**
* 返回数量，不填则默认为10，最大值为20。
*/
Limit?: number;
/**
* 集群ID列表过滤
*/
ClusterIdList?: Array<string>;
/**
* 是否标签过滤
*/
IsTagFilter?: boolean;
/**
* 过滤器。目前支持按标签过滤。
*/
Filters?: Array<Filter>;
}
/**
* ModifyEnvironmentAttributes请求参数结构体
*/
export interface ModifyEnvironmentAttributesRequest {
/**
* 命名空间名称。
*/
EnvironmentId: string;
/**
* 未消费消息过期时间，单位：秒，范围60秒~15天。
*/
MsgTTL: number;
/**
* 集群ID
*/
ClusterId: string;
/**
* 备注，字符串最长不超过128。
*/
Remark?: string;
/**
* 消息保留策略
*/
RetentionPolicy?: RetentionPolicy;
/**
* 是否开启自动创建订阅
*/
AutoSubscriptionCreation?: boolean;
/**
* 离线订阅过期自动清理时间
*/
SubscriptionExpirationTime?: number;
/**
* 离线订阅过期自动清理时间开关
*/
SubscriptionExpirationTimeEnable?: boolean;
}
/**
* 监控数据点
*/
export interface RocketMQDataPoint {
/**
* 监控值数组，该数组和Timestamps一一对应
注意：此字段可能返回 null，表示取不到有效值。
*/
Timestamps?: Array<number | bigint>;
/**
* 监控数据点位置，比如一天按分钟划分有1440个点，每个点的序号是0 - 1439之间的一个数，当某个序号不在该数组中，说明掉点了
注意：此字段可能返回 null，表示取不到有效值。
*/
Values?: Array<number>;
}
/**
* RewindCmqQueue请求参数结构体
*/
export interface RewindCmqQueueRequest {
/**
* 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
*/
QueueName: string;
/**
* 设定该时间，则（Batch）receiveMessage接口，会按照生产消息的先后顺序消费该时间戳以后的消息。
*/
StartConsumeTime: number;
}
/**
* ModifyRocketMQCluster请求参数结构体
*/
export interface ModifyRocketMQClusterRequest {
/**
* RocketMQ集群ID
*/
ClusterId: string;
/**
* 3-64个字符，只能包含字母、数字、“-”及“_”
*/
ClusterName?: string;
/**
* 说明信息，不超过128个字符
*/
Remark?: string;
/**
* 是否开启HTTP公网访问
*/
PublicAccessEnabled?: boolean;
}
/**
* SendBatchMessages返回参数结构体
*/
export interface SendBatchMessagesResponse {
/**
* 消息的唯一标识
注意：此字段可能返回 null，表示取不到有效值。
*/
MessageId?: string;
/**
* 错误消息，返回为 ""，代表没有错误
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrorMsg?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRocketMQVipInstanceDetail返回参数结构体
*/
export interface DescribeRocketMQVipInstanceDetailResponse {
/**
* 集群信息
*/
ClusterInfo?: RocketMQClusterInfo;
/**
* 集群配置
*/
InstanceConfig?: RocketMQInstanceConfig;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRabbitMQVirtualHost返回参数结构体
*/
export interface DescribeRabbitMQVirtualHostResponse {
/**
* 返回vhost数量
*/
TotalCount?: number;
/**
* vhost详情列表
*/
VirtualHostList?: Array<RabbitMQVirtualHostInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RabbitMQ权限详情
*/
export interface RabbitMQPermission {
/**
* 实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。
*/
InstanceId?: string;
/**
* 用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。
*/
User?: string;
/**
* VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到 Vhost 名称。
*/
VirtualHost?: string;
/**
* 权限类型，declare相关操作，该用户可操作该vhost下的资源名称正则表达式
*/
ConfigRegexp?: string;
/**
* 权限类型，消息写入相关操作，该用户可操作该vhost下的资源名称正则表达式
*/
WriteRegexp?: string;
/**
* 权限类型，消息读取相关操作，该用户可操作该vhost下的资源名称正则表达式
*/
ReadRegexp?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
ModifyTime?: string;
/**
* 创建时间时间戳
*/
CreateTs?: number;
/**
* 修改时间时间戳
*/
ModifyTs?: number;
}
/**
* CreateRocketMQCluster请求参数结构体
*/
export interface CreateRocketMQClusterRequest {
/**
* 集群名称，3-64个字符，只能包含字母、数字、“-”及“_”
*/
Name: string;
/**
* 集群描述，128个字符以内
*/
Remark?: string;
/**
* 标签列表
*/
TagList?: Array<Tag>;
}
/**
* DescribeClusterDetail请求参数结构体
*/
export interface DescribeClusterDetailRequest {
/**
* 集群的ID
*/
ClusterId: string;
}
/**
* DeleteRocketMQRoles返回参数结构体
*/
export interface DeleteRocketMQRolesResponse {
/**
* 成功删除的角色名称数组。
*/
RoleNames?: Array<string>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRocketMQTopic返回参数结构体
*/
export interface DeleteRocketMQTopicResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 生产者信息
*/
export interface Publisher {
/**
* 生产者id
注意：此字段可能返回 null，表示取不到有效值。
*/
ProducerId?: number;
/**
* 生产者名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ProducerName?: string;
/**
* 生产者地址
注意：此字段可能返回 null，表示取不到有效值。
*/
Address?: string;
/**
* 客户端版本
注意：此字段可能返回 null，表示取不到有效值。
*/
ClientVersion?: string;
/**
* 消息生产速率（条/秒）
注意：此字段可能返回 null，表示取不到有效值。
*/
MsgRateIn?: number;
/**
* 消息生产吞吐速率（字节/秒）
注意：此字段可能返回 null，表示取不到有效值。
*/
MsgThroughputIn?: number;
/**
* 平均消息大小（字节）
注意：此字段可能返回 null，表示取不到有效值。
*/
AverageMsgSize?: number;
/**
* 连接时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ConnectedSince?: string;
/**
* 生产者连接的主题分区号
注意：此字段可能返回 null，表示取不到有效值。
*/
Partition?: number;
}
/**
* ModifyRole请求参数结构体
*/
export interface ModifyRoleRequest {
/**
* 角色名称，不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。
*/
RoleName: string;
/**
* 必填字段，集群Id
*/
ClusterId: string;
/**
* 备注说明，长度必须大等于0且小等于128。
*/
Remark?: string;
/**
* 批量绑定名字空间信息
*/
EnvironmentRoleSets?: Array<EnvironmentRoleSet>;
/**
* 全部解绑名字空间，设置为 true
*/
UnbindAllEnvironment?: boolean;
}
/**
* DescribeRocketMQMsg请求参数结构体
*/
export interface DescribeRocketMQMsgRequest {
/**
* <p>集群id</p>
*/
ClusterId: string;
/**
* <p>命名空间，4.x 通用集群命名空间固定为: tdmq_default</p>
*/
EnvironmentId: string;
/**
* <p>主题，查询死信时传groupId</p>
*/
TopicName: string;
/**
* <p>消息id</p>
*/
MsgId: string;
/**
* <p>pulsar消息id</p>
*/
PulsarMsgId: string;
/**
* <p>查询死信时该值为true，只对Rocketmq有效</p>
* @deprecated
*/
QueryDlqMsg?: boolean;
/**
* <p>查询死信时该值为true，只对Rocketmq有效</p>
*/
QueryDeadLetterMessage?: boolean;
/**
* <p>分页Offset</p>
*/
Offset?: number;
/**
* <p>分页Limit</p>
*/
Limit?: number;
/**
* <p>根据消费组名称过滤消费详情</p>
*/
FilterTrackGroup?: string;
/**
* <p>查询延迟消息或定时消息时，该值为true</p>
*/
QueryDelayMessage?: boolean;
}
/**
* SendMessages返回参数结构体
*/
export interface SendMessagesResponse {
/**
* 消息的messageID, 是全局唯一的，用来标识消息的元数据信息
*/
MessageId?: string;
/**
* 返回的错误消息，如果返回为 “”，说明没有错误
*/
ErrorMsg?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTopic请求参数结构体
*/
export interface CreateTopicRequest {
/**
* 环境（命名空间）名称。
*/
EnvironmentId: string;
/**
* 主题名，不支持中字以及除了短线和下划线外的特殊字符且不超过64个字符。
*/
TopicName: string;
/**
* 入参为1，即是创建非分区topic，无分区；入参大于1，表示分区topic的分区数，最大不允许超过32。
*/
Partitions: number;
/**
* Pulsar 集群的ID
*/
ClusterId: string;
/**
* 备注，128字符以内。
*/
Remark?: string;
/**
* 该入参将逐步弃用，可切换至PulsarTopicType参数
0： 普通消息；
1 ：全局顺序消息；
2 ：局部顺序消息；
3 ：重试队列；
4 ：死信队列。
*/
TopicType?: number;
/**
* Pulsar 主题类型
0: 非持久非分区
1: 非持久分区
2: 持久非分区
3: 持久分区
*/
PulsarTopicType?: number;
/**
* 未消费消息过期时间，单位：秒，取值范围：60秒~15天。
*/
MsgTTL?: number;
/**
* 不传默认是原生策略，DefaultPolicy表示当订阅下达到最大未确认消息数 5000 时，服务端将不再向当前订阅下的所有消费者推送消息，DynamicPolicy表示动态调整订阅下的最大未确认消息数，具体配额是在 5000 和消费者数量*20之间取最大值。每个消费者默认最大 unack 消息数为 20，超过该限制时仅影响该消费者，不影响其他消费者。
*/
UnackPolicy?: string;
/**
* 是否开启异常消费者隔离
*/
IsolateConsumerEnable?: boolean;
/**
* 消费者 Ack 超时时间，单位：秒，范围60-（3600*24）
*/
AckTimeOut?: number;
/**
* Pulsar主题消息类型0: 混合消息1:普通消息2:延迟消息
*/
PulsarTopicMessageType?: number;
/**
* 主题标签
*/
Tags?: Array<Tag>;
/**
* defaultPolicy/timingwheelPolicy不传默认是社区版本延迟消息策略
*/
DelayMessagePolicy?: string;
}
/**
* DescribeCmqTopics返回参数结构体
*/
export interface DescribeCmqTopicsResponse {
/**
* 主题列表
*/
TopicList?: Array<CmqTopic>;
/**
* 全量主题数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRocketMQMsgTrace请求参数结构体
*/
export interface DescribeRocketMQMsgTraceRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
EnvironmentId: string;
/**
* 主题，rocketmq查询死信时值为groupId
*/
TopicName: string;
/**
* 消息id
*/
MsgId: string;
/**
* 消费组、订阅
*/
GroupName?: string;
/**
* 查询死信时该值为true
* @deprecated
*/
QueryDLQMsg?: boolean;
/**
* 查询死信时该值为true
*/
QueryDeadLetterMessage?: string;
}
/**
* ModifyRocketMQGroup请求参数结构体
*/
export interface ModifyRocketMQGroupRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 消费组所在的命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
NamespaceId: string;
/**
* 消费组名称
*/
GroupId: string;
/**
* 说明信息，最长128个字符
*/
Remark?: string;
/**
* 是否开启消费
*/
ReadEnable?: boolean;
/**
* 是否开启广播消费
*/
BroadcastEnable?: boolean;
/**
* 最大重试次数
*/
RetryMaxTimes?: number;
}
/**
* DescribeCmqTopicDetail请求参数结构体
*/
export interface DescribeCmqTopicDetailRequest {
/**
* 精确匹配TopicName。
*/
TopicName?: string;
}
/**
* UnbindCmqDeadLetter返回参数结构体
*/
export interface UnbindCmqDeadLetterResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRocketMQEnvironmentRole请求参数结构体
*/
export interface ModifyRocketMQEnvironmentRoleRequest {
/**
* 命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
EnvironmentId: string;
/**
* 角色名称。
*/
RoleName: string;
/**
* 授权项，最多只能包含produce、consume两项的非空字符串数组。
*/
Permissions: Array<string>;
/**
* 必填字段，集群的ID
*/
ClusterId: string;
/**
* Topic&Group维度权限配置
*/
DetailedPerms?: Array<DetailedRolePerm>;
}
/**
* ModifyRocketMQNamespace返回参数结构体
*/
export interface ModifyRocketMQNamespaceResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例维度组合数组
*/
export interface DimensionInstance {
/**
* 实例的维度组合
注意：此字段可能返回 null，表示取不到有效值。
*/
Dimensions: Array<DimensionOpt>;
}
/**
* 面向运营端的虚拟集群信息
*/
export interface InternalTenant {
/**
* 虚拟集群ID
*/
TenantId?: string;
/**
* 虚拟集群名称
*/
TenantName?: string;
/**
* 客户UIN
*/
CustomerUin?: string;
/**
* 客户的APPID
*/
CustomerAppId?: string;
/**
* 物理集群名称
*/
ClusterName?: string;
/**
* 集群协议类型，支持的值为TDMQ，ROCKETMQ，AMQP，CMQ
*/
Type?: string;
/**
* 命名空间配额
*/
MaxNamespaces?: number;
/**
* 已使用命名空间配额
*/
UsedNamespaces?: number;
/**
* Topic配额
*/
MaxTopics?: number;
/**
* 已使用Topic配额
*/
UsedTopics?: number;
/**
* Topic分区数配额
*/
MaxPartitions?: number;
/**
* 已使用Topic分区数配额
*/
UsedPartitions?: number;
/**
* 存储配额, byte为单位
*/
MaxMsgBacklogSize?: number;
/**
* 命名空间最大生产TPS
*/
MaxPublishTps?: number;
/**
* 消息最大保留时间，秒为单位
*/
MaxRetention?: number;
/**
* 创建时间，毫秒为单位
*/
CreateTime?: number;
/**
* 修改时间，毫秒为单位
*/
UpdateTime?: number;
/**
* 命名空间最大消费TPS
*/
MaxDispatchTps?: number;
/**
* 命名空间最大消费带宽，byte为单位
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxDispatchRateInBytes?: number;
/**
* 命名空间最大生产带宽，byte为单位
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxPublishRateInBytes?: number;
/**
* 消息最大保留空间，MB为单位
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxRetentionSizeInMB?: number;
/**
* public Access Enabled
注意：此字段可能返回 null，表示取不到有效值。
*/
PublicAccessEnabled?: boolean;
/**
* 实例标签列表
*/
TagList?: Array<string>;
/**
* 实例规格
*/
TenantSpec?: string;
}
/**
* DeleteEnvironments请求参数结构体
*/
export interface DeleteEnvironmentsRequest {
/**
* 环境（命名空间）数组，每次最多删除20个。
*/
EnvironmentIds: Array<string>;
/**
* Pulsar 集群的ID
*/
ClusterId: string;
}
/**
* DescribeRocketMQClusters请求参数结构体
*/
export interface DescribeRocketMQClustersRequest {
/**
* 偏移量
*/
Offset: number;
/**
* 限制数目
*/
Limit: number;
/**
* 按照集群ID关键字搜索
*/
IdKeyword?: string;
/**
* 按照集群名称关键字搜索
*/
NameKeyword?: string;
/**
* 集群ID列表过滤
*/
ClusterIdList?: Array<string>;
/**
* 标签过滤查找时，需要设置为true
*/
IsTagFilter?: boolean;
/**
* 过滤器。目前支持标签过滤。
*/
Filters?: Array<Filter>;
}
/**
* SendRocketMQMessage请求参数结构体
*/
export interface SendRocketMQMessageRequest {
/**
* 集群id
*/
ClusterId: string;
/**
* 命名空间
*/
NamespaceId: string;
/**
* topic名称
*/
TopicName: string;
/**
* 信息内容
*/
MsgBody: string;
/**
* 消息key信息
*/
MsgKey?: string;
/**
* 消息tag信息
*/
MsgTag?: string;
}
/**
* CreateRocketMQGroupV2返回参数结构体
*/
export interface CreateRocketMQGroupV2Response {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRocketMQNamespace请求参数结构体
*/
export interface DeleteRocketMQNamespaceRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 命名空间名称
*/
NamespaceId: string;
}
/**
* DeleteRabbitMQPermission请求参数结构体
*/
export interface DeleteRabbitMQPermissionRequest {
/**
* 实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。
*/
InstanceId: string;
/**
* 用户名，形如 admin。有效的 User 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，点击集群列表中的集群，进入集群详情，并在用户与权限页签中找到用户列表，从而找到用户名称。
*/
User: string;
/**
* VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到 Vhost 名称。
*/
VirtualHost: string;
}
/**
* CreateTopic返回参数结构体
*/
export interface CreateTopicResponse {
/**
* 环境（命名空间）名称。
*/
EnvironmentId?: string;
/**
* 主题名。
*/
TopicName?: string;
/**
* 0或1：非分区topic，无分区；大于1：具体分区topic的分区数。（存量非分区主题返回0，增量非分区主题返回1）
*/
Partitions?: number;
/**
* 备注，128字符以内。
*/
Remark?: string;
/**
* 0： 普通消息；
1 ：全局顺序消息；
2 ：局部顺序消息；
3 ：重试队列；
4 ：死信队列；
*/
TopicType?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReceiveMessage返回参数结构体
*/
export interface ReceiveMessageResponse {
/**
* 用作标识消息的唯一主键
*/
MessageID?: string;
/**
* 接收消息的内容
*/
MessagePayload?: string;
/**
* 提供给 Ack 接口，用来Ack哪一个topic中的消息
*/
AckTopic?: string;
/**
* 返回的错误信息，如果为空，说明没有错误
*/
ErrorMsg?: string;
/**
* 返回订阅者的名字，用来创建 ack consumer时使用
*/
SubName?: string;
/**
* BatchReceivePolicy 一次性返回的多条消息的 MessageID，用 ‘###’ 来区分不同的 MessageID
*/
MessageIDList?: string;
/**
* BatchReceivePolicy 一次性返回的多条消息的消息内容，用 ‘###’ 来区分不同的消息内容
*/
MessagesPayload?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRocketMQVipInstance请求参数结构体
*/
export interface CreateRocketMQVipInstanceRequest {
/**
* 实例名称
*/
Name: string;
/**
* 集群规格，支持规格有 1.通用型:rocket-vip-basic-0; 2.基础型:rocket-vip-basic-1; 3.标准型:rocket-vip-basic-2; 4.高阶Ⅰ型:rocket-vip-basic-3; 5.高阶Ⅱ型:rocket-vip-basic-4
*/
Spec: string;
/**
* 单节点存储空间，GB为单位，最低200GB
*/
StorageSize: number;
/**
* 节点部署的区域ID列表，如广州一区，则是100001，具体可查询腾讯云官网
*/
ZoneIds: Array<string>;
/**
* VPC信息
*/
VpcInfo: VpcInfo;
/**
* 购买时长，月为单位
*/
TimeSpan: number;
/**
* 节点数量，创建专享集群时必填
*/
NodeCount?: number;
/**
* 通用集群规格标识，新购通用集群时必填，从 [DescribeRocketMQGeneralSKUs](https://cloud.tencent.com/document/api/1179/127066) 接口返回的 [GeneralSKU](https://cloud.tencent.com/document/api/1179/46089#GeneralSKU) 字段获取。
*/
GeneralSkuCode?: string;
/**
* 是否用于迁移上云，默认为false
*/
SupportsMigrateToCloud?: boolean;
/**
* 是否开启公网
*/
EnablePublic?: boolean;
/**
* 公网带宽，在开启公网情况下为必传字段
*/
Bandwidth?: number;
/**
* 公网白名单
*/
IpRules?: Array<PublicAccessRule>;
/**
* 标签
*/
Tags?: Array<Tag>;
}
/**
* Pulsar 网络接入点信息
*/
export interface PulsarNetworkAccessPointInfo {
/**
* vpc的id，支撑网和公网接入点，该字段为空
注意：此字段可能返回 null，表示取不到有效值。
*/
VpcId?: string;
/**
* 子网id，支撑网和公网接入点，该字段为空
注意：此字段可能返回 null，表示取不到有效值。
*/
SubnetId?: string;
/**
* 接入地址
*/
Endpoint?: string;
/**
* 实例id
*/
InstanceId?: string;
/**
* 接入点类型：
0：支撑网接入点
1：VPC接入点
2：公网接入点
*/
RouteType?: number;
/**
* 0：本地域访问，由于并没有配置跨地域容灾，所该类型的接入点，无法进行异地切换、异地访问切回；
1：本地域访问，由于配置了跨地域容灾，随时可以进行异地切换，该状态用于主集群的接入点
2：跨地域访问，已经完成了异地切换，该状态用于源集群的接入点，该状态下的接入点不可删除
3：跨地域访问，随时可以进行异地访问切回，该状态用于目标集群的接入点，该状态下的接入点不可删除
4:跨地域访问，目标集群已经完成异地切回，等待删除状态
注意：此字段可能返回 null，表示取不到有效值。
*/
OperationType?: number;
/**
* 接入点类型
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessPointsType?: string;
/**
* 带宽，目前只有公网会有这个值
注意：此字段可能返回 null，表示取不到有效值。
*/
Bandwidth?: number;
/**
* 类
注意：此字段可能返回 null，表示取不到有效值。
*/
SecurityPolicy?: Array<SecurityPolicy>;
/**
* 是否是标准的接入点 true是标准的 false不是标准的
注意：此字段可能返回 null，表示取不到有效值。
*/
StandardAccessPoint?: boolean;
/**
* 可用区信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ZoneName?: string;
/**
* 是否开启TLS加密
*/
Tls?: boolean;
/**
* 接入点自定义域名
*/
CustomUrl?: string;
/**
* 接入点绑定的安全组id列表，仅限vpc接入点有效
*/
SecurityGroupIds?: Array<string>;
}
/**
* DescribeRabbitMQVipInstance请求参数结构体
*/
export interface DescribeRabbitMQVipInstanceRequest {
/**
* 实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。
*/
ClusterId: string;
}
/**
* DescribeRabbitMQExchanges请求参数结构体
*/
export interface DescribeRabbitMQExchangesRequest {
/**
* 实例 ID，形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。
*/
InstanceId: string;
/**
* VirtualHost 名称，形如 testvhost。有效的 VirtualHost 名称可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询，在左侧导航栏点击 Vhost，并在 Vhost 列表中找到Vhost名称。
*/
VirtualHost: string;
/**
* 分页 offset，默认 0
*/
Offset?: number;
/**
* 分页 limit，默认 20
*/
Limit?: number;
/**
* 搜索关键词, 支持模糊匹配
*/
SearchWord?: string;
/**
* 筛选 exchange 类型, 数组中每个元素为选中的过滤类型，仅支持 direct、fanout、topic、header
*/
ExchangeTypeFilters?: Array<string>;
/**
* 筛选 exchange 创建来源, "system":"系统创建", "user":"用户创建"
*/
ExchangeCreatorFilters?: Array<string>;
/**
* exchange 名称，用于精确匹配
*/
ExchangeName?: string;
/**
* 排序依据的字段：
MessageRateInOut - 生产消费速率之和；
MessageRateIn - 生产速率；
MessageRateOut - 消费速率；
*/
SortElement?: string;
/**
* 排序顺序，ascend 或 descend
ascend：升序
descend：降序
*/
SortOrder?: string;
}
/**
* DeleteTopics请求参数结构体
*/
export interface DeleteTopicsRequest {
/**
* 主题集合，每次最多删除20个。
*/
TopicSets: Array<TopicRecord>;
/**
* pulsar集群Id。
*/
ClusterId: string;
/**
* 环境（命名空间）名称。
*/
EnvironmentId?: string;
/**
* 是否强制删除，默认为false
*/
Force?: boolean;
}
/**
* DescribeNamespaceBundlesOpt请求参数结构体
*/
export interface DescribeNamespaceBundlesOptRequest {
/**
* 物理集群名
*/
ClusterName: string;
/**
* 虚拟集群（租户）ID
*/
TenantId: string;
/**
* 命名空间名
*/
NamespaceName: string;
/**
* 是否需要监控指标，若传false，则不需要传Limit和Offset分页参数
*/
NeedMetrics: boolean;
/**
* 查询限制条数
*/
Limit?: number;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 过滤的 bundle
*/
Bundle?: string;
/**
* bundle 所属的 broker IP 地址，支持模糊查询
*/
OwnerBroker?: string;
/**
* 租户(如果没有自定义租户名称，和 tenantId 相同；如果有配置自定义租户名称，则为自定义租户名 user_tenant)
*/
Tenant?: string;
}
/**
* DeleteRocketMQEnvironmentRoles返回参数结构体
*/
export interface DeleteRocketMQEnvironmentRolesResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* rocketmq router mns 目标信息
*/
export interface RouterMessageServiceTarget {
/**
* <p>access key</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
AccessKey: string;
/**
* <p>mns接入点，需要和router内网联通，一般是公网接入点</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Endpoint: string;
/**
* <p>secret key</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
SecretKey: string;
/**
* <p>mns queue名字。可以在https://mns.console.aliyun.com/region/cn-shenzhen/queues 看到</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Queue?: string;
/**
* <p>是否用base64编码发送mns消息。<br> ON：发送base64编码的消息体到mns</p><p>OFF：将原始消息体发送到mns</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
SendWithBase64?: string;
/**
* <p>发送mns的并发数</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
TargetProduceConcurrentThreadCount?: number;
/**
* <p>topic名字。可以在https://mns.console.aliyun.com/region/cn-shenzhen/topics 看到</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Topic?: string;
}
/**
* DeleteCmqSubscribe请求参数结构体
*/
export interface DeleteCmqSubscribeRequest {
/**
* 主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
*/
TopicName: string;
/**
* 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
*/
SubscriptionName: string;
}
/**
* RocketMQ集群配置
*/
export interface RocketMQClusterConfig {
/**
* 单命名空间TPS上限
* @deprecated
*/
MaxTpsPerNamespace?: number;
/**
* 最大命名空间数量
*/
MaxNamespaceNum?: number;
/**
* 已使用命名空间数量
*/
UsedNamespaceNum?: number;
/**
* 最大Topic数量
*/
MaxTopicNum?: number;
/**
* 已使用Topic数量
*/
UsedTopicNum?: number;
/**
* 最大Group数量
*/
MaxGroupNum?: number;
/**
* 已使用Group数量
*/
UsedGroupNum?: number;
/**
* 消息最大保留时间，以毫秒为单位
*/
MaxRetentionTime?: number;
/**
* 消息最长延时，以毫秒为单位
*/
MaxLatencyTime?: number;
/**
* 单个主题最大队列数
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxQueuesPerTopic?: number;
/**
* topic分布
注意：此字段可能返回 null，表示取不到有效值。
*/
TopicDistribution?: Array<RocketMQTopicDistribution>;
/**
* 最大角色数量
*/
MaxRoleNum?: number;
/**
* TPS限额
*/
MaxTpsLimit?: number;
}
/**
* SendMsg返回参数结构体
*/
export interface SendMsgResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMsg请求参数结构体
*/
export interface DescribeMsgRequest {
/**
* 环境（命名空间）名称。
*/
EnvironmentId: string;
/**
* 消息ID。
*/
MsgId: string;
/**
* 主题名。
*/
TopicName: string;
/**
* Pulsar 集群的ID
*/
ClusterId?: string;
}
/**
* CreateRocketMQRouterRule请求参数结构体
*/
export interface CreateRocketMQRouterRuleRequest {
/**
* <p>true: 立即启动任务<br>false: 创建任务后不立即启动，可以在控制台操作启动</p>
*/
StartNow: boolean;
/**
* <p>规则数据结构</p>
*/
Rule: RocketMQRouterRuleInfo;
/**
* <p>数据同步类型。<br>Topic：按照topic维度同步</p>
*/
SyncType: string;
}
/**
* DeleteRabbitMQPermission返回参数结构体
*/
export interface DeleteRabbitMQPermissionResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRabbitMQBinding返回参数结构体
*/
export interface DeleteRabbitMQBindingResponse {
/**
* 实例 ID
*/
InstanceId?: string;
/**
* vhost参数
*/
VirtualHost?: string;
/**
* 路由关系Id
*/
BindingId?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRabbitMQVipInstance返回参数结构体
*/
export interface ModifyRabbitMQVipInstanceResponse {
/**
* 实例id
*/
InstanceId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePulsarProInstances请求参数结构体
*/
export interface DescribePulsarProInstancesRequest {
/**
* 查询条件过滤器
*/
Filters?: Array<Filter>;
/**
* 查询数目上限，默认20
*/
Limit?: number;
/**
* 查询起始位置
*/
Offset?: number;
}
/**
* RocketMQ消费组配置信息
*/
export interface RocketMQGroupConfig {
/**
* 命名空间
*/
Namespace: string;
/**
* 消费组名称
*/
GroupName: string;
/**
* 是否开启广播消费
*/
ConsumeBroadcastEnable: boolean;
/**
* 是否开启消费
*/
ConsumeEnable: boolean;
/**
* 备注信息
*/
Remark?: string;
/**
* 协议类型，支持以下枚举值
TCP;
HTTP;
*/
ConsumerGroupType?: string;
}
/**
* VPC接入点信息
*/
export interface VpcEndpointInfo {
/**
* <p>vpc的id</p>
*/
VpcId: string;
/**
* <p>子网id</p>
*/
SubnetId: string;
/**
* <p>vpc接入点信息</p>
*/
VpcEndpoint: string;
/**
* <p>vpc接入点状态 OFF/ON/CREATING/DELETING</p>
*/
VpcDataStreamEndpointStatus?: string;
/**
* <p>TLS加密的数据流接入点</p>
*/
VpcTlsEndpoint?: string;
/**
* <p>VPC 接入点操作失败的错误信息</p>
*/
VpcErrorMessage?: string;
/**
* <p>接入点ID</p>
*/
Id?: string;
/**
* <p>vpc Stream接入点</p>
*/
VpcStreamEndpoint?: string;
}
/**
* ClearCmqQueue返回参数结构体
*/
export interface ClearCmqQueueResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopicMsgs请求参数结构体
*/
export interface DescribeTopicMsgsRequest {
/**
* 环境（命名空间）名称。
*/
EnvironmentId: string;
/**
* 主题名。
*/
TopicName: string;
/**
* 开始时间。
*/
StartTime: string;
/**
* 结束时间。
*/
EndTime: string;
/**
* 起始下标，不填默认为0。
*/
Offset?: number;
/**
* 返回数量，不填则默认为10，最大值为20。
*/
Limit?: number;
/**
* 消息ID。
*/
MsgId?: string;
/**
* Pulsar 集群的ID
*/
ClusterId?: string;
}
/**
* DeleteCmqQueue请求参数结构体
*/
export interface DeleteCmqQueueRequest {
/**
* 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
*/
QueueName: string;
}
/**
* DeleteRabbitMQUser返回参数结构体
*/
export interface DeleteRabbitMQUserResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRocketMQMigrationTask请求参数结构体
*/
export interface CreateRocketMQMigrationTaskRequest {
/**
* <p>集群ID</p>
*/
ClusterId: string;
/**
* <p>任务类型：<br>0，集群迁移<br>1，导入到指定命名空间</p>
*/
Type: number;
/**
* <p>待导入的主题列表</p>
*/
Topics?: Array<RocketMQTopicConfig>;
/**
* <p>待导入的消费组列表</p>
*/
Groups?: Array<RocketMQGroupConfig>;
/**
* <p>待导入的角色列表</p>
*/
Roles?: Array<RocketMQRoleConfig>;
/**
* <p>指定导入的命名空间</p>
*/
Namespace?: string;
}
/**
* SetRocketMQPublicAccessPoint返回参数结构体
*/
export interface SetRocketMQPublicAccessPointResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRocketMQTopicMsgs请求参数结构体
*/
export interface DescribeRocketMQTopicMsgsRequest {
/**
* 集群 ID
*/
ClusterId: string;
/**
* 命名空间，4.x 通用集群命名空间固定为: tdmq_default
*/
EnvironmentId: string;
/**
* 主题名称，查询死信时为groupId
*/
TopicName: string;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 消息 ID
*/
MsgId?: string;
/**
* 消息 key
*/
MsgKey?: string;
/**
* 查询偏移
*/
Offset?: number;
/**
* 查询限额
*/
Limit?: number;
/**
* 标志一次分页事务
*/
TaskRequestId?: string;
/**
* 死信查询时该值为true，只对Rocketmq有效
* @deprecated
*/
QueryDlqMsg?: boolean;