@nocobase/plugin-verification

/** * DescribeRoles返回参数结构体 */ export interface DescribeRolesResponse { /** * 记录数。 */ TotalCount?: number; /** * 角色数组。 */ RoleSets?: Array<Role>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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 注意：此字段可能返回 null，表示取不到有效值。 */ PublicWebConsoleSwitchStatus?: string; /** * Vpc管控台开关状态，示例值， OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 */ VpcWebConsoleSwitchStatus?: string; /** * 公网管控台开关状态，示例值，OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 */ PublicDataStreamStatus?: string; /** * Prometheus信息注意：此字段可能返回 null，表示取不到有效值。 */ PrometheusEndpointInfo?: PrometheusEndpointInfo; } /** * DescribeBindClusters返回参数结构体 */ export interface DescribeBindClustersResponse { /** * 专享集群的数量 */ TotalCount: number; /** * 专享集群的列表 */ ClusterSet: Array<BindCluster>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRabbitMQVirtualHost返回参数结构体 */ export interface DescribeRabbitMQVirtualHostResponse { /** * 返回vhost数量 */ TotalCount?: number; /** * vhost详情列表 */ VirtualHostList?: Array<RabbitMQVirtualHostInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RabbiteMQ集群白名单信息 */ export interface RabbitMQClusterWhiteListInfo { /** * 废弃注意：此字段可能返回 null，表示取不到有效值。 */ WhiteList: string; /** * 公网管控台白名单注意：此字段可能返回 null，表示取不到有效值。 */ PublicControlConsoleWhiteList: string; /** * 公网数据流白名单注意：此字段可能返回 null，表示取不到有效值。 */ PublicDataStreamWhiteList: string; /** * 公网管控台白名单状态注意：此字段可能返回 null，表示取不到有效值。 */ PublicControlConsoleWhiteListStatus?: string; /** * 公网数据流白名单状态注意：此字段可能返回 null，表示取不到有效值。 */ PublicDataStreamWhiteListStatus?: string; } /** * CreateProCluster返回参数结构体 */ export interface CreateProClusterResponse { /** * 子订单号 */ DealName?: string; /** * 订单号 */ BigDealId?: string; /** * 集群Id */ ClusterId?: string; /** * 集群名称 */ ClusterName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * cmq DeadLetterPolicy */ export interface CmqDeadLetterPolicy { /** * 死信队列。注意：此字段可能返回 null，表示取不到有效值。 */ DeadLetterQueue: string; /** * 死信队列策略。注意：此字段可能返回 null，表示取不到有效值。 */ Policy: number; /** * 最大未消费过期时间。Policy为1时必选。范围300-43200，单位秒，需要小于消息最大保留时间MsgRetentionSeconds。注意：此字段可能返回 null，表示取不到有效值。 */ MaxTimeToLive: number; /** * 最大接收次数。注意：此字段可能返回 null，表示取不到有效值。 */ MaxReceiveCount: number; } /** * 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; } /** * DeleteRabbitMQUser请求参数结构体 */ export interface DeleteRabbitMQUserRequest { /** * 集群实例Id */ InstanceId: string; /** * 用户名，登录时使用 */ User: string; } /** * 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; } /** * DescribeSubscriptions请求参数结构体 */ export interface DescribeSubscriptionsRequest { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 主题名称。 */ TopicName: string; /** * Pulsar 集群的ID */ ClusterId: string; /** * 起始下标，不填默认为0。 */ Offset?: number; /** * 返回数量，不填则默认为10，最大值为20。 */ Limit?: number; /** * 订阅者名称，模糊匹配。 */ SubscriptionName?: string; /** * 数据过滤条件。 */ Filters?: Array<FilterSubscription>; } /** * DescribeRocketMQGroups请求参数结构体 */ export interface DescribeRocketMQGroupsRequest { /** * 集群ID */ ClusterId: string; /** * 命名空间 */ NamespaceId: string; /** * 偏移量 */ Offset: number; /** * 限制条数 */ Limit: number; /** * 主题名称，输入此参数可查询该主题下所有的订阅组 */ FilterTopic?: string; /** * 按消费组名称查询消费组，支持模糊查询 */ FilterGroup?: string; /** * 按照指定字段排序，可选值为tps，accumulative */ SortedBy?: string; /** * 按升序或降序排列，可选值为asc，desc */ SortOrder?: string; /** * 订阅组名称，指定此参数后将只返回该订阅组信息 */ FilterOneGroup?: string; /** * group类型 */ Types?: Array<string>; } /** * CreateRocketMQGroup请求参数结构体 */ export interface CreateRocketMQGroupRequest { /** * Group名称，8~64个字符 */ GroupId: string; /** * 命名空间，目前只支持单个命名空间 */ Namespaces: Array<string>; /** * 是否开启消费 */ ReadEnable: boolean; /** * 是否开启广播消费 */ BroadcastEnable: boolean; /** * 集群ID */ ClusterId: string; /** * 说明信息，最长128个字符 */ Remark?: string; /** * Group类型（TCP/HTTP） */ GroupType?: string; /** * Group最大重试次数 */ RetryMaxTimes?: number; } /** * CreateRocketMQNamespace请求参数结构体 */ export interface CreateRocketMQNamespaceRequest { /** * 集群ID */ ClusterId: string; /** * 命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_” */ NamespaceId: string; /** * 已废弃 */ Ttl?: number; /** * 已废弃 */ RetentionTime?: number; /** * 说明，最大128个字符 */ Remark?: string; } /** * ModifyRabbitMQVirtualHost请求参数结构体 */ export interface ModifyRabbitMQVirtualHostRequest { /** * 集群实例Id */ InstanceId: string; /** * vhost名 */ VirtualHost: string; /** * 描述 */ Description?: string; /** * 消息轨迹开关,true打开,false关闭 */ TraceFlag?: boolean; } /** * ModifyEnvironmentAttributes请求参数结构体 */ export interface ModifyEnvironmentAttributesRequest { /** * 命名空间名称。 */ EnvironmentId: string; /** * 未消费消息过期时间，单位：秒，范围60秒~15天。 */ MsgTTL: number; /** * 集群ID */ ClusterId: string; /** * 备注，字符串最长不超过128。 */ Remark?: string; /** * 消息保留策略 */ RetentionPolicy?: RetentionPolicy; /** * 是否开启自动创建订阅 */ AutoSubscriptionCreation?: boolean; } /** * DeleteCluster返回参数结构体 */ export interface DeleteClusterResponse { /** * 集群的ID */ ClusterId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetRocketMQConsumerOffSet返回参数结构体 */ export interface ResetRocketMQConsumerOffSetResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTopicMsgs返回参数结构体 */ export interface DescribeTopicMsgsResponse { /** * 总记录数。 */ TotalCount: number; /** * 消息日志列表。 */ TopicMsgLogSets: Array<MsgLog>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCmqSubscriptionAttribute返回参数结构体 */ export interface ModifyCmqSubscriptionAttributeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * 过滤参数 */ export interface Filter { /** * 过滤参数的名字 */ Name?: string; /** * 数值 */ Values?: Array<string>; } /** * ImportRocketMQTopics返回参数结构体 */ export interface ImportRocketMQTopicsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQMigratingTopicList请求参数结构体 */ export interface DescribeRocketMQMigratingTopicListRequest { /** * 迁移任务名称 */ TaskId: string; /** * 分页大小 */ Limit: number; /** * 偏移量 */ Offset: number; /** * 查询过滤器，支持topicname、MigrationStatus查询 */ Filters?: Array<Filter>; } /** * ModifyCluster返回参数结构体 */ export interface ModifyClusterResponse { /** * Pulsar 集群的ID */ ClusterId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * 用户专享集群信息 */ export interface BindCluster { /** * 物理集群的名称 */ ClusterName: string; } /** * ModifyRole返回参数结构体 */ export interface ModifyRoleResponse { /** * 角色名称 */ RoleName?: string; /** * 备注说明 */ Remark?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQTopicMsgs返回参数结构体 */ export interface DescribeRocketMQTopicMsgsResponse { /** * 总数 */ TotalCount?: number; /** * 消息列表 */ TopicMsgLogSets?: Array<RocketMQMsgLog>; /** * 标志一次分页事务注意：此字段可能返回 null，表示取不到有效值。 */ TaskRequestId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SendRocketMQMessage请求参数结构体 */ export interface SendRocketMQMessageRequest { /** * 集群id */ ClusterId: string; /** * 命名空间 */ NamespaceId: string; /** * topic名称 */ TopicName: string; /** * 信息内容 */ MsgBody: string; /** * 消息key信息 */ MsgKey?: string; /** * 消息tag信息 */ MsgTag?: string; } /** * DescribeRocketMQMsgTrace返回参数结构体 */ export interface DescribeRocketMQMsgTraceResponse { /** * [ { "Stage": "produce", "Data": { "ProducerName": "生产者名", "ProduceTime": "消息生产时间", "ProducerAddr": "客户端地址", "Duration": "耗时ms", "Status": "状态（0：成功，1：失败）" } }, { "Stage": "persist", "Data": { "PersistTime": "存储时间", "Duration": "耗时ms", "Status": "状态（0：成功，1：失败）" } }, { "Stage": "consume", "Data": { "TotalCount": 2, "RocketMqConsumeLogs": [ { "ConsumerGroup": "消费组", "ConsumeModel": "消费模式", "ConsumerAddr": "消费者地址", "ConsumeTime": "推送时间", "Status": "状态（0:已推送未确认, 2:已确认, 3:转入重试, 4:已重试未确认, 5:已转入死信队列）" }, { "ConsumerGroup": "消费组", "ConsumeModel": "消费模式", "ConsumerAddr": "消费者地址", "ConsumeTime": "推送时间", "Status": "状态（0:已推送未确认, 2:已确认, 3:转入重试, 4:已重试未确认, 5:已转入死信队列）" } ] } } ] */ Result?: Array<TraceResult>; /** * 消息轨迹页展示的topic名称 */ ShowTopicName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RabbitMQ专享版云服务器 */ export interface RabbitMQPrivateVirtualHost { /** * 虚拟主机的名字注意：此字段可能返回 null，表示取不到有效值。 */ VirtualHostName?: string; /** * 虚拟主机的描述注意：此字段可能返回 null，表示取不到有效值。 */ Description?: string; } /** * DescribeRocketMQPublicAccessPoint请求参数结构体 */ export interface DescribeRocketMQPublicAccessPointRequest { /** * 集群ID，当前只支持专享集群 */ InstanceId: string; } /** * SendMessages请求参数结构体 */ export interface SendMessagesRequest { /** * 消息要发送的topic的名字, 这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default */ Topic: string; /** * 要发送的消息的内容 */ Payload: string; /** * Token 是用来做鉴权使用的，可以不填，系统会自动获取 */ StringToken?: string; /** * 设置 producer 的名字，要求全局唯一。该参数建议用户无需手动配置，此时系统会随机生成，如果手动设置有可能会造成创建 Producer 失败进而导致消息发送失败。该参数主要用于某些特定场景下，只允许特定的 Producer 生产消息时设置，用户的大部分场景使用不到该特性。 */ ProducerName?: string; /** * 设置消息发送的超时时间，默认为30s */ SendTimeout?: number; /** * 内存中缓存的最大的生产消息的数量，默认为1000条 */ MaxPendingMessages?: number; } /** * RabbitMQ专享实例信息 */ export interface RabbitMQVipInstance { /** * 实例id */ InstanceId: string; /** * 实例名称 */ InstanceName: string; /** * 实例版本注意：此字段可能返回 null，表示取不到有效值。 */ 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; /** * 备注信息注意：此字段可能返回 null，表示取不到有效值。 */ Remark: string; /** * 实例配置ID */ SpecName: string; /** * 集群异常。注意：此字段可能返回 null，表示取不到有效值。 */ ExceptionInformation?: string; /** * 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败为了和计费区分开，额外开启一个状态位，用于显示。 */ ClusterStatus?: number; } /** * DescribeCmqQueues返回参数结构体 */ export interface DescribeCmqQueuesResponse { /** * 数量 */ TotalCount: number; /** * 队列列表注意：此字段可能返回 null，表示取不到有效值。 */ QueueList: Array<CmqQueue>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRabbitMQVipInstance请求参数结构体 */ export interface CreateRabbitMQVipInstanceRequest { /** * 可用区 */ ZoneIds: Array<number | bigint>; /** * 私有网络VpcId */ VpcId: string; /** * 私有网络SubnetId */ SubnetId: string; /** * 集群名称 */ ClusterName: string; /** * 节点规格,基础型rabbit-vip-basic-1,标准型rabbit-vip-basic-2,高阶1型rabbit-vip-basic-3,高阶2型rabbit-vip-basic-4。不传默认为基础型 */ NodeSpec?: string; /** * 节点数量,多可用区最少为3节点。不传默认单可用区为1,多可用区为3 */ NodeNum?: number; /** * 单节点存储规格,不传默认为200G */ StorageSize?: number; /** * 镜像队列,不传默认为false */ EnableCreateDefaultHaMirrorQueue?: boolean; /** * 自动续费,不传默认为true */ AutoRenewFlag?: boolean; /** * 购买时长,不传默认为1(月) */ TimeSpan?: number; } /** * DescribeAllTenants返回参数结构体 */ export interface DescribeAllTenantsResponse { /** * 总条数 */ TotalCount: number; /** * 虚拟集群列表 */ Tenants: Array<InternalTenant>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRabbitMQVirtualHost返回参数结构体 */ export interface CreateRabbitMQVirtualHostResponse { /** * vhost名 */ VirtualHost: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 消费者详情中的主题信息 */ export interface RocketMQConsumerTopic { /** * 主题名称 */ Topic: string; /** * 主题类型，Default表示普通，GlobalOrder表示全局顺序，PartitionedOrder表示局部顺序，Transaction表示事务，Retry表示重试，DeadLetter表示死信 */ Type: string; /** * 分区数 */ PartitionNum: number; /** * 消息堆积数 */ Accumulative: number; /** * 最后消费时间，以毫秒为单位 */ LastConsumptionTime: number; /** * 订阅规则注意：此字段可能返回 null，表示取不到有效值。 */ SubRule: 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; } /** * DescribeNamespaceBundlesOpt返回参数结构体 */ export interface DescribeNamespaceBundlesOptResponse { /** * 记录条数 */ TotalCount?: number; /** * bundle列表 */ BundleSet?: Array<BundleSetOpt>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReceiveMessage请求参数结构体 */ export interface ReceiveMessageRequest { /** * 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default */ Topic: string; /** * 订阅者的名字 */ SubscriptionName: string; /** * 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率 */ ReceiverQueueSize?: number; /** * 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest */ SubInitialPosition?: string; /** * 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy */ MaxNumMessages?: number; /** * 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy */ MaxNumBytes?: number; /** * 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy */ Timeout?: number; } /** * DescribeBindVpcs返回参数结构体 */ export interface DescribeBindVpcsResponse { /** * 记录数。 */ TotalCount?: number; /** * Vpc集合。 */ VpcSets?: Array<VpcBindRecord>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RewindCmqQueue返回参数结构体 */ export interface RewindCmqQueueResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQSmoothMigrationTask请求参数结构体 */ export interface DescribeRocketMQSmoothMigrationTaskRequest { /** * 任务ID */ TaskId: 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; } /** * cmq订阅返回参数 */ export interface CmqSubscription { /** * 订阅名字，在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionName?: string; /** * 订阅 ID。订阅 ID 在拉取监控数据时会用到。注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionId?: string; /** * 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。 */ TopicOwner?: number; /** * 该订阅待投递的消息数。注意：此字段可能返回 null，表示取不到有效值。 */ MsgCount?: number; /** * 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。注意：此字段可能返回 null，表示取不到有效值。 */ LastModifyTime?: number; /** * 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: number; /** * 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。 */ BindingKey?: Array<string>; /** * 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。注意：此字段可能返回 null，表示取不到有效值。 */ Endpoint?: string; /** * 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。注意：此字段可能返回 null，表示取不到有效值。 */ FilterTags?: Array<string>; /** * 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; /** * 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。注意：此字段可能返回 null，表示取不到有效值。 */ NotifyStrategy?: string; /** * 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。注意：此字段可能返回 null，表示取不到有效值。 */ NotifyContentFormat?: string; /** * 订阅所属的主题名称注意：此字段可能返回 null，表示取不到有效值。 */ TopicName?: string; } /** * DescribeRocketMQSourceClusterGroupList返回参数结构体 */ export interface DescribeRocketMQSourceClusterGroupListResponse { /** * group列表 */ Groups?: Array<RocketMQGroupConfigOutput>; /** * 总条数 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * rocketmq消息日志 */ export interface RocketMQMsgLog { /** * 消息id */ MsgId?: string; /** * 消息tag 注意：此字段可能返回 null，表示取不到有效值。 */ MsgTag?: string; /** * 消息key 注意：此字段可能返回 null，表示取不到有效值。 */ MsgKey?: string; /** * 客户端地址 */ ProducerAddr?: string; /** * 消息发送时间 */ ProduceTime?: string; /** * pulsar消息id */ PulsarMsgId?: string; /** * 死信重发次数注意：此字段可能返回 null，表示取不到有效值。 */ DeadLetterResendTimes?: number; /** * 死信重发成功次数注意：此字段可能返回 null，表示取不到有效值。 */ ResendSuccessCount?: number; } /** * SetRocketMQPublicAccessPoint返回参数结构体 */ export interface SetRocketMQPublicAccessPointResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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; } /** * 公网访问安全规则 */ export interface PublicAccessRule { /** * ip网段信息 */ IpRule: string; /** * 允许或者拒绝 */ Allow: boolean; /** * 备注信息注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; } /** * RocketMQ平滑迁移任务 */ export interface RocketMQSmoothMigrationTaskItem { /** * 任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId?: string; /** * 任务名称注意：此字段可能返回 null，表示取不到有效值。 */ TaskName?: string; /** * 源集群名称注意：此字段可能返回 null，表示取不到有效值。 */ SourceClusterName?: string; /** * 目标集群ID 注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId?: string; /** * 网络连接类型， PUBLIC 公网 VPC 私有网络 OTHER 其他注意：此字段可能返回 null，表示取不到有效值。 */ ConnectionType?: string; /** * 源集群NameServer地址注意：此字段可能返回 null，表示取不到有效值。 */ SourceNameServer?: string; /** * 任务状态 Configuration 迁移配置 SourceConnecting 连接源集群中 MetaDataImport 元数据导入 EndpointSetup 切换接入点 ServiceMigration 切流中 Completed 已完成 Cancelled 已取消注意：此字段可能返回 null，表示取不到有效值。 */ TaskStatus?: string; } /** * vpc信息（由UniqVpcId和UniqSubnetId组成） */ export interface VpcInfo { /** * vpc信息 */ VpcId: string; /** * 子网信息 */ SubnetId: string; } /** * ModifyRabbitMQUser请求参数结构体 */ export interface ModifyRabbitMQUserRequest { /** * 集群实例Id */ InstanceId: string; /** * 用户名，登录时使用 */ User: string; /** * 密码，登录时使用 */ Password: string; /** * 描述，不传则不修改 */ Description?: string; /** * 用户标签，用于决定改用户访问RabbitMQ Management的权限范围，不传则不修改 */ Tags?: Array<string>; /** * 该用户的最大连接数，不传则不修改 */ MaxConnections?: number; /** * 该用户的最大channel数，不传则不修改 */ MaxChannels?: number; } /** * DescribeRocketMQConsumeStats返回参数结构体 */ export interface DescribeRocketMQConsumeStatsResponse { /** * 消费详情列表 */ ConsumerStatsList?: Array<ConsumerStats>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCmqTopic返回参数结构体 */ export interface DeleteCmqTopicResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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; } /** * DeleteProCluster请求参数结构体 */ export interface DeleteProClusterRequest { /** * 集群Id */ ClusterId: string; } /** * RocketMQ消费组订阅信息 */ export interface RocketMQSubscription { /** * 主题名称 */ Topic?: string; /** * 主题类型： Normal 普通, GlobalOrder 全局顺序, PartitionedOrder 局部顺序, Transaction 事务消息, DelayScheduled 延时消息, Retry 重试, DeadLetter 死信注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 分区数注意：此字段可能返回 null，表示取不到有效值。 */ PartitionNum?: number; /** * 过滤模式，TAG，SQL 注意：此字段可能返回 null，表示取不到有效值。 */ ExpressionType?: string; /** * 过滤表达式注意：此字段可能返回 null，表示取不到有效值。 */ SubString?: string; /** * 订阅状态： 0，订阅关系一致 1，订阅关系不一致 2，未知注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 消费堆积数量注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerLag?: number; /** * 实例ID 注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId?: string; /** * 消费组名称注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerGroup?: string; /** * 是否在线注意：此字段可能返回 null，表示取不到有效值。 */ IsOnline?: boolean; /** * 消费类型注意：此字段可能返回 null，表示取不到有效值。 */ ConsumeType?: number; /** * 订阅一致性注意：此字段可能返回 null，表示取不到有效值。 */ Consistency?: number; /** * 最后消费进度更新时间，秒为单位注意：此字段可能返回 null，表示取不到有效值。 */ LastUpdateTime?: number; /** * 最大重试次数注意：此字段可能返回 null，表示取不到有效值。 */ MaxRetryTimes?: number; /** * 协议类型注意：此字段可能返回 null，表示取不到有效值。 */ ClientProtocol?: string; } /** * RabbitMQ的vhost详情 */ export interface RabbitMQVirtualHostInfo { /** * 集群实例Id */ InstanceId?: string; /** * vhost名 */ VirtualHost?: string; /** * vhost描述信息注意：此字段可能返回 null，表示取不到有效值。 */ Description?: string; /** * vhost标签注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<string>; /** * 创建时间注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 修改时间注意：此字段可能返回 null，表示取不到有效值。 */ ModifyTime?: string; /** * vhost概览统计信息注意：此字段可能返回 null，表示取不到有效值。 */ VirtualHostStatistics?: RabbitMQVirtualHostStatistics; /** * vhost状态，与原生控制台对应，有running、partial、stopped、unknown 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: string; /** * 消息堆积数注意：此字段可能返回 null，表示取不到有效值。 */ MessageHeapCount?: number; /** * 输入消息速率注意：此字段可能返回 null，表示取不到有效值。 */ MessageRateIn?: number; /** * 输出消息速率注意：此字段可能返回 null，表示取不到有效值。 */ MessageRateOut?: number; } /** * 实例节点分布信息 */ export interface InstanceNodeDistribution { /** * 可用区 */ ZoneName: string; /** * 可用区id */ ZoneId: string; /** * 节点数 */ NodeCount: number; } /** * exchange使用配额信息 */ export interface ExchangeQuota { /** * 可创建最大exchange数 */ MaxExchange?: number; /** * 已创建exchange数注意：此字段可能返回 null，表示取不到有效值。 */ UsedExchange?: number; } /** * DescribeCmqTopicDetail返回参数结构体 */ export interface DescribeCmqTopicDetailResponse { /** * 主题详情 */ TopicDescribe: CmqTopic; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyRabbitMQVirtualHost返回参数结构体 */ export interface ModifyRabbitMQVirtualHostResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetRocketMQPublicAccessPoint请求参数结构体 */ export interface SetRocketMQPublicAccessPointRequest { /** * 集群ID，当前只支持专享集群 */ InstanceId: string; /** * 开启或关闭访问 */ Enabled: boolean; /** * 带宽大小，开启或者调整公网时必须指定，Mbps为单位 */ Bandwidth?: number; /** * 付费模式，开启公网时必须指定，0为按小时计费，1为包年包月，当前只支持按小时计费 */ PayMode?: number; /** * 公网访问安全规则列表，Enabled为true时必须传入 */ Rules?: Array<PublicAccessRule>; } /** * cmq 批量queue属性信息 */ export interface CmqQueue { /** * 消息队列ID。 */ QueueId: string; /** * 消息队列名字。 */ QueueName: string; /** * 每秒钟生产消息条数的限制，消费消息的大小是该值的1.1倍。注意：此字段可能返回 null，表示取不到有效值。 */ Qps: number; /** * 带宽限制。注意：此字段可能返回 null，表示取不到有效值。 */ Bps: number; /** * 飞行消息最大保留时间。注意：此字段可能返回 null，表示取不到有效值。 */ MaxDelaySeconds: number; /** * 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。 */ MaxMsgHeapNum: number; /** * 消息接收长轮询等待时间。取值范围0 - 30秒，默认值0。注意：此字段可能返回 null，表示取不到有效值。 */ PollingWaitSeconds: number; /** * 消息保留周期。取值范围60-1296000秒（1min-15天），默认值345600秒（4 天）。注意：此字段可能返回 null，表示取不到有效值。 */ MsgRetentionSeconds: number; /** * 消息可见性超时。取值范围1 - 43200秒（即12小时内），默认值30。注意：此字段可能返回 null，表示取不到有效值。 */ VisibilityTimeout: number; /** * 消息最大长度。取值范围1024 - 1048576 Byte（即1K - 1024K），默认值65536。注意：此字段可能返回 null，表示取不到有效值。 */ MaxMsgSize: number; /** * 回溯队列的消息回溯时间最大值，取值范围0 - 43200秒，0表示不开启消息回溯。注意：此字段可能返回 null，表示取不到有效值。 */ RewindSeconds: number; /** * 队列的创建时间。返回 Unix 时间戳，精确到毫秒。注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime: number; /** * 最后一次修改队列属性的时间。返回 Unix 时间戳，精确到毫秒。注意：此字段可能返回 null，表示取不到有效值。 */ LastModifyTime: number; /** * 在队列中处于 Active 状态（不处于被消费状态）的消息总数，为近似值。注意：此字段可能返回 null，表示取不到有效值。 */ ActiveMsgNum: number; /** * 在队列中处于 Inactive 状态（正处于被消费状态）的消息总数，为近似值。注意：此字段可能返回 null，表示取不到有效值。 */ InactiveMsgNum: number; /** * 延迟消息数。注意：此字段可能返回 null，表示取不到有效值。 */ DelayMsgNum: number; /** * 已调用 DelMsg 接口删除，但还在回溯保留时间内的消息数量。注意：此字段可能返回 null，表示取不到有效值。 */ RewindMsgNum: number; /** * 消息最小未消费时间，单位为秒。注意：此字段可能返回 null，表示取不到有效值。 */ MinMsgTime: number; /** * 事务消息队列。true表示是事务消息，false表示不是事务消息。注意：此字段可能返回 null，表示取不到有效值。 */ Transaction: boolean; /** * 死信队列。注意：此字段可能返回 null，表示取不到有效值。 */ DeadLetterSource: Array<CmqDeadLetterSource>; /** * 死信队列策略。注意：此字段可能返回 null，表示取不到有效值。 */ DeadLetterPolicy: CmqDeadLetterPolicy; /** * 事务消息策略。注意：此字段可能返回 null，表示取不到有效值。 */ TransactionPolicy: CmqTransactionPolicy; /** * 创建者Uin。注意：此字段可能返回 null，表示取不到有效值。 */ CreateUin: number; /** * 关联的标签。注意：此字段可能返回 null，表示取不到有效值。 */ Tags: Array<Tag>; /** * 消息轨迹。true表示开启，false表示不开启。注意：此字段可能返回 null，表示取不到有效值。 */ Trace: boolean; /** * 租户id 注意：此字段可能返回 null，表示取不到有效值。 */ TenantId: string; /** * 命名空间名称注意：此字段可能返回 null，表示取不到有效值。 */ NamespaceName: string; /** * 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * 最大未确认消息数量注意：此字段可能返回 null，表示取不到有效值。 */ MaxUnackedMsgNum: number; /** * 最大消息堆积大小（字节）注意：此字段可能返回 null，表示取不到有效值。 */ MaxMsgBacklogSize: number; /** * 队列可回溯存储空间，取值范围1024MB - 10240MB，0表示不开启注意：此字段可能返回 null，表示取不到有效值。 */ RetentionSizeInMB: number; } /** * CreateEnvironment返回参数结构体 */ export interface CreateEnvironmentResponse { /** * 环境（命名空间）名称。 */ EnvironmentId?: string; /** * 未消费消息过期时间，单位：秒。 */ MsgTTL?: number; /** * 说明，128个字符以内。注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 命名空间ID */ NamespaceId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * vhost概览统计信息 */ export interface RabbitMQVirtualHostStatistics { /** * 当前vhost的queue数量 */ CurrentQueues?: number; /** * 当前vhost的exchange数量 */ CurrentExchanges?: number; /** * 当前vhost的连接数量 */ CurrentConnections?: number; /** * 当前vhost的channel数量 */ CurrentChannels?: number; /** * 当前vhost的用户数量 */ CurrentUsers?: number; } /** * CreateSubscription返回参数结构体 */ export interface CreateSubscriptionResponse { /** * 创建结果。 */ Result?: boolean; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEnvironmentRole请求参数结构体 */ export interface ModifyEnvironmentRoleRequest { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 角色名称。 */ RoleName: string; /** * 授权项，最多只能包含produce、consume两项的非空字符串数组。 */ Permissions: Array<string>; /** * 必填字段，集群的ID */ ClusterId: string; } /** * DescribeRabbitMQQueues返回参数结构体 */ export interface DescribeRabbitMQQueuesResponse { /** * 列表信息注意：此字段可能返回 null，表示取不到有效值。 */ QueueInfoList?: Array<RabbitMQQueueListInfo>; /** * 数量注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SendMsg返回参数结构体 */ export interface SendMsgResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCmqTopicAttribute返回参数结构体 */ export interface ModifyCmqTopicAttributeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCmqSubscriptionDetail请求参数结构体 */ export interface DescribeCmqSubscriptionDetailRequest { /** * 主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。 */ TopicName?: string; /** * 分页时本页获取主题列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0 */ Offset?: number; /** * 分页时本页获取主题的个数，如果不传递该参数，则该参数默认为20，最大值为50。 */ Limit?: number; /** * 根据SubscriptionName进行模糊搜索 */ SubscriptionName?: string; /** * 队列名称，订阅绑定的endpoint */ QueueName?: string; /** * 查询类型。取值：（1）topic；（2）queue。默认值是topic。如果 queryType 是 topic，则查询主题下的订阅列表；如果 queryType 是 queue，则查询队列绑定的订阅列表。 */ QueryType?: string; } /** * DescribePublisherSummary返回参数结构体 */ export interface DescribePublisherSummaryResponse { /** * 生产速率（条/秒）注意：此字段可能返回 null，表示取不到有效值。 */ MsgRateIn: number; /** * 生产速率（字节/秒）注意：此字段可能返回 null，表示取不到有效值。 */ MsgThroughputIn: number; /** * 生产者数量注意：此字段可能返回 null，表示取不到有效值。 */ PublisherCount: number; /** * 消息存储大小，以字节为单位注意：此字段可能返回 null，表示取不到有效值。 */ StorageSize: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * DescribeRocketMQTopics请求参数结构体 */ export interface DescribeRocketMQTopicsRequest { /** * 查询偏移量 */ Offset: number; /** * 查询限制数 */ Limit: number; /** * 集群ID */ ClusterId: string; /** * 命名空间 */ NamespaceId: string; /** * 按主题类型过滤查询结果，可选择Normal, GlobalOrder, PartitionedOrder, Transaction */ FilterType?: Array<string>; /** * 按主题名称搜索，支持模糊查询 */ FilterName?: string; } /** * ModifyRocketMQCluster返回参数结构体 */ export interface ModifyRocketMQClusterResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 订阅者 */ export interface Subscription { /** * 主题名称。 */ TopicName: string; /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。 */ ConnectedSince: string; /** * 消费者地址。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerAddr: string; /** * 消费者数量。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerCount: string; /** * 消费者名称。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerName: string; /** * 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。 */ MsgBacklog: string; /** * 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。 */ MsgRateExpired: string; /** * 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。 */ MsgRateOut: string; /** * 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。 */ MsgThroughputOut: string; /** * 订阅名称。注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionName: string; /** * 消费者集合。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerSets: Array<Consumer>; /** * 是否在线。注意：此字段可能返回 null，表示取不到有效值。 */ IsOnline: boolean; /** * 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumersScheduleSets: Array<ConsumersSchedule>; /** * 备注。注意：此字段可能返回 null，表示取不到有效值。 */ Remark: string; /** * 创建时间。注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime: string; /** * 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime: string; /** * 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。 */ SubType: string; /** * 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。 */ BlockedSubscriptionOnUnackedMsgs: boolean; /** * 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。 */ MaxUnackedMsgNum: number; } /** * DescribeCmqQueueDetail返回参数结构体 */ export interface DescribeCmqQueueDetailResponse { /** * 队列详情列表。 */ QueueDescribe?: CmqQueue; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * ClearCmqQueue请求参数结构体 */ export interface ClearCmqQueueRequest { /** * 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。 */ QueueName: string; } /** * ModifyEnvironmentAttributes返回参数结构体 */ export interface ModifyEnvironmentAttributesResponse { /** * 命名空间名称。 */ EnvironmentId?: string; /** * 未消费消息过期时间，单位：秒。 */ MsgTTL?: number; /** * 备注，字符串最长不超过128。注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 */ NamespaceId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQSubscriptions返回参数结构体 */ export interface DescribeRocketMQSubscriptionsResponse { /** * 总条数 */ TotalCount: number; /** * 订阅关系列表注意：此字段可能返回 null，表示取不到有效值。 */ Subscriptions: Array<RocketMQSubscription>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusters请求参数结构体 */ export interface DescribeClustersRequest { /** * 起始下标，不填默认为0。 */ Offset?: number; /** * 返回数量，不填则默认为10，最大值为20。 */ Limit?: number; /** * 集群ID列表过滤 */ ClusterIdList?: Array<string>; /** * 是否标签过滤 */ IsTagFilter?: boolean; /** * 过滤器。目前支持按标签过滤。 */ Filters?: Array<Filter>; } /** * 订阅关系 */ export interface SubscriptionTopic { /** * 环境（命名空间）名称。 */ EnvironmentId: string; /** * 主题名称。 */ TopicName: string; /** * 订阅名称。 */ SubscriptionName: string; } /** * RocketMQ主题信息 */ export interface RocketMQTopic { /** * 主题名称 */ Name?: string; /** * 主题的类别，为枚举类型，Normal，GlobalOrder，PartitionedOrder，Transaction，Retry及DeadLetter */ Type?: string; /** * 订阅组数量 */ GroupNum?: number; /** * 说明注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 读写分区数 */ PartitionNum?: number; /** * 创建时间，以毫秒为单位 */ CreateTime?: number; /** * 创建时间，以毫秒为单位 */ UpdateTime?: number; /** * 最后写入时间，单位为秒注意：此字段可能返回 null，表示取不到有效值。 */ LastUpdateTime?: number; /** * 订阅数量注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionCount?: number; /** * 订阅关系列表注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionData?: Array<RocketMQSubscription>; } /** * DescribeRocketMQCluster返回参数结构体 */ export interface DescribeRocketMQClusterResponse { /** * 集群信息 */ ClusterInfo?: RocketMQClusterInfo; /** * 集群配置 */ ClusterConfig?: RocketMQClusterConfig; /** * 集群最近使用量，即将废弃，请使用腾讯云可观测平台获取相关数据。注意：此字段可能返回 null，表示取不到有效值。 */ ClusterStats?: RocketMQClusterRecentStats; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRocketMQVipInstance返回参数结构体 */ export interface DeleteRocketMQVipInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCmqSubscriptionDetail返回参数结构体 */ export interface DescribeCmqSubscriptionDetailResponse { /** * 总数 */ TotalCount?: number; /** * Subscription属性集合注意：此字段可能返回 null，表示取不到有效值。 */ SubscriptionSet?: Array<CmqSubscription>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Pulsar专业版实例信息 */ export interface PulsarProInstance { /** * 实例id */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 实例版本 */ InstanceVersion?: string; /** * 实例状态，0-创建中，1-正常，2-隔离中，3-已销毁，4 - 异常, 5 - 发货失败，6-变配中，7-变配失败 */ Status?: number; /** * 实例配置规格名称 */ ConfigDisplay?: string; /** * 峰值TPS */ MaxTps?: number; /** * 存储容量，GB为单位 */ MaxStorage?: number; /** * 实例到期时间，毫秒为单位 */ ExpireTime?: number; /** * 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) */ AutoRenewFlag?: number; /** * 0-后付费，1-预付费 */ PayMode?: number; /** * 备注信息注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 实例配置ID */ SpecName?: string; /** * 规格外弹性TPS 注意：此字段可能返回 null，表示取不到有效值。 */ ScalableTps?: number; /** * VPC的id 注意：此字段可能返回 null，表示取不到有效值。 */ VpcId?: string; /** * 子网id 注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId?: string; /** * 峰值带宽。单位：mbps */ MaxBandWidth?: number; /** * 集群的标签列表注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * 集群创建时间注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; } /** * vcp绑定记录 */ export interface VpcBindRecord { /** * 租户Vpc Id */ UniqueVpcId: string; /** * 租户Vpc子网Id */ UniqueSubnetId: string; /** * 路由Id */ RouterId: string; /** * Vpc的Id */ Ip: string; /** * Vpc的Port */ Port: number; /** * 说明，128个字符以内注意：此字段可能返回 null，表示取不到有效值。 */ Remark: string; } /** * RewindCmqQueue请求参数结构体 */ export interface RewindCmqQueueRequest { /** * 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。 */ QueueName: string; /** * 设定该时间，则（Batch）receiveMessage接口，会按照生产消息的先后顺序消费该时间戳以后的消息。 */ StartConsumeTime: number; } /** * DescribeRabbitMQUser返回参数结构体 */ export interface DescribeRabbitMQUserResponse { /** * 返回的User数量 */ TotalCount: number; /** * 当前已创建的RabbitMQ用户列表 */ RabbitMQUserList: Array<RabbitMQUser>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRocketMQMsg返回参数结构体 */ export interface DescribeRocketMQMsgResponse { /** * 消息体 */ Body?: string; /** * 详情参数 */ Properties?: string; /** * 生产时间 */ ProduceTime?: string; /** * 消息id */ MsgId?: string; /** * 生产者地址 */ ProducerAddr?: string; /** * 消费组消费情况注意：此字段可能返回 null，表示取不到有效值。 */ MessageTracks?: Array<RocketMQMessageTrack>; /** * 详情页展示的topic名称注意：此字段可能返回 null，表示取不到有效值。 */ ShowTopicName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCluster请求参数结构体 */ export interface ModifyClusterRequest { /** * Pulsar 集群的ID，需要更新的集群Id。 */ ClusterId: string; /** * 更新后的集群名称。 */ ClusterName?: string; /** * 说明信息。 */ Remark?: string; /** * 开启公网访问，只能为true */ PublicAccessEnabled?: boolean; } /** * Desc