tencentcloud-sdk-nodejs

/** * 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 { /** * 实例名称 */ InstanceId?: string; /** * vhost名称 */ VirtualHost?: string; /** * 路由关系Id */ BindingId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyRocketMQInstanceSpec请求参数结构体 */ export interface ModifyRocketMQInstanceSpecRequest { /** * 专享实例ID */ InstanceId: string; /** * 实例规格， rocket-vip-basic-1 基础型 rocket-vip-basic-2 标准型 rocket-vip-basic-3 高阶Ⅰ型 rocket-vip-basic-4 高阶Ⅱ型 */ Specification?: string; /** * 节点数量 */ NodeCount?: number; /** * 存储空间，GB为单位 */ StorageSize?: number; } /** * 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; /** * 集群名称 */ ClusterName?: string; /** * 备注 */ Remark?: string; } /** * RocketMQ专享实例信息 */ export interface RocketMQVipInstance { /** * 实例id */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 实例版本 */ InstanceVersion?: string; /** * 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败 */ Status?: number; /** * 节点数量 */ NodeCount?: number; /** * 实例配置规格名称 */ ConfigDisplay?: string; /** * 峰值TPS */ MaxTps?: number; /** * 峰值带宽，Mbps为单位 */ MaxBandWidth?: number; /** * 存储容量，GB为单位 */ MaxStorage?: number; /** * 实例到期时间，毫秒为单位 */ ExpireTime?: number; /** * 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) */ AutoRenewFlag?: number; /** * 0-后付费，1-预付费 */ PayMode?: number; /** * 备注信息 */ Remark?: string; /** * 实例配置ID */ SpecName?: string; /** * 最大可设置消息保留时间，小时为单位 */ MaxRetention?: number; /** * 最小可设置消息保留时间，小时为单位 */ MinRetention?: number; /** * 实例消息保留时间，小时为单位 */ Retention?: number; /** * 是否开启ACL鉴权 */ AclEnabled?: boolean; /** * 销毁时间 */ 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; } /** * DescribeRabbitMQNodeList请求参数结构体 */ export interface DescribeRabbitMQNodeListRequest { /** * rabbitmq集群ID */ InstanceId: string; /** * 偏移量 */ Offset?: number; /** * 一页限制 */ Limit?: number; /** * 模糊搜索节点名字 */ NodeName?: string; /** * 过滤参数的名字和数值现在只有一个nodeStatus running/down 数组类型，兼容后续添加过滤参数 */ Filters?: Array<Filter>; /** * 按指定元素排序，现在只有2个 cpuUsage/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; /** * 命名空间 */ EnvironmentId?: string; /** * 起始下标，不填默认为0。 */ Offset?: number; /** * 返回数量，不填则默认为10，最大值为20。 */ Limit?: number; /** * 角色名称 */ RoleName?: string; /** * RoleName按照角色名进行过滤，精确查询。类型：String必选：否 */ Filters?: Array<Filter>; } /** * DeleteRocketMQGroup请求参数结构体 */ export interface DeleteRocketMQGroupRequest { /** * 集群ID */ ClusterId: string; /** * 命名空间名称 */ NamespaceId: string; /** * 消费组名称 */ GroupId: string; } /** * RocketMQ消费组信息 */ export interface RocketMQGroup { /** * 消费组名称 */ Name?: string; /** * 在线消费者数量 */ ConsumerNum?: number; /** * 消费TPS */ TPS?: number; /** * 总堆积数量 */ 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; } /** * ModifyRabbitMQUser请求参数结构体 */ export interface ModifyRabbitMQUserRequest { /** * 集群实例Id */ InstanceId: string; /** * 用户名，登录时使用 */ User: string; /** * 密码，登录时使用 */ Password: string; /** * 描述，不传则不修改 */ Description?: string; /** * 用户标签，用于决定改用户访问RabbitMQ Management的权限范围，不传则不修改 */ Tags?: Array<string>; /** * 该用户的最大连接数，不传则不修改 */ MaxConnections?: number; /** * 该用户的最大channel数，不传则不修改 */ MaxChannels?: number; } /** * 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 { /** * 实例id */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 实例版本 */ InstanceVersion?: string; /** * 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败 */ Status?: number; /** * 节点数量 */ NodeCount?: number; /** * 实例配置规格名称 */ ConfigDisplay?: string; /** * 峰值TPS */ MaxTps?: number; /** * 峰值带宽，Mbps为单位 */ MaxBandWidth?: number; /** * 存储容量，GB为单位 */ MaxStorage?: number; /** * 实例到期时间，毫秒为单位 */ ExpireTime?: number; /** * 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) */ AutoRenewFlag?: number; /** * 0-后付费，1-预付费 */ PayMode?: number; /** * 备注信息 */ Remark?: string; /** * 实例配置ID */ SpecName?: string; /** * 集群异常。注意：此字段可能返回 null，表示取不到有效值。 */ ExceptionInformation?: string; /** * 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败为了和计费区分开，额外开启一个状态位，用于显示。 */ ClusterStatus?: number; /** * 公网接入点注意：此字段可能返回 null，表示取不到有效值。 */ PublicAccessEndpoint?: string; /** * VPC 接入点列表 */ Vpcs?: Array<VpcEndpointInfo>; /** * 创建时间，毫秒为单位 */ CreateTime?: number; /** * 实例类型，0 专享版、1 Serverless 版 */ InstanceType?: number; /** * 隔离时间，毫秒为单位 */ IsolatedTime?: number; } /** * RabbiteMQ集群基本信息 */ export interface RabbitMQClusterInfo { /** * 集群ID */ ClusterId?: string; /** * 集群名称 */ ClusterName?: string; /** * 地域信息 */ Region?: string; /** * 创建时间，毫秒为单位 */ CreateTime?: number; /** * 集群说明信息 */ Remark?: string; /** * VPC及网络信息 */ Vpcs?: Array<VpcEndpointInfo>; /** * 可用区信息 */ ZoneIds?: Array<number | bigint>; /** * 虚拟主机数量 */ VirtualHostNumber?: number; /** * 队列数量 */ QueueNumber?: number; /** * 每秒生产消息数单位：条/秒 */ MessagePublishRate?: number; /** * 堆积消息数单位：条 */ MessageStackNumber?: number; /** * 过期时间 */ ExpireTime?: number; /** * Channel数量 */ ChannelNumber?: number; /** * Connection数量 */ ConnectionNumber?: number; /** * Consumer数量 */ ConsumerNumber?: number; /** * Exchang数量 */ ExchangeNumber?: number; /** * 集群异常信息注意：此字段可能返回 null，表示取不到有效值。 */ ExceptionInformation?: string; /** * 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败 */ ClusterStatus?: number; /** * 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) */ AutoRenewFlag?: number; /** * 是否开启镜像队列策略。1表示开启，0表示没开启。 */ MirrorQueuePolicyFlag?: number; /** * 每秒消费消息数单位：条/秒 */ MessageConsumeRate?: number; /** * 集群版本信息 */ ClusterVersion?: string; /** * 计费模式，0-后付费，1-预付费 */ PayMode?: number; /** * 实例类型，0 专享版、1 Serverless 版 */ InstanceType?: number; /** * 开始隔离时间 */ IsolatedTime?: number; /** * 是否为容器实例，默认 true */ Container?: boolean; } /** * 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; } /** * 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; } /** * 监控数据点 */ export interface RocketMQDataPoint { /** * 监控值数组，该数组和Timestamps一一对应注意：此字段可能返回 null，表示取不到有效值。 */ Timestamps?: Array<number | bigint>; /** * 监控数据点位置，比如一天按分钟划分有1440个点，每个点的序号是0 - 1439之间的一个数，当某个序号不在该数组中，说明掉点了注意：此字段可能返回 null，表示取不到有效值。 */ Values?: Array<number>; } /** * DescribeSubscriptions返回参数结构体 */ export interface DescribeSubscriptionsResponse { /** * 订阅者集合数组。 */ SubscriptionSets?: Array<Subscription>; /** * 数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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 */ InstanceId?: string; /** * 用户名，权限关联的用户 */ User?: string; /** * vhost名 */ VirtualHost?: string; /** * 权限类型，declare相关操作，该用户可操作该vhost下的资源名称正则表达式 */ ConfigRegexp?: string; /** * 权限类型，消息写入相关操作，该用户可操作该vhost下的资源名称正则表达式 */ WriteRegexp?: string; /** * 权限类型，消息读取相关操作，该用户可操作该vhost下的资源名称正则表达式 */ ReadRegexp?: string; /** * 创建时间 */ CreateTime?: string; /** * 修改时间 */ ModifyTime?: string; } /** * CreateRocketMQCluster请求参数结构体 */ export interface CreateRocketMQClusterRequest { /** * 集群名称，3-64个字符，只能包含字母、数字、“-”及“_” */ Name: string; /** * 集群描述，128个字符以内 */ Remark?: string; } /** * ModifyCmqSubscriptionAttribute返回参数结构体 */ export interface ModifyCmqSubscriptionAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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 { /** * 集群id */ ClusterId: string; /** * 命名空间 */ EnvironmentId: string; /** * 主题，查询死信时传groupId */ TopicName: string; /** * 消息id */ MsgId: string; /** * pulsar消息id */ PulsarMsgId: string; /** * 查询死信时该值为true，只对Rocketmq有效 * @deprecated */ QueryDlqMsg?: boolean; /** * 查询死信时该值为true，只对Rocketmq有效 */ QueryDeadLetterMessage?: boolean; /** * 分页Offset */ Offset?: number; /** * 分页Limit */ Limit?: number; /** * 根据消费组名称过滤消费详情 */ FilterTrackGroup?: string; } /** * RocketMQ消费组配置信息 */ export interface RocketMQGroupConfigOutput { /** * 命名空间注意：此字段可能返回 null，表示取不到有效值。 */ Namespace?: string; /** * 消费组名称注意：此字段可能返回 null，表示取不到有效值。 */ GroupName?: string; /** * 是否已导入注意：此字段可能返回 null，表示取不到有效值。 */ Imported?: boolean; /** * remark 注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: 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; } /** * DescribeCmqTopics返回参数结构体 */ export interface DescribeCmqTopicsResponse { /** * 主题列表 */ TopicList?: Array<CmqTopic>; /** * 全量主题数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQMsgTrace请求参数结构体 */ export interface DescribeRocketMQMsgTraceRequest { /** * 集群id */ ClusterId: string; /** * 命名空间 */ 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; /** * 命名空间 */ 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 { /** * 环境（命名空间）名称。 */ 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; } /** * 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; } /** * CreateCluster返回参数结构体 */ export interface CreateClusterResponse { /** * 集群ID */ ClusterId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRocketMQNamespace请求参数结构体 */ export interface DeleteRocketMQNamespaceRequest { /** * 集群ID */ ClusterId: string; /** * 命名空间名称 */ NamespaceId: string; } /** * DescribeRocketMQSmoothMigrationTaskList返回参数结构体 */ export interface DescribeRocketMQSmoothMigrationTaskListResponse { /** * 任务总数 */ TotalCount?: number; /** * 任务列表 */ Data?: Array<RocketMQSmoothMigrationTaskItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQSourceClusterTopicList返回参数结构体 */ export interface DescribeRocketMQSourceClusterTopicListResponse { /** * topic层列表 */ Topics?: Array<RocketMQTopicConfigOutput>; /** * 总条数 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRabbitMQPermission请求参数结构体 */ export interface DeleteRabbitMQPermissionRequest { /** * 集群实例Id */ InstanceId: string; /** * 用户名，登录时使用 */ User: string; /** * 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; /** * 节点数量，最小2，最大20 */ NodeCount: number; /** * 单节点存储空间，GB为单位，最低200GB */ StorageSize: number; /** * 节点部署的区域ID列表，如广州一区，则是100001，具体可查询腾讯云官网 */ ZoneIds: Array<string>; /** * VPC信息 */ VpcInfo: VpcInfo; /** * 购买时长，月为单位 */ TimeSpan: number; /** * 是否用于迁移上云，默认为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; } /** * DescribeRabbitMQVipInstance请求参数结构体 */ export interface DescribeRabbitMQVipInstanceRequest { /** * 集群ID */ ClusterId: string; } /** * DescribeRabbitMQExchanges请求参数结构体 */ export interface DescribeRabbitMQExchangesRequest { /** * 实例 id */ InstanceId: string; /** * vhost 参数 */ VirtualHost: string; /** * 分页 offset */ Offset?: number; /** * 分页 limit */ Limit?: number; /** * 搜索关键词, 支持模糊匹配 */ SearchWord?: string; /** * 筛选 exchange 类型, 数组中每个元素为选中的过滤类型 */ ExchangeTypeFilters?: Array<string>; /** * 筛选 exchange 创建来源, "system":"系统创建", "user":"用户创建" */ ExchangeCreatorFilters?: Array<string>; /** * exchange 名称，用于精确匹配 */ ExchangeName?: string; /** * 排序依据的字段： MessageRateInOut - 生产消费速率之和； MessageRateIn - 生产速率； MessageRateOut - 消费速率； */ SortElement?: string; /** * 排序顺序，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; } /** * DeleteRocketMQEnvironmentRoles返回参数结构体 */ export interface DeleteRocketMQEnvironmentRolesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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>; } /** * SendMsg返回参数结构体 */ export interface SendMsgResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMsg请求参数结构体 */ export interface DescribeMsgRequest { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 消息ID。 */ MsgId: string; /** * 主题名。 */ TopicName: string; /** * Pulsar 集群的ID */ ClusterId?: string; } /** * DeleteRabbitMQPermission返回参数结构体 */ export interface DeleteRabbitMQPermissionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRabbitMQBinding返回参数结构体 */ export interface DeleteRabbitMQBindingResponse { /** * 实例名称 */ 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; } /** * DescribeRocketMQSourceClusterGroupList请求参数结构体 */ export interface DescribeRocketMQSourceClusterGroupListRequest { /** * 页大小 */ Limit: number; /** * 偏移量 */ Offset: number; /** * 迁移任务名称 */ TaskId: string; /** * 查询过滤器，支持字段groupName，imported */ Filters?: Array<Filter>; } /** * 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 { /** * vpc的id */ VpcId: string; /** * 子网id */ SubnetId: string; /** * vpc接入点信息 */ VpcEndpoint: string; /** * vpc接入点状态 OFF/ON/CREATING/DELETING */ VpcDataStreamEndpointStatus?: 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; } /** * SetRocketMQPublicAccessPoint返回参数结构体 */ export interface SetRocketMQPublicAccessPointResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQTopicMsgs请求参数结构体 */ export interface DescribeRocketMQTopicMsgsRequest { /** * 集群 ID */ ClusterId: string; /** * 命名空间 */ 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; /** * 查询最近N条消息最大不超过1024，默认-1为其他查询条件 */ NumOfLatestMsg?: number; /** * TAG表达式 */ Tag?: string; /** * 死信查询时该值为true，只对Rocketmq有效 */ QueryDeadLetterMessage?: boolean; } /** * ModifyEnvironmentRole请求参数结构体 */ export interface ModifyEnvironmentRoleRequest { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 角色名称。 */ RoleName: string; /** * 授权项，最多只能包含produce、consume两项的非空字符串数组。 */ Permissions: Array<string>; /** * 必填字段，集群的ID */ ClusterId: string; } /** * DescribeRocketMQRoles返回参数结构体 */ export interface DescribeRocketMQRolesResponse { /** * 记录数。 */ TotalCount?: number; /** * 角色数组。 */ RoleSets?: Array<Role>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 订阅关系 */ export interface SubscriptionTopic { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 主题名称。 */ TopicName: string; /** * 订阅名称。 */ SubscriptionName: string; } /** * AMQP集群配置 */ export interface AMQPClusterConfig { /** * 单Vhost TPS上限 */ MaxTpsPerVHost: number; /** * 单Vhost客户端连接数上限 */ MaxConnNumPerVHost: number; /** * 最大Vhost数量 */ MaxVHostNum: number; /** * 最大exchange数量 */ MaxExchangeNum: number; /** * 最大Queue数量 */ MaxQueueNum: number; /** * 消息最大保留时间，以毫秒为单位 */ MaxRetentionTime: number; /** * 已使用Vhost数量 */ UsedVHostNum: number; /** * 已使用exchange数量 */ UsedExchangeNum: number; /** * 已使用queue数量 */ UsedQueueNum: number; } /** * DescribeMqMsgTrace请求参数结构体 */ export interface DescribeMqMsgTraceRequest { /** * pulsar、rocketmq、rabbitmq、cmq */ Protocol: string; /** * 消息id */ MsgId: string; /** * 集群id，cmq为空 */ ClusterId?: string; /** * 命名空间，cmq为空 */ EnvironmentId?: string; /** * 主题，cmq为空，rocketmq查询死信时值为groupId */ TopicName?: string; /** * cmq必填，其他协议填空 */ QueueName?: string; /** * 消费组、订阅 */ GroupName?: string; /** * 查询死信时该值为true，只对Rocketmq有效 */ QueryDlqMsg?: boolean; } /** * SendBatchMessages请求参数结构体 */ export interface SendBatchMessagesRequest { /** * 消息要发送的topic的名字, 这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default */ Topic: string; /** * 需要发送消息的内容 */ Payload: string; /** * String 类型的 token，可以不填，系统会自动获取 */ StringToken?: string; /** * producer 的名字，要求全局是唯一的，如果不设置，系统会自动生成 */ ProducerName?: string; /** * 单位：s。消息发送的超时时间。默认值为：30s */ SendTimeout?: number; /** * 内存中允许缓存的生产消息的最大数量，默认值：1000条 */ MaxPendingMessages?: number; /** * 每一个batch中消息的最大数量，默认值：1000条/batch */ BatchingMaxMessages?: number; /** * 每一个batch最大等待的时间，超过这个时间，不管是否达到指定的batch中消息的数量和大小，都会将该batch发送出去，默认：10ms */ BatchingMaxPublishDelay?: number; /** * 每一个batch中最大允许的消息的大小，默认：128KB */ BatchingMaxBytes?: number; } /** * DescribeRabbitMQNodeList返回参数结构体 */ export interface DescribeRabbitMQNodeListResponse { /** * 集群列表数量 */ TotalCount?: number; /** * 集群列表注意：此字段可能返回 null，表示取不到有效值。 */ NodeList?: Array<RabbitMQPrivateNode>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RocketMQ主题配置信息 */ export interface RocketMQTopicConfig { /** * 命名空间 */ Namespace: string; /** * 主题名称 */ TopicName: string; /** * 主题类型： Normal，普通 PartitionedOrder, 分区顺序 Transaction，事务消息 DelayScheduled，延迟/定时消息 */ Type: string; /** * 分区个数 */ Partitions: number; /** * 备注信息 */ Remark?: string; } /** * 消息生产信息 */ export interface ProducerLog { /** * 消息ID。 */ MsgId?: string; /** * 生产者名称。 */ ProducerName?: string; /** * 消息生产时间。 */ ProduceTime?: string; /** * 生产者客户端。 */ ProducerAddr?: string; /** * 生产耗时（秒）。 */ ProduceUseTime?: number; /** * 状态。 */ Status?: string; } /** * DescribePublisherSummary请求参数结构体 */ export interface DescribePublisherSummaryRequest { /** * 集群ID */ ClusterId: string; /** * 命名空间名称 */ Namespace: string; /** * 主题名称 */ Topic: string; } /** * Pulsar专业版集群信息 */ export interface PulsarProClusterInfo { /** * 集群Id。 */ ClusterId?: string; /** * 集群名称。 */ ClusterName?: string; /** * 说明信息。 */ Remark?: string; /** * 创建时间 */ CreateTime?: string; /** * 集群状态，0:创建中，1:正常，2:隔离 */ Status?: number; /** * 集群版本 */ Version?: string; /** * 节点分布情况注意：此字段可能返回 null，表示取不到有效值。 */ NodeDistribution?: Array<InstanceNodeDistribution>; /** * 最大储存容量，单位：MB */ MaxStorage?: number; /** * 是否可以修改路由注意：此字段可能返回 null，表示取不到有效值。 */ CanEditRoute?: boolean; /** * 代表是专业版和小规格专业版的不同计费规格PULSAR.P1固定存储PULSAR.P2弹性存储注意：此字段可能返回 null，表示取不到有效值。 */ BillingLabelVersion?: string; /** * 实例到期时间戳，毫秒级精度。注意：此字段可能返回 null，表示取不到有效值。 */ ExpireTime?: number; /** * 是否开启自动创建主题 true就是开启了，false是关闭注意：此字段可能返回 null，表示取不到有效值。 */ AutoCreateTopicStatus?: boolean; /** * 自动创建主题的默认分区数，如果没开启就是0 注意：此字段可能返回 null，表示取不到有效值。 */ DefaultPartitionNumber?: number; /** * 用户自定义的租户别名，如果没有，会复用专业集群 ID */ Tenant?: string; } /** * ModifyRocketMQGroup返回参数结构体 */ export interface ModifyRocketMQGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 环境角色集合 */ export interface EnvironmentRole { /** * 环境（命名空间）。 */ EnvironmentId?: string; /** * 角色名称。 */ RoleName?: string; /** * 授权项，最多只能包含produce、consume两项的非空字符串数组。 */ Permissions?: Array<string>; /** * 角色描述。 */ RoleDescribe?: string; /** * 创建时间。 */ CreateTime?: string; /** * 更新时间。 */ UpdateTime?: string; } /** * ImportRocketMQTopics请求参数结构体 */ export interface ImportRocketMQTopicsRequest { /** * 导入topic */ Topics: Array<RocketMQTopicConfig>; /** * 任务ID */ TaskId: string; } /** * DeleteRabbitMQVipInstance返回参数结构体 */ export interface DeleteRabbitMQVipInstanceResponse { /** * 订单号Id */ TranId?: string; /** * 实例Id */ InstanceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Topic&Group维度的权限配置 */ export interface DetailedRolePerm { /** * 权限对应的资源 */ Resource: string; /** * 是否开启生产权限 */ PermWrite: boolean; /** * 是否开启消费权限 */ PermRead: boolean; /** * 授权资源类型（Topic:主题; Group:消费组） */ ResourceType: string; /** * 资源备注 */ Remark?: string; } /** * RabbitMQ集群访问信息 */ export interface RabbitMQClusterAccessInfo { /** * 集群公网接入地址注意：此字段可能返回 null，表示取不到有效值。 */ PublicAccessEndpoint?: string; /** * 集群控制台访问地址 */ WebConsoleEndpoint?: string; /** * 集群控制台登录用户名 */ WebConsoleUsername?: string; /** * 集群控制台登录密码 */ WebConsolePassword?: string; /** * 已废弃 */ PublicAccessEndpointStatus?: boolean; /** * 已废弃 */ PublicControlConsoleSwitchStatus?: boolean; /** * 已废弃 */ VpcControlConsoleSwitchStatus?: boolean; /** * Vpc管控台访问地址，示例值，http://1.1.1.1:15672 */ VpcWebConsoleEndpoint?: string; /** * 公网管控台开关状态，示例值，OFF/ON/CREATING/DELETING */ PublicWebConsoleSwitchStatus?: string; /** * Vpc管控台开关状态，示例值， OFF/ON/CREATING/DELETING */ VpcWebConsoleSwitchStatus?: string