tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,030 lines (1,926 loc) • 220 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** AMQP集群配置 */
declare 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;
}
/** 租户AMQP集群详细信息 */
declare interface AMQPClusterDetail {
/** 集群基本信息 */
Info?: AMQPClusterInfo;
/** 集群配置信息 */
Config?: AMQPClusterConfig;
/** 标签 */
Tags?: Tag[];
/** 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 */
Status?: number;
}
/** AMQP集群基本信息 */
declare interface AMQPClusterInfo {
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 地域信息 */
Region?: string;
/** 创建时间,毫秒为单位 */
CreateTime?: number;
/** 集群说明信息 */
Remark?: string | null;
/** 公网接入地址 */
PublicEndPoint?: string | null;
/** VPC接入地址 */
VpcEndPoint?: string | null;
}
/** 用户专享集群信息 */
declare interface BindCluster {
/** 物理集群的名称 */
ClusterName?: string;
}
/** Pulsar集群TLS证书信息 */
declare interface CertificateInfo {
/** SSL证书管理中的id */
CertificateId: string;
/** 证书到期时间 */
ExpireTime: string;
/** 证书绑定的域名 */
DomainName: string;
/** 证书状态:0 已签发1 即将过期2 未启用3 已过期4 不可用 */
Status: string;
/** 证书类型:0:根证书,1:服务端证书 */
Type: string;
/** TencentCloud:SSL证书;Default:TDMQ官方默认证书 */
Origin: string;
/** 证书添加/更新时间 */
ModifyTime: string;
}
/** 客户端订阅详情,可用于辅助判断哪些客户端订阅关系不一致 */
declare interface ClientSubscriptionInfo {
/** 客户端ID */
ClientId?: string;
/** 客户端IP */
ClientAddr?: string | null;
/** 订阅主题 */
Topic?: string | null;
/** 订阅表达式 */
SubString?: string | null;
/** 订阅方式 */
ExpressionType?: string | null;
}
/** 集群信息集合 */
declare interface Cluster {
/** 集群Id。 */
ClusterId?: string;
/** 集群名称。 */
ClusterName?: string;
/** 说明信息。 */
Remark?: string;
/** 接入点数量 */
EndPointNum?: number;
/** 创建时间 */
CreateTime?: string;
/** 集群是否健康,1表示健康,0表示异常 */
Healthy?: number;
/** 集群健康信息 */
HealthyInfo?: string | null;
/** 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 */
Status?: number;
/** 最大命名空间数量 */
MaxNamespaceNum?: number;
/** 最大Topic数量 */
MaxTopicNum?: number;
/** 最大QPS */
MaxQps?: number;
/** 最大消息保留时间,秒为单位 */
MessageRetentionTime?: number;
/** 最大存储容量 */
MaxStorageCapacity?: number;
/** 集群版本 */
Version?: string | null;
/** 公网访问接入点 */
PublicEndPoint?: string | null;
/** VPC访问接入点 */
VpcEndPoint?: string | null;
/** 命名空间数量 */
NamespaceNum?: number | null;
/** 已使用存储限制,MB为单位 */
UsedStorageBudget?: number | null;
/** 最大生产消息速率,以条数为单位 */
MaxPublishRateInMessages?: number | null;
/** 最大推送消息速率,以条数为单位 */
MaxDispatchRateInMessages?: number | null;
/** 最大生产消息速率,以字节为单位 */
MaxPublishRateInBytes?: number | null;
/** 最大推送消息速率,以字节为单位 */
MaxDispatchRateInBytes?: number | null;
/** 已创建主题数 */
TopicNum?: number | null;
/** 最长消息延时,以秒为单位 */
MaxMessageDelayInSeconds?: number | null;
/** 是否开启公网访问,不填时默认开启 */
PublicAccessEnabled?: boolean | null;
/** 标签 */
Tags?: Tag[] | null;
/** 计费模式:0: 按量计费1: 包年包月 */
PayMode?: number | null;
/** 项目ID */
ProjectId?: number | null;
/** 项目名字 */
ProjectName?: string | null;
/** 是否支持升级专业版实例 */
UpgradeProInstance?: boolean;
}
/** cmq DeadLetterPolicy */
declare interface CmqDeadLetterPolicy {
/** 死信队列。 */
DeadLetterQueue?: string;
/** 死信队列策略。0:最大接收次数;1:最大未消费时间 */
Policy?: number;
/** 最大未消费过期时间。Policy为1时必选。范围300-43200,单位秒,需要小于消息最大保留时间MsgRetentionSeconds。 */
MaxTimeToLive?: number;
/** 最大接收次数。Policy为0时必选,范围在1到1000。 */
MaxReceiveCount?: number;
}
/** Cmq DeadLetterSource */
declare interface CmqDeadLetterSource {
/** 消息队列ID。 */
QueueId?: string | null;
/** 消息队列名字。 */
QueueName?: string;
}
/** cmq 批量queue属性信息 */
declare interface CmqQueue {
/** 消息队列ID。 */
QueueId?: string;
/** 消息队列名字。 */
QueueName?: string;
/** 每秒钟生产消息条数的限制,消费消息的大小是该值的1.1倍。 */
Qps?: number;
/** 带宽限制。 */
Bps?: number;
/** 飞行消息最大保留时间,需要小于消息保留周期。 */
MaxDelaySeconds?: number;
/** 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。 */
MaxMsgHeapNum?: number;
/** 消息接收长轮询等待时间。取值范围0 - 30秒,默认值0。 */
PollingWaitSeconds?: number;
/** 消息保留周期。取值范围60-1296000秒(1min-15天),默认值345600秒(4 天)。 */
MsgRetentionSeconds?: number;
/** 消息可见性超时。取值范围1 - 43200秒(即12小时内),默认值30。 */
VisibilityTimeout?: number;
/** 消息最大长度。取值范围1024 - 1048576 Byte(即1K - 1024K),默认值65536。 */
MaxMsgSize?: number;
/** 回溯队列的消息回溯时间最大值,取值范围0 - 43200秒,0表示不开启消息回溯。 */
RewindSeconds?: number;
/** 队列的创建时间。返回 Unix 时间戳,精确到毫秒。 */
CreateTime?: number;
/** 最后一次修改队列属性的时间。返回 Unix 时间戳,精确到毫秒。 */
LastModifyTime?: number;
/** 在队列中处于 Active 状态(不处于被消费状态)的消息总数,为近似值。 */
ActiveMsgNum?: number;
/** 在队列中处于 Inactive 状态(正处于被消费状态)的消息总数,为近似值。 */
InactiveMsgNum?: number;
/** 延迟消息数。 */
DelayMsgNum?: number | null;
/** 已调用 DelMsg 接口删除,但还在回溯保留时间内的消息数量。 */
RewindMsgNum?: number | null;
/** 消息最小未消费时间,单位为秒。 */
MinMsgTime?: number | null;
/** 事务消息队列。true表示是事务消息,false表示不是事务消息。 */
Transaction?: boolean | null;
/** 死信队列。 */
DeadLetterSource?: CmqDeadLetterSource[] | null;
/** 死信队列策略。 */
DeadLetterPolicy?: CmqDeadLetterPolicy | null;
/** 事务消息策略。 */
TransactionPolicy?: CmqTransactionPolicy | null;
/** 创建者Uin。 */
CreateUin?: number | null;
/** 关联的标签。 */
Tags?: Tag[] | null;
/** 消息轨迹。true表示开启,false表示不开启。 */
Trace?: boolean | null;
/** 租户id */
TenantId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 */
Status?: number;
/** 最大未确认消息数量 */
MaxUnackedMsgNum?: number;
/** 最大消息堆积大小(字节) */
MaxMsgBacklogSize?: number;
/** 队列可回溯存储空间,取值范围1024MB - 10240MB,0表示不开启 */
RetentionSizeInMB?: number;
}
/** cmq订阅返回参数 */
declare interface CmqSubscription {
/** 订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 */
SubscriptionName?: string;
/** 订阅 ID。订阅 ID 在拉取监控数据时会用到。 */
SubscriptionId?: string;
/** 订阅拥有者的 APPID。 */
TopicOwner?: number | null;
/** 该订阅待投递的消息数。 */
MsgCount?: number;
/** 最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到毫秒。 */
LastModifyTime?: number;
/** 订阅的创建时间。返回 Unix 时间戳,精确到毫秒。 */
CreateTime?: number;
/** 表示订阅接收消息的过滤策略。 */
BindingKey?: string[] | null;
/** 接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以http://开头,host 可以是域名或 IP;对于 queue,则填 queueName。 */
Endpoint?: string;
/** 描述用户创建订阅时选择的过滤策略:filterType = 1表示用户使用 filterTag 标签过滤filterType = 2表示用户使用 bindingKey 过滤。 */
FilterTags?: string[];
/** 订阅的协议,目前支持两种协议:HTTP、queue。使用 HTTP 协议,用户需自己搭建接受消息的 Web Server。使用 queue,消息会自动推送到 CMQ queue,用户可以并发地拉取消息。 */
Protocol?: string;
/** 向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有:(1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;(2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。 */
NotifyStrategy?: string;
/** 推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。 */
NotifyContentFormat?: string;
/** 订阅所属的主题名称 */
TopicName?: string;
}
/** cmq topic返回信息展示字段 */
declare interface CmqTopic {
/** 主题的 ID。 */
TopicId?: string;
/** 主题名称。 */
TopicName?: string;
/** 消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。固定为一天(86400秒),该属性不能修改。 */
MsgRetentionSeconds?: number;
/** 消息最大长度。取值范围1024 - 1048576Byte(即1 - 1024K),默认值为1048576。 */
MaxMsgSize?: number;
/** 每秒钟发布消息的条数。 */
Qps?: number;
/** 描述用户创建订阅时选择的过滤策略:FilterType = 1表示用户使用 FilterTag 标签过滤;FilterType = 2表示用户使用 BindingKey 过滤。 */
FilterType?: number;
/** 主题的创建时间。返回 Unix 时间戳,精确到毫秒。 */
CreateTime?: number;
/** 最后一次修改主题属性的时间。返回 Unix 时间戳,精确到毫秒。 */
LastModifyTime?: number;
/** 当前该主题中消息数目(消息堆积数)。 */
MsgCount?: number;
/** 创建者 Uin,CAM 鉴权 resource 由该字段组合而成。 */
CreateUin?: number | null;
/** 关联的标签。 */
Tags?: Tag[] | null;
/** 消息轨迹。true表示开启,false表示不开启。 */
Trace?: boolean | null;
/** 租户id */
TenantId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 */
Status?: number;
/** 0表示pulsar,1表示rocketmq */
BrokerType?: number;
/** 订阅数量 */
SubscriptionCount?: number;
}
/** cmq TransactionPolicy */
declare interface CmqTransactionPolicy {
/** 第一次回查时间。 */
FirstQueryInterval?: number;
/** 最大查询次数。 */
MaxQueryCount?: number;
}
/** 消费者 */
declare interface Consumer {
/** 消费者开始连接的时间。 */
ConnectedSince?: string | null;
/** 消费者地址。 */
ConsumerAddr?: string | null;
/** 消费者名称。 */
ConsumerName?: string | null;
/** 消费者版本。 */
ClientVersion?: string | null;
/** 消费者连接的主题分区号 */
Partition?: number | null;
}
/** 消费日志 */
declare interface ConsumerLog {
/** 消息ID。 */
MsgId: string;
/** 消费组。 */
ConsumerGroup: string;
/** 消费者名称。 */
ConsumerName: string;
/** 消费时间。 */
ConsumeTime: string;
/** 消费者客户端地址。 */
ConsumerAddr: string;
/** 消费耗时(毫秒)。 */
ConsumeUseTime: number;
/** 消费状态。 */
Status: string;
}
/** 消费信息 */
declare interface ConsumerLogs {
/** 记录数。 */
TotalCount?: number | null;
/** 消费日志。 */
ConsumerLogSets?: ConsumerLog[] | null;
}
/** 消费详情 */
declare interface ConsumerStats {
/** 主题名 */
TopicName?: string | null;
/** 所属Broker */
BrokerName?: string | null;
/** 队列编号 */
QueueId?: number | null;
/** 消费者ID */
ConsumerClientId?: string | null;
/** 消费位点 */
ConsumerOffset?: number | null;
/** 服务端位点 */
BrokerOffset?: number | null;
/** 消息堆积条数 */
DiffTotal?: number | null;
/** 最近消费时间 */
LastTimestamp?: number | null;
}
/** 消费进度详情 */
declare interface ConsumersSchedule {
/** 当前分区id。 */
Partitions?: number | null;
/** 消息数量。 */
NumberOfEntries?: number | null;
/** 消息积压数量。 */
MsgBacklog?: number | null;
/** 消费者每秒分发消息的数量之和。 */
MsgRateOut?: string;
/** 消费者每秒消息的byte。 */
MsgThroughputOut?: string;
/** 超时丢弃比例。 */
MsgRateExpired?: string | null;
}
/** Topic&Group维度的权限配置 */
declare interface DetailedRolePerm {
/** 权限对应的资源 */
Resource: string;
/** 是否开启生产权限 */
PermWrite: boolean;
/** 是否开启消费权限 */
PermRead: boolean;
/** 授权资源类型(Topic:主题; Group:消费组) */
ResourceType: string;
/** 资源备注 */
Remark?: string;
}
/** 实例维度组合数组 */
declare interface DimensionInstance {
/** 实例的维度组合 */
Dimensions: DimensionOpt[] | null;
}
/** 指标维度对象 */
declare interface DimensionOpt {
/** 查询的维度名称 */
Name: string | null;
/** 查询维度的值 */
Value: string | null;
}
/** 命名空间信息 */
declare interface Environment {
/** 命名空间名称 */
EnvironmentId?: string;
/** 说明 */
Remark?: string;
/** 未消费消息过期时间,单位:秒,最大1296000(15天) */
MsgTTL?: number;
/** 创建时间 */
CreateTime?: string;
/** 最近修改时间 */
UpdateTime?: string;
/** 命名空间ID */
NamespaceId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** Topic数量 */
TopicNum?: number | null;
/** 消息保留策略 */
RetentionPolicy?: RetentionPolicy | null;
/** 是否自动创建订阅 */
AutoSubscriptionCreation?: boolean | null;
}
/** 环境角色集合 */
declare interface EnvironmentRole {
/** 环境(命名空间)。 */
EnvironmentId?: string;
/** 角色名称。 */
RoleName?: string;
/** 授权项,最多只能包含produce、consume两项的非空字符串数组。 */
Permissions?: string[];
/** 角色描述。 */
RoleDescribe?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
}
/** 批量绑定名字空间和角色权限关系 */
declare interface EnvironmentRoleSet {
/** 需要绑定的命名空间Id,不重复且存在资源 */
EnvironmentId: string | null;
/** 名字空间需要绑定的权限,枚举为 "consume" "produce" 组合,但是不为空 */
Permissions: string[] | null;
}
/** exchange使用配额信息 */
declare interface ExchangeQuota {
/** 可创建最大exchange数 */
MaxExchange?: number;
/** 已创建exchange数 */
UsedExchange?: number;
}
/** 过滤参数 */
declare interface Filter {
/** 过滤参数的名字 */
Name?: string;
/** 数值 */
Values?: string[];
}
/** 过滤订阅列表 */
declare interface FilterSubscription {
/** 是否仅展示包含真实消费者的订阅。 */
ConsumerHasCount?: boolean;
/** 是否仅展示消息堆积的订阅。 */
ConsumerHasBacklog?: boolean;
/** 是否仅展示存在消息超期丢弃的订阅。 */
ConsumerHasExpired?: boolean;
/** 按照订阅名过滤,精确查询。 */
SubscriptionNames?: string[];
}
/** 实例节点分布信息 */
declare interface InstanceNodeDistribution {
/** 可用区 */
ZoneName?: string;
/** 可用区id */
ZoneId?: string;
/** 节点数 */
NodeCount?: number;
/** 有调度任务且没有切回的可用区,此标识为true */
NodePermWipeFlag?: boolean;
/** 可用区状态 */
ZoneStatus?: string | null;
}
/** 面向运营端的虚拟集群信息 */
declare 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为单位 */
MaxDispatchRateInBytes?: number | null;
/** 命名空间最大生产带宽,byte为单位 */
MaxPublishRateInBytes?: number | null;
/** 消息最大保留空间,MB为单位 */
MaxRetentionSizeInMB?: number | null;
/** public Access Enabled */
PublicAccessEnabled?: boolean | null;
}
/** 迁移topic列表数据 */
declare interface MigrateTopic {
/** 命名空间 */
Namespace?: string | null;
/** topic名称 */
TopicName?: string | null;
/** 迁移状态S_RW_D_NA 源集群读写S_RW_D_R 源集群读写目标集群读S_RW_D_RW 源集群读写目标集群读写S_R_D_RW 源集群读目标集群读写S_NA_D_RW 目标集群读写 */
MigrationStatus?: string | null;
/** 是否完成健康检查 */
HealthCheckPassed?: boolean | null;
/** 上次健康检查返回的错误信息,仅在HealthCheckPassed为false时有效。NotChecked 未执行检查,Unknown 未知错误,TopicNotImported 主题未导入, TopicNotExistsInSourceCluster 主题在源集群中不存在, TopicNotExistsInTargetCluster 主题在目标集群中不存在, ConsumerConnectedOnTarget 目标集群上存在消费者连接, SourceTopicHasNewMessagesIn5Minutes 源集群主题前5分钟内有新消息写入,TargetTopicHasNewMessagesIn5Minutes 目标集群主题前5分钟内有新消息写入, SourceTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入,TargetTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, ConsumerGroupCountNotMatch 订阅组数量不一致, SourceTopicHasUnconsumedMessages 源集群主题存在未消费消息, */
HealthCheckError?: string | null;
}
/** 消息日志 */
declare interface MsgLog {
/** 消息ID。 */
MsgId?: string;
/** 生产者名称。 */
ProducerName?: string;
/** 生产时间。 */
ProduceTime?: string;
/** 生产客户端地址。 */
ProducerAddr?: string;
}
/** 分区topic */
declare interface PartitionsTopic {
/** 最后一次间隔内发布消息的平均byte大小。 */
AverageMsgSize?: string | null;
/** 消费者数量。 */
ConsumerCount?: string | null;
/** 被记录下来的消息总数。 */
LastConfirmedEntry?: string | null;
/** 最后一个ledger创建的时间。 */
LastLedgerCreatedTimestamp?: string | null;
/** 本地和复制的发布者每秒发布消息的速率。 */
MsgRateIn?: string | null;
/** 本地和复制的消费者每秒分发消息的数量之和。 */
MsgRateOut?: string | null;
/** 本地和复制的发布者每秒发布消息的byte。 */
MsgThroughputIn?: string | null;
/** 本地和复制的消费者每秒分发消息的byte。 */
MsgThroughputOut?: string | null;
/** 被记录下来的消息总数。 */
NumberOfEntries?: string | null;
/** 子分区id。 */
Partitions?: number | null;
/** 生产者数量。 */
ProducerCount?: string | null;
/** 以byte计算的所有消息存储总量。 */
TotalSize?: string | null;
/** topic类型描述。 */
TopicType?: number | null;
}
/** 生产者客户端详情 */
declare interface ProducerInfo {
/** 客户端ID */
ClientId?: string | null;
/** 客户端IP */
ClientIp?: string | null;
/** 客户端语言JAVA((byte) 0), CPP((byte) 1), DOTNET((byte) 2), PYTHON((byte) 3), DELPHI((byte) 4), ERLANG((byte) 5), RUBY((byte) 6), OTHER((byte) 7), HTTP((byte) 8), GO((byte) 9), PHP((byte) 10), OMS((byte) 11); */
Language?: string | null;
/** 客户端版本 */
Version?: string | null;
/** 最后生产时间 */
LastUpdateTimestamp?: number | null;
}
/** 消息生产信息 */
declare interface ProducerLog {
/** 消息ID。 */
MsgId?: string;
/** 生产者名称。 */
ProducerName?: string;
/** 消息生产时间。 */
ProduceTime?: string;
/** 生产者客户端。 */
ProducerAddr?: string;
/** 生产耗时(秒)。 */
ProduceUseTime?: number;
/** 状态。 */
Status?: string;
}
/** rabbitmq Prometheus信息 */
declare interface PrometheusEndpointInfo {
/** Prometheus开关的状态。 */
PrometheusEndpointStatus?: string | null;
/** prometheus信息 */
VpcPrometheusEndpoint?: string[] | null;
/** 节点信息 */
NodePrometheusAddress?: string[] | null;
/** vpc信息 */
VpcEndpointInfo?: VpcEndpointInfo | null;
}
/** 公网访问安全规则 */
declare interface PublicAccessRule {
/** ip网段信息 */
IpRule: string;
/** 允许或者拒绝 */
Allow: boolean;
/** 备注信息 */
Remark?: string | null;
}
/** 生产者信息 */
declare interface Publisher {
/** 生产者id */
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 | null;
}
/** Pulsar 网络接入点信息 */
declare interface PulsarNetworkAccessPointInfo {
/** vpc的id,支撑网和公网接入点,该字段为空 */
VpcId?: string | null;
/** 子网id,支撑网和公网接入点,该字段为空 */
SubnetId?: string | null;
/** 接入地址 */
Endpoint?: string;
/** 实例id */
InstanceId?: string;
/** 接入点类型:0:支撑网接入点 1:VPC接入点 2:公网接入点 */
RouteType?: number;
/** 0:本地域访问,由于并没有配置跨地域容灾,所该类型的接入点,无法进行异地切换、异地访问切回;1:本地域访问,由于配置了跨地域容灾,随时可以进行异地切换,该状态用于主集群的接入点2:跨地域访问,已经完成了异地切换,该状态用于源集群的接入点,该状态下的接入点不可删除3:跨地域访问,随时可以进行异地访问切回,该状态用于目标集群的接入点,该状态下的接入点不可删除4:跨地域访问,目标集群已经完成异地切回,等待删除状态 */
OperationType?: number | null;
/** 接入点类型 */
AccessPointsType?: string | null;
/** 带宽,目前只有公网会有这个值 */
Bandwidth?: number | null;
/** 类 */
SecurityPolicy?: SecurityPolicy[] | null;
/** 是否是标准的接入点 true是标准的 false不是标准的 */
StandardAccessPoint?: boolean | null;
/** 可用区信息 */
ZoneName?: string | null;
/** 是否开启TLS加密 */
Tls?: boolean;
/** 接入点自定义域名 */
CustomUrl?: string;
}
/** Pulsar专业版集群信息 */
declare interface PulsarProClusterInfo {
/** 集群Id。 */
ClusterId?: string;
/** 集群名称。 */
ClusterName?: string;
/** 说明信息。 */
Remark?: string;
/** 创建时间 */
CreateTime?: string;
/** 集群状态,0:创建中,1:正常,2:隔离 */
Status?: number;
/** 集群版本 */
Version?: string;
/** 节点分布情况 */
NodeDistribution?: InstanceNodeDistribution[] | null;
/** 最大储存容量,单位:MB */
MaxStorage?: number;
/** 是否可以修改路由 */
CanEditRoute?: boolean | null;
/** 代表是专业版和小规格专业版的不同计费规格PULSAR.P1固定存储PULSAR.P2弹性存储 */
BillingLabelVersion?: string | null;
/** 实例到期时间戳,毫秒级精度。 */
ExpireTime?: number | null;
/** 是否开启自动创建主题true就是开启了,false是关闭 */
AutoCreateTopicStatus?: boolean | null;
/** 自动创建主题的默认分区数,如果没开启就是0 */
DefaultPartitionNumber?: number | null;
/** 用户自定义的租户别名,如果没有,会复用专业集群 ID */
Tenant?: string;
/** 删除保护开关标识 */
DeleteProtection?: number;
}
/** Pulsar专业版集群规格信息 */
declare interface PulsarProClusterSpecInfo {
/** 集群规格名称 */
SpecName?: string;
/** 峰值tps */
MaxTps?: number;
/** 峰值带宽。单位:mbps */
MaxBandWidth?: number;
/** 最大命名空间个数 */
MaxNamespaces?: number;
/** 最大主题分区数 */
MaxTopics?: number;
/** 规格外弹性TPS */
ScalableTps?: number | null;
/** 32或者128当前集群topic的最大分区数 */
MaxPartitions?: number | null;
/** 商品最大延迟消息数量。0代表没有限制 */
MaxDelayedMessages?: number;
}
/** Pulsar专业版实例信息 */
declare 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;
/** 备注信息 */
Remark?: string | null;
/** 实例配置ID */
SpecName?: string;
/** 规格外弹性TPS */
ScalableTps?: number | null;
/** VPC的id */
VpcId?: string | null;
/** 子网id */
SubnetId?: string | null;
/** 峰值带宽。单位:mbps */
MaxBandWidth?: number;
/** 集群的标签列表 */
Tags?: Tag[] | null;
/** 集群创建时间 */
CreateTime?: string | null;
/** 代表是专业版和小规格专业版的不同计费规格PULSAR.P1固定存储PULSAR.P2弹性存储 */
BillingLabelVersion?: string | null;
/** 自定义租户 */
Tenant?: string;
/** 集群的证书列表 */
CertificateList?: CertificateInfo[];
}
/** queue使用配额信息 */
declare interface QueueQuota {
/** 可创建最大Queue数 */
MaxQueue?: number;
/** 已创建Queue数 */
UsedQueue?: number;
}
/** RabbitMQ 路由关系列表成员 */
declare interface RabbitMQBindingListInfo {
/** 路由关系id */
BindingId?: number;
/** VhostName */
VirtualHost?: string;
/** 源exchange名称 */
Source?: string;
/** 目标类型,queue或exchange */
DestinationType?: string;
/** 目标资源名称 */
Destination?: string;
/** 绑定key */
RoutingKey?: string;
/** 源exchange类型 */
SourceExchangeType?: string;
/** 创建时间 */
CreateTime?: string;
/** 修改时间 */
ModifyTime?: string;
/** 创建时间时间戳 */
CreateTs?: number;
/** 修改时间时间戳 */
ModifyTs?: number;
}
/** RabbitMQ集群访问信息 */
declare interface RabbitMQClusterAccessInfo {
/** 集群公网接入地址 */
PublicAccessEndpoint?: string | null;
/** 集群控制台访问地址 */
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;
/** 公网管控台开关状态,示例值,OFF/ON/CREATING/DELETING */
PublicDataStreamStatus?: string;
/** Prometheus信息 */
PrometheusEndpointInfo?: PrometheusEndpointInfo;
/** 公网域名接入点 */
WebConsoleDomainEndpoint?: string;
/** 控制面所使用的VPC信息 */
ControlPlaneEndpointInfo?: VpcEndpointInfo;
/** TLS加密的数据流公网接入点 */
PublicTlsAccessEndpoint?: string;
}
/** RabbitMQ 集群基本信息 */
declare interface RabbitMQClusterInfo {
/** 集群 ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 地域信息 */
Region?: string;
/** 创建时间,毫秒为单位。unix 时间戳 */
CreateTime?: number;
/** 集群说明信息 */
Remark?: string;
/** VPC及网络信息 */
Vpcs?: VpcEndpointInfo[];
/** 可用区信息 */
ZoneIds?: number[];
/** 虚拟主机数量 */
VirtualHostNumber?: number;
/** 队列数量 */
QueueNumber?: number;
/** 每秒生产消息数 单位:条/秒 */
MessagePublishRate?: number;
/** 堆积消息数 单位:条 */
MessageStackNumber?: number;
/** 实例到期时间,按量付费的资源该值为 0,毫秒为单位。unix 时间戳 */
ExpireTime?: number;
/** Channel数量 */
ChannelNumber?: number;
/** Connection数量 */
ConnectionNumber?: number;
/** Consumer数量 */
ConsumerNumber?: number;
/** Exchang数量 */
ExchangeNumber?: number;
/** 集群异常信息 */
ExceptionInformation?: string | null;
/** 实例状态,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;
/** 开始隔离时间。unix 时间戳 */
IsolatedTime?: number;
/** 是否为容器实例,默认 true */
Container?: boolean;
/** 标签列表 */
Tags?: Tag[];
/** 是否已开启删除保护 */
EnableDeletionProtection?: boolean;
}
/** RabbitMQ集群规格信息 */
declare interface RabbitMQClusterSpecInfo {
/** 集群规格名称 */
SpecName: string;
/** 节点数量 */
NodeCount: number;
/** 峰值tps */
MaxTps: number;
/** 峰值带宽。单位:mbps */
MaxBandWidth: number;
/** 存储容量。单位:GB */
MaxStorage: number;
/** 公网带宽tps。单位:Mbps */
PublicNetworkTps: number;
}
/** RabbiteMQ集群白名单信息 */
declare interface RabbitMQClusterWhiteListInfo {
/** 废弃 */
WhiteList?: string;
/** 公网管控台白名单 */
PublicControlConsoleWhiteList?: string;
/** 公网数据流白名单 */
PublicDataStreamWhiteList?: string;
/** 公网管控台白名单状态 */
PublicControlConsoleWhiteListStatus?: string | null;
/** 公网数据流白名单状态 */
PublicDataStreamWhiteListStatus?: string | null;
}
/** RabbitMQ exchange列表成员信息 */
declare interface RabbitMQExchangeListInfo {
/** exchange 名称 */
ExchangeName?: string;
/** 备注说明 */
Remark?: string | null;
/** exchange 类型, 支持 "fanout","direct","topic","headers" */
ExchangeType?: string;
/** 交换机所属 Virtual Host 名称 */
VirtualHost?: string;
/** exchange 创建者, "system":"系统创建", "user":"用户创建" */
ExchangeCreator?: string;
/** exchange 创建时间 */
CreateTimeStamp?: string;
/** exchange 修改时间 */
ModTimeStamp?: string;
/** 输入消息速率 */
MessageRateIn?: number | null;
/** 输出消息速率 */
MessageRateOut?: number | null;
/** 是否为持久化交换机,true 为持久化,false 为非持久化 */
Durable?: boolean;
/** 是否为自动删除交换机,true 为自动删除,false 为非自动删除 */
AutoDelete?: boolean;
/** 是否为内部交换机,true 为内部交换机 */
Internal?: boolean;
/** 交换机所属实例 ID */
InstanceId?: string;
/** 生效的策略名称 */
Policy?: string | null;
/** 扩展参数 key-value 对象 */
Arguments?: string;
/** 未调度的延时消息数量 */
MessagesDelayed?: number | null;
/** 创建时间时间戳 */
CreateTs?: number;
/** 修改时间时间戳 */
ModifyTs?: number;
}
/** RabbitMQ权限详情 */
declare 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;
}
/** RabbitMQ 节点信息 */
declare interface RabbitMQPrivateNode {
/** 节点名字 */
NodeName?: string | null;
/** 节点状态,running 运行中,down 异常 */
NodeStatus?: string | null;
/** CPU使用率 */
CPUUsage?: string | null;
/** 内存使用情况,单位MB */
Memory?: number | null;
/** 磁盘使用率 */
DiskUsage?: string | null;
/** Rabbitmq的Erlang进程数 */
ProcessNumber?: number | null;
}
/** RabbitMQ队列列表消费者信息 */
declare interface RabbitMQQueueListConsumerDetailInfo {
/** 消费者数量 */
ConsumersNumber?: number | null;
}
/** RabbitMQ队列列表成员信息 */
declare interface RabbitMQQueueListInfo {
/** 队列名 */
QueueName?: string;
/** 备注说明 */
Remark?: string | null;
/** 消费者信息 */
ConsumerDetail?: RabbitMQQueueListConsumerDetailInfo;
/** 队列类型,取值 "classic","quorum" */
QueueType?: string;
/** 消息堆积数 */
MessageHeapCount?: number | null;
/** 消息生产速率,每秒 */
MessageRateIn?: number | null;
/** 消息消费速率,每秒 */
MessageRateOut?: number | null;
/** 创建时间 */
CreateTime?: string;
/** 修改时间 */
ModifyTime?: string;
/** 队列是否持久化,true 为持久化,false 为非持久化 */
Durable?: boolean;
/** 队列是否为自动删除队列,true 为自动删除,false 为非自动删除 */
AutoDelete?: boolean;
/** 队列所属实例 ID */
InstanceId?: string;
/** 队列所属虚拟主机名称 */
VirtualHost?: string;
/** 队列所在主节点名称 */
Node?: string;
/** 生效的策略名称 */
Policy?: string | null;
/** 扩展参数 key-value 对象 */
Arguments?: string;
/** 是否独占队列 */
Exclusive?: boolean;
/** 创建时间时间戳 */
CreateTs?: number;
/** 修改时间时间戳 */
ModifyTs?: number;
}
/** RabbitMQ用户实体详情 */
declare interface RabbitMQUser {
/** 实例 ID,形如 amqp-xxxxxxxx。有效的 InstanceId 可通过登录 [TDMQ RabbitMQ 控制台](https://console.cloud.tencent.com/trabbitmq/cluster?rid=1)查询。 */
InstanceId?: string;
/** 用户名,登录时使用 */
User?: string;
/** 密码,登录时使用 */
Password?: string;
/** 用户描述 */
Description?: string;
/** 用户标签,用于决定改用户访问RabbitMQ Management的权限范围 */
Tags?: string[];
/** 用户创建时间 */
CreateTime?: string;
/** 用户最后修改时间 */
ModifyTime?: string;
/** 用户类型,System:系统创建,User:用户创建 */
Type?: string;
/** 单个用户最大可用连接数 */
MaxConnections?: number | null;
/** 单个用户最大可用通道数 */
MaxChannels?: number | null;
/** 创建时间时间戳 */
CreateTs?: number;
/** 修改时间时间戳 */
ModifyTs?: number;
}
/** RabbitMQ 实例用户配额信息 */
declare interface RabbitMQUserQuota {
/** 最大可创建用户数 */
MaxUser?: number;
/** 已使用用户数 */
UsedUser?: number;
}
/** RabbitMQ 托管版实例信息 */
declare 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;
/** 实例到期时间,按量付费的资源该值为 0,毫秒为单位。unix 时间戳 */
ExpireTime?: number;
/** 自动续费标记,0表示默认状态(用户未设置,即初始状态即手动续费), 1表示自动续费,2表示明确不自动续费(用户设置) */
AutoRenewFlag?: number;
/** 1 表示预付费,0 表示后付费 */
PayMode?: number;
/** 备注信息 */
Remark?: string;
/** 集群的节点规格,需要输入对应的规格标识:2C8G:rabbit-vip-basic-2c8g4C16G:rabbit-vip-basic-4c16g8C32G:rabbit-vip-basic-8c32g16C32G:rabbit-vip-basic-416C64G:rabbit-vip-basic-16c64g2C4G:rabbit-vip-basic-54C8G:rabbit-vip-basic-18C16G(已售罄):rabbit-vip-basic-2不传默认为4C8G:rabbit-vip-basic-1 */
SpecName?: string;
/** 集群异常信息 */
ExceptionInformation?: string | null;
/** 实例状态,0表示创建中,1表示正常,2表示隔离中,3表示已销毁,4 - 异常, 5 - 发货失败为了和计费区分开,额外开启一个状态位,用于显示。 */
ClusterStatus?: number;
/** 公网接入点 */
PublicAccessEndpoint?: string | null;
/** VPC 接入点列表 */
Vpcs?: VpcEndpointInfo[];
/** 创建时间,毫秒为单位。unix 时间戳 */
CreateTime?: number;
/** 实例类型,0 托管版、1 Serverless 版 */
InstanceType?: number;
/** 隔离时间,毫秒为单位。unix 时间戳 */
IsolatedTime?: number;
/** 是否已开启删除保护 */
EnableDeletionProtection?: boolean;
/** 标签列表 */
Tags?: Tag[];
}
/** RabbitMQ的vhost详情 */
declare interface RabbitMQVirtualHostInfo {
/** 集群实例Id */
InstanceId?: string;
/** vhost名 */
VirtualHost?: string;
/** vhost描述信息 */
Description?: string;
/** vhost标签 */
Tags?: string[];
/** 创建时间 */
CreateTime?: string;
/** 修改时间 */
ModifyTime?: string;
/** vhost概览统计信息 */
VirtualHostStatistics?: RabbitMQVirtualHostStatistics;
/** 消息轨迹开关,true打开,false关闭 */
TraceFlag?: boolean;
/** vhost状态,与原生控制台对应,有running、partial、stopped、unknown */
Status?: string;
/** 消息堆积数 */
MessageHeapCount?: number;
/** 输入消息速率 */
MessageRateIn?: number;
/** 输出消息速率 */
MessageRateOut?: number;
/** 是否存在镜像队列策略,true 为存在,false 为不存 */
MirrorQueuePolicyFlag?: boolean;
/** 创建时间时间戳 */
CreateTs?: number;
/** 修改时间时间戳 */
ModifyTs?: number;
}
/** vhost概览统计信息 */
declare interface RabbitMQVirtualHostStatistics {
/** 当前vhost的queue数量 */
CurrentQueues?: number;
/** 当前vhost的exchange数量 */
CurrentExchanges?: number;
/** 当前vhost的连接数量 */
CurrentConnections?: number;
/** 当前vhost的channel数量 */
CurrentChannels?: number;
/** 当前vhost的用户数量 */
CurrentUsers?: number;
}
/** 消息保留策略 */
declare interface RetentionPolicy {
/** 消息保留时长 */
TimeInMinutes: number;
/** 消息保留大小 */
SizeInMB: number;
}
/** RocketMQ集群配置 */
declare interface RocketMQClusterConfig {
/** 单命名空间TPS上限 */
MaxTpsPerNamespace?: number;
/** 最大命名空间数量 */
MaxNamespaceNum?: number;
/** 已使用命名空间数量 */
UsedNamespaceNum?: number;
/** 最大Topic数量 */
MaxTopicNum?: number;
/** 已使用Topic数量 */
UsedTopicNum?: number;
/** 最大Group数量 */
MaxGroupNum?: number;
/** 已使用Group数量 */
UsedGroupNum?: number;
/** 消息最大保留时间,以毫秒为单位 */
MaxRetentionTime?: number;
/** 消息最长延时,以毫秒为单位 */
MaxLatencyTime?: number;
/** 单个主题最大队列数 */
MaxQueuesPerTopic?: number | null;
/** topic分布 */
TopicDistribution?: RocketMQTopicDistribution[] | null;
/** 最大角色数量 */
MaxRoleNum?: number;
/** TPS限额 */
MaxTpsLimit?: number;
}
/** 租户RocketMQ集群详细信息 */
declare interface RocketMQClusterDetail {
/** 集群基本信息 */
Info: RocketMQClusterInfo;
/** 集群配置信息 */
Config: RocketMQClusterConfig;
/** 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 */
Status: number | null;
}
/** RocketMQ集群基本信息 */
declare interface RocketMQClusterInfo {
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 地域信息 */
Region?: string;
/** 创建时间,毫秒为单位 */
CreateTime?: number;
/** 集群说明信息 */
Remark?: string | null;
/** 公网接入地址 */
PublicEndPoint?: string;
/** VPC接入地址 */
VpcEndPoint?: string;
/** 是否支持命名空间接入点 */
SupportNamespaceEndpoint?: boolean | null;
/** VPC信息 */
Vpcs?: VpcConfig[] | null;
/** 是否为专享实例 */
IsVip?: boolean | null;
/** Rocketmq集群标识 */
RocketMQFlag?: boolean | null;
/** 计费状态,1表示正常,2表示已停服,3表示已销毁 */
Status?: number | null;
/** 欠费停服时间,毫秒为单位 */
IsolateTime?: number | null;
/** HTTP协议公网接入地址 */
HttpPublicEndpoint?: string | null;
/** HTTP协议VPC接入地址 */
HttpVpcEndpoint?: string | null;
/** TCP内部接入地址 */
InternalEndpoint?: string | null;
/** HTTP协议内部接入地址 */
HttpInternalEndpoint?: string | null;
/** 是否开启ACL鉴权,专享实例支持关闭 */
AclEnabled?: boolean | null;
/** 公网CLB实例ID */
PublicClbId?: string | null;
/** vip */
Vip?: string | null;
/** 所属VPC */
VpcId?: string | null;
/** 是否支持迁移 */
SupportMigration?: boolean | null;
/** 实例状态,0表示创建中,1表示正常,2表示隔离中,3表示已销毁,4 - 异常, 5 - 发货失败,6 - 变配中,7 - 变配失败 */
InstanceStatus?: number | null;
/** 集群所属可用区,表明集群归属的可用区 */
ZoneId?: number | null;
/** 集群节点所在的可用区,若该集群为跨可用区集群,则包含该集群节点所在的多个可用区。 */
ZoneIds?: number[] | null;
/** 是否已冻结 */
IsFrozen?: boolean;
/** 是否开启自动创建主题 */
AutoCreateTopicEnabled?: boolean;
/** 是否开启集群Admin能力 */
AdminFeatureEnabled?: boolean;
/** Admin AK */
AdminAccessKey?: string | null;
/** Admin SK */
AdminSecretKey?: string | null;
/** 是否开启删除保护 */
EnableDeletionProtection?: boolean;
}
/** RocketMQ近期使用量 */
declare interface RocketMQClusterRecentStats {
/** Topic数量 */
TopicNum: number;
/** 消息生产数 */
ProducedMsgNum: number;
/** 消息消费数 */
ConsumedMsgNum: number;
/** 消息堆积数 */
AccumulativeMsgNum: number;
}
/** 在线消费者情况 */
declare interface RocketMQConsumerConnection {
/** 消费者实例ID */
ClientId?: string;
/** 消费者实例的地址和端口 */
ClientAddr?: string;
/** 消费者应用的语言版本 */
Language?: string;
/** 消息堆积量 */
Accumulative?: number;
/** 消费端版本 */
Version?: string;
}
/** 消费者详情中的主题信息 */
declare interface RocketMQConsumerTopic {
/** 主题名称 */
Topic?: string;
/** 主题类型,Normal表示普通,GlobalOrder表示全局顺序,PartitionedOrder表示局部顺序,Transaction表示事务,Retry表示重试,DeadLetter表示死信 */
Type?: string;
/** 分区数 */
PartitionNum?: number;
/** 消息堆积数 */
Accumulative?: number;
/** 最后消费时间,以毫秒为单位 */
LastConsumptionTime?: number;
/** 订阅规则 */
SubRule?: string | null;
}
/** 监控数据点 */
declare interface RocketMQDataPoint {
/** 监控值数组,该数组和Timestamps一一对应 */
Timestamps?: number[] | null;
/** 监控数据点位置,比如一天按分钟划分有1440个点,每个点的序号是0 - 1439之间的一个数,当某个序号不在该数组中,说明掉点了 */
Values?: number[] | null;
}
/** RocketMQ消费组信息 */
declare interface RocketMQGroup {
/** 消费组名称 */
Name?: string;
/** 在线消费者数量 */
ConsumerNum?: number;
/** 消费TPS */
TPS?: number;
/** 总堆积数量 */
TotalAccumulative?: number;
/** 0表示集群消费模式,1表示广播消费模式,-1表示未知 */
ConsumptionMode?: number;
/** 是否允许消费 */
ReadEnabled?: boolean;
/** 重试队列分区数 */
RetryPartitionNum?: number | null;
/** 创建时间,以毫秒为单位 */
CreateTime?: number;
/** 修改时间,以毫秒为单位 */
UpdateTime?: number;
/** 客户端协议 */
ClientProtocol?: string;
/** 说明信息 */
Remark?: string | null;
/** 消费者类型,枚举值ACTIVELY, PASSIVELY */
ConsumerType?: string | null;
/** 是否开启广播消费 */
BroadcastEnabled?: boolean;
/** Group类型 */
GroupType?: string | null;
/** 重试次数 */
RetryMaxTimes?: number | null;
/** 实例ID */
InstanceId?: string | null;
/** 命名空间 */
Namespace?: string | null;
/** 订阅的主题个数 */
SubscribeTopicNum?: number;
}
/** RocketMQ消费组配置信息 */
declare interface RocketMQGroupConfig {
/** 命名空间 */
Namespace: string;
/** 消费组名称 */
GroupName: string;
/** 是否开启广播消费 */
ConsumeBroadcastEnable: boolean;
/** 是否开启消费 */
ConsumeEnable: boolean;
/** 备注信息 */
Remark?: string;
/** 协议类型,支持以下枚举值TCP;HTTP; */
ConsumerGroupType?: string;
}
/** RocketMQ消费组配置信息 */
declare interface RocketMQGroupConfigOutput {
/** 命名空间 */
Namespace?: string | null;
/** 消费组名称 */
GroupName?: string | null;
/** 是否已导入 */
Imported?: boolean | null;
/** remark */
Remark?: string | null;
}
/** RocketMQ专享集群实例配置 */
declare interface RocketMQInstanceConfig {
/** 单命名空间TPS上线 */
MaxTpsPerNamespace?: number;
/** 最大命名空间数量 */
MaxNamespaceNum?: number;
/** 已使用命名空间数量 */
UsedNamespaceNum?: number;
/** 最大Topic数量 */
MaxTopicNum?: number;
/** 已使用Topic数量 */
UsedTopicNum?: number;
/** 最大Group数量 */
MaxGroupNum?: number;
/** 已使用Group数量 */
UsedGroupNum?: number;
/** 集群类型 */
ConfigDisplay?: string;
/** 集群节点数 */
NodeCount?: number;
/** 节点分布情况 */
NodeDistribution?: InstanceNodeDistribution[];
/** topic分布情况 */
TopicDistribution?: RocketMQTopicDistribution[];
/** 每个主题最大队列数 */
MaxQueuesPerTopic?: number | null;
/** 最大可设置消息保留时间,小时为单位 */
MaxRetention?: number | null;
/** 最小可设置消息保留时间,小时为单位 */
MinRetention?: number | null;
/** 实例消息保留时间,小时为单位 */
Retention?: number | null;
/** Topic个数最小配额,即免费额度,默认为集群规格单节点最小配额*节点个数 */
TopicNumLowerLimit?: number | null;
/** Topic个数最大配额,默认为集群规格单节点最大配额*节点个数 */
TopicNumUpperLimit?: number | null;
}
/** Rocketmq消息消费track信息 */
declare interface RocketMQMessageTrack {
/** 消费者组 */
Group?: string;
/** 消费状态,CONSUMED: 已消费CONSUMED_BUT_FILTERED: 已过滤NOT_CONSUME: 未消费ENTER_RETRY: 进入重试队列ENTER_DLQ: 进入死信队列UNKNOWN: 查询不到消费状态 */
ConsumeStatus?: string;
/** 消息track类型 */
TrackType?: string;
/** 异常信息 */
ExceptionDesc?: string | null;
}
/** 迁移主题的阶段分布 */
declare interface RocketMQMigrationTopicDistribution {
/** 迁移主题阶段 */
Stage?: string | null;
/** 数量 */
Count?: number | null;
}
/** rocketmq消息日志 */
declare interface RocketMQMsgLog {
/** 消息id */
MsgId?: string;
/** 消息tag */
MsgTag?: string | null;
/** 消息key */
MsgKey?: string | null;
/** 客户端地址 */
ProducerAddr?: string;
/** 消息发送时间 */
ProduceTime?: string;
/** pulsar消息id */
PulsarMsgId?: string;
/** 死信重发次数 */
DeadLetterResendTimes?: number | null;
/** 死信重发成功次数 */
ResendSuccessCount?: number | null;
}
/** RocketMQ命名空间信息 */
declare interface RocketMQNamespace {
/** 命名空间名称,3-64个字符,只能包含字母、数字、“-”及“_” */
NamespaceId?: string;
/** 已废弃,未消费消息的保留时间,以毫秒单位,范围60秒到15天 */
Ttl?: number;
/** 消息持久化后保留的时间,以毫秒单位 */
RetentionTime?: number;
/** 说明 */
Remark?: string | null;
/** 公网接入点地址 */
PublicEndpoint?: string | null;
/** VPC接入点地址 */
VpcEndpoint?: string | null;
/** 内部接入点地址 */
InternalEndpoint?: string | null;
}
/** RocketMQ平滑迁移任务 */
declare interface RocketMQSmoothMigrationTaskItem {
/** 任务ID */
TaskId?: string | null;
/** 任务名称 */
TaskName?: string | null;
/** 源集群名称 */
SourceClusterName?: string | null;
/** 目标集群ID */
ClusterId?: string | null;
/** 网络连接类型,PUBLIC 公网VPC 私有网络OTHER 其他 */
ConnectionType?: string | null;
/** 源集群NameServer地址 */
SourceNameServer?: string | null;
/** 任务状态Configuration 迁移配置SourceConnecting 连接源集群中MetaDataImport 元数据导入EndpointSetup 切换接入点ServiceMigration 切流中Completed 已完成Cancelled 已取消 */
TaskStatus?: string | null;
}
/** RocketMQ消费组订阅信息 */
declare interface RocketMQSubscription {
/** 主题名称 */
Topic?: string;
/** 主题类型:Normal 普通,GlobalOrder 全局顺序,PartitionedOrder 局部顺序,Transaction 事务消息,DelayScheduled 延时消息,Retry 重试,DeadLetter 死信 */
Type?: string | null;
/** 分区数 */
PartitionNum?: number | null;
/** 过滤模式,TAG,SQL */
ExpressionType?: string | null;
/** 过滤表达式 */
SubString?: string | null;
/** 订阅状态:0,订阅关系一致1,订阅关系不一致2,未知 */
Status?: number | null;
/** 消费堆积数量 */
ConsumerLag?: number | null;
/** 实例ID */
ClusterId?: string | null;
/** 消费组名称 */
ConsumerGroup?: string | null;
/** 是否在线 */
IsOnline?: boolean | null;
/** 消费类型0: 广播消费1: 集群消费 */
ConsumeType?: number | null;
/** 订阅一致性 */
Consistency?: number | null;
/** 最后消费进度更新时间,秒为单位 */
LastUpdateTime?: number | null;
/** 最大重试次数 */
MaxRetryTimes?: number | null;
/** 协议类型 */
ClientProtocol?: string | null;
/** 客户端订阅详情 */
ClientSubscriptionInfos?: ClientSubscriptionInfo[] | null;
}
/** RocketMQ主题信息 */
declare interface RocketMQTopic {
/** 主题名称 */
Name?: string;
/** 主题的类别,为枚举类型,Normal,GlobalOrder,PartitionedOrder,Transaction,Retry及DeadLetter */
Type?: string;
/** 订阅组数量 */
GroupNum?: number;
/** 说明 */
Remark?: string | null;
/** 读写分区数 */
PartitionNum?: number;
/** 创建时间,以毫秒为单位 */
CreateTime?: number;
/** 创建时间,以毫秒为单位 */
UpdateTime?: number;
/** 实例ID */
InstanceId?: string | null;
/** 命名空间 */
Namespace?: string | null;
/** 最后写入时间,单位为秒 */
LastUpdateTime?: number | null;
/** 订阅数量 */
SubscriptionCount?: number | null;
/** 订阅关系列表 */
SubscriptionData?: RocketMQSubscription[] | null;
}
/** RocketMQ主题配置信息 */
declare interface RocketMQTopicConfig {
/** 命名空间 */
Namespace: string;
/** 主题名称 */
TopicName: string;
/** 主题类型:Normal,普通PartitionedOrder, 分区顺序Transaction,事务消息DelayScheduled,延迟/定时消息 */
Type: string;
/** 分区个数 */
Partitions: number;
/** 备注信息 */
Remark?: string;
}
/** RocketMQ主题配置信息 */
declare interface RocketMQTopicConfigOutput {
/** 命名空间 */
Namespace?: string | null;
/** 主题名称 */
TopicName?: string | null;
/** 主题类型:Normal,普通GlobalOrder, 全局顺序PartitionedOrder, 分区顺序Transaction,事务消息DelayScheduled,延迟/定时消息 */
Type?: string | null;
/** 分区个数 */
Partitions?: number | null;
/** 备注信息 */
Remark?: string | null;
/** 是否导入 */
Imported?: boolean | null;
}
/** RocketMQtopic分布情况 */
declare interface RocketMQTopicDistribution {
/** topic类型 */
TopicType: string;
/** topic数量 */
Count: number;
}
/** RocketMQ专享实例信息 */
declare 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;
}
/** 角色实例 */
declare interface Role {
/** 角色名称。 */
RoleName?: string;
/** 角色token值。 */
Token?: string;
/** 备注说明。 */
Remark?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
/** 授权类型(Cluster:集群;TopicAndGroup:主题或消费组) */
PermType?: string;
}
/** 安全策略 */
declare interface SecurityPolicy {
/** ip或者网段 */
Route?: string | null;
/** 策略 true就是允许,白名单或者 false 拒绝 黑名单 */
Policy?: boolean | null;
/** 备注 */
Remark?: string | null;
}
/** 服务方信息 */
declare interface ServerLog {
/** 存储时间。 */
SaveTime?: string;
/** 状态。 */
Status?: string;
}
/** 排序器 */
declare interface Sort {
/** 排序字段 */
Name: string;
/** 升序ASC,降序DESC */
Order: string;
}
/** 订阅者 */
declare interface Subscription {
/** 主题名称。 */
TopicName?: string;
/** 环境(命名空间)名称。 */
EnvironmentId?: string;
/** 消费者开始连接的时间。 */
ConnectedSince?: string | null;
/** 消费者地址。 */
ConsumerAddr?: string | null;
/** 消费者数量。 */
ConsumerCount?: string | null;
/** 消费者名称。 */
ConsumerName?: string | null;
/** 堆积的消息数量。 */
MsgBacklog?: string | null;
/** 于TTL,此订阅下没有被发送而是被丢弃的比例。 */
MsgRateExpired?: string | null;
/** 消费者每秒分发消息的数量之和。 */
MsgRateOut?: string | null;
/** 消费者每秒消息的byte。 */
MsgThroughputOut?: string | null;
/** 订阅名称。 */
SubscriptionName?: string | null;
/** 消费者集合。 */
ConsumerSets?: Consumer[] | null;
/** 是否在线。 */
IsOnline?: boolean | null;
/** 消费进度集合。 */
ConsumersScheduleSets?: ConsumersSchedule[] | null;
/** 备注。 */
Remark?: string | null;
/** 创建时间。 */
CreateTime?: string | null;
/** 最近修改时间。 */
UpdateTime?: string | null;
/** 订阅类型,Exclusive,Shared,Failover, Key_Shared,空或NULL表示未知, */
SubType?: string | null;
/** 是否由于未 ack 数到达上限而被 block */
BlockedSubscriptionOnUnackedMsgs?: boolean | null;
/** 未 ack 消息数上限 */
MaxUnackedMsgNum?: number | null;
}
/** 订阅关系 */
declare interface SubscriptionTopic {
/** 环境(命名空间)名称。 */
EnvironmentId: string;
/** 主题名称。 */
TopicName: string;
/** 订阅名称。 */
SubscriptionName: string;
}
/** 标签的key/value的类型 */
declare interface Tag {
/** 标签的key的值 */
TagKey: string | null;
/** 标签的Value的值 */
TagValue: string | null;
}
/** 主题实例 */
declare interface Topic {
/** 最后一次间隔内发布消息的平均byte大小。 */
AverageMsgSize?: string | null;
/** 消费者数量。 */
ConsumerCount?: string | null;
/** 被记录下来的消息总数。 */
LastConfirmedEntry?: string | null;
/** 最后一个ledger创建的时间。 */
LastLedgerCreatedTimestamp?: string | null;
/** 本地和复制的发布者每秒发布消息的速率。 */
MsgRateIn?: string | null;
/** 本地和复制的消费者每秒分发消息的数量之和。 */
MsgRateOut?: string | null;
/** 本地和复制的发布者每秒发布消息的byte。 */
MsgThroughputIn?: string | null;
/** 本地和复制的消费者每秒分发消息的byte。 */
MsgThroughputOut?: string | null;
/** 被记录下来的消息总数。 */
NumberOfEntries?: string | null;
/** 分区数<=0:topic下无子分区。 */
Partitions?: number | null;
/** 生产者数量。 */
ProducerCount?: string | null;
/** 以byte计算的所有消息存储总量。 */
TotalSize?: string | null;
/** 分区topic里面的子分区。 */
SubTopicSets?: PartitionsTopic[] | null;
/** topic类型描述:0:普通消息;1:全局顺序消息;2:局部顺序消息;3:重试队列;4:死信队列;5:事务消息。 */
TopicType?: number | null;
/** 环境(命名空间)名称。 */
EnvironmentId?: string | null;
/** 主题名称。 */
TopicName?: string | null;
/** 说明,128个字符以内。 */
Remark?: string | null;
/** 创建时间。 */
CreateTime?: string | null;
/** 最近修改时间。 */
UpdateTime?: string | null;
/** 生产者上限。 */
ProducerLimit?: string | null;
/** 消费者上限。 */
ConsumerLimit?: string | null;
/** 0: 非持久非分区1: 非持久分区2: 持久非分区3: 持久分区 */
PulsarTopicType?: number | null;
/** 未消费消息过期时间,单位:秒 */
MsgTTL?: number | null;
/** 集群 ID */
ClusterId?: string;
/** 用户自定义的租户别名,如果没有,会复用专业集群 ID */
Tenant?: string;
/** 是否开启异常消费者隔离 */
IsolateConsumerEnable?: boolean;
/** 消费者 Ack 超时时间,单位:秒 */
AckTimeOut?: number;
}
/** 主题关键信息 */
declare interface TopicRecord {
/** 环境(命名空间)名称。 */
EnvironmentId: string;
/** 主题名称。 */
TopicName: string;
}
/** Topic状态 */
declare interface TopicStats {
/** 所属Broker节点 */
BrokerName?: string | null;
/** 队列编号 */
QueueId?: number | null;
/** 最小位点 */
MinOffset?: number | null;
/** 最大位点 */
MaxOffset?: number | null;
/** 消息条数 */
MessageCount?: number | null;
/** 消息最后写入时间 */
LastUpdateTimestamp?: number | null;
}
/** 主题实例 */
declare interface Topic_Simplification {
/** 主题名称。 */
TopicName?: string | null;
/** 0: 非持久非分区1: 非持久分区2: 持久非分区3: 持久分区 */
PulsarTopicType?: number | null;
}
/** 消息轨迹结果 */
declare interface TraceResult {
/** 阶段 */
Stage: string;
/** 内容详情 */
Data: string;
}
/** vhost使用配额信息 */
declare interface VirtualHostQuota {
/** 允许创建最大vhost数 */
MaxVirtualHost?: number;
/** 已创建vhost数 */
UsedVirtualHost?: number;
/** 单个 vhost 下允许的最大连接数 */
MaxConnectionPerVhost?: number;
/** 单个 vhost 下允许的最大交换机数 */
MaxExchangePerVhost?: number;
/** 单个 vhost 下允许的最大队列机数 */
MaxQueuePerVhost?: number;
}
/** vcp绑定记录 */
declare interface VpcBindRecord {
/** 租户Vpc Id */
UniqueVpcId?: string;
/** 租户Vpc子网Id */
UniqueSubnetId?: string;
/** 路由Id */
RouterId?: string;
/** Vpc的Id */
Ip?: string;
/** Vpc的Port */
Port?: number;
/** 说明,128个字符以内 */
Remark?: string | null;
}
/** VPC配置信息 */
declare interface VpcConfig {
/** vpc的id */
VpcId: string;
/** 子网id */
SubnetId: string;
}
/** VPC接入点信息 */
declare interface VpcEndpointInfo {
/** vpc的id */
VpcId: string;
/** 子网id */
SubnetId: string;
/** vpc接入点信息 */
VpcEndpoint: string;
/** vpc接入点状态 OFF/ON/CREATING/DELETING */
VpcDataStreamEndpointStatus?: string;
/** TLS加密的数据流接入点 */
VpcTlsEndpoint?: string;
}
/** vpc信息(由UniqVpcId和UniqSubnetId组成) */
declare interface VpcInfo {
/** vpc信息 */
VpcId: string;
/** 子网信息 */
SubnetId: string;
}
declare interface AcknowledgeMessageRequest {
/** 用作标识消息的唯一的ID(可从 receiveMessage 的返回值中获得) */
MessageId: string;
/** Topic 名字(可从 receiveMessage 的返回值中获得)这里尽量需要使用topic的全路径,即:tenant/namespace/topic。如果不指定,默认使用的是:public/default */
AckTopic: string;
/** 订阅者的名字,可以从receiveMessage的返回值中获取到。这里尽量与receiveMessage中的订阅者保持一致,否则没办法正确ack 接收回来的消息。 */
SubName: string;
}
declare interface AcknowledgeMessageResponse {
/** 如果为"",则说明没有错误返回,否则返回具体的错误信息。 */
ErrorMsg?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ClearCmqQueueRequest {
/** 队列名字,在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 */
QueueName: string;
}
declare interface ClearCmqQueueResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ClearCmqSubscriptionFilterTagsRequest {
/** 主题名字,在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 */
TopicName: string;
/** 订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 */
SubscriptionName: string;
}
declare interface ClearCmqSubscriptionFilterTagsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: st