cmq.d.ts

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** 死信队列策略 */
declare interface DeadLetterPolicy {
  /** 死信队列。 */
  DeadLetterQueue: string | null;
  /** 死信队列名字。 */
  DeadLetterQueueName: string | null;
  /** 最大未消费过期时间。Policy为1时必选。范围300-43200，单位秒，需要小于消息最大保留时间MsgRetentionSeconds。 */
  MaxTimeToLive: number | null;
  /** 死信队列策略。 */
  Policy: number | null;
  /** 最大接收次数。 */
  MaxReceiveCount: number | null;
}

/** 死信源队列信息 */
declare interface DeadLetterSource {
  /** 消息队列ID。 */
  QueueId: string | null;
  /** 消息队列名字。 */
  QueueName: string | null;
}

/** 过滤参数 */
declare interface Filter {
  /** 数值 */
  Values?: string[];
  /** 过滤参数的名字 */
  Name?: string;
}

/** 批量queue属性信息 */
declare interface QueueSet {
  /** 消息队列ID。 */
  QueueId: string;
  /** 回溯队列的消息回溯时间最大值，取值范围0 - 43200秒，0表示不开启消息回溯。 */
  RewindSeconds: number | null;
  /** 创建者Uin。 */
  CreateUin: number | null;
  /** 最后一次修改队列属性的时间。返回 Unix 时间戳，精确到秒。 */
  LastModifyTime: number | null;
  /** 消息可见性超时。取值范围1 - 43200秒（即12小时内），默认值30。 */
  VisibilityTimeout: number | null;
  /** 消息队列名字。 */
  QueueName: string;
  /** 消息轨迹。true表示开启，false表示不开启。 */
  Trace: boolean | null;
  /** 关联的标签。 */
  Tags: Tag[] | null;
  /** 已调用 DelMsg 接口删除，但还在回溯保留时间内的消息数量。 */
  RewindMsgNum: number | null;
  /** 飞行消息最大保留时间。 */
  MaxDelaySeconds: number | null;
  /** 事务消息策略。 */
  TransactionPolicy: TransactionPolicy | null;
  /** 消息保留周期。取值范围60-1296000秒（1min-15天），默认值345600秒（4 天）。 */
  MsgRetentionSeconds: number | null;
  /** 延迟消息数。 */
  DelayMsgNum: number | null;
  /** 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。 */
  MaxMsgHeapNum: number | null;
  /** 消息接收长轮询等待时间。取值范围0 - 30秒，默认值0。 */
  PollingWaitSeconds: number | null;
  /** 带宽限制。 */
  Bps: number | null;
  /** 在队列中处于 Inactive 状态（正处于被消费状态）的消息总数，为近似值。 */
  InactiveMsgNum: number | null;
  /** 死信队列策略。 */
  DeadLetterPolicy: DeadLetterPolicy | null;
  /** 在队列中处于 Active 状态（不处于被消费状态）的消息总数，为近似值。 */
  ActiveMsgNum: number | null;
  /** 消息最大长度。取值范围1024 - 1048576 Byte（即1K - 1024K），默认值65536。 */
  MaxMsgSize: number | null;
  /** 消息最小未消费时间，单位为秒。 */
  MinMsgTime: number | null;
  /** 死信队列。 */
  DeadLetterSource: DeadLetterSource[] | null;
  /** 事务消息队列。true表示是事务消息，false表示不是事务消息。 */
  Transaction: boolean | null;
  /** 每秒钟生产消息条数的限制，消费消息的大小是该值的1.1倍。 */
  Qps: number | null;
  /** 队列的创建时间。返回 Unix 时间戳，精确到秒。 */
  CreateTime: number | null;
  /** 是否迁移到新版本。0 表示仅同步元数据，1 表示迁移中，2 表示已经迁移完毕，3 表示回切状态，曾经迁移过，4 未迁移。 */
  Migrate: number | null;
}

/** 标签 */
declare interface Tag {
  /** 标签Key */
  TagKey: string | null;
  /** 标签值 */
  TagValue: string | null;
}

/** topic返回信息展示字段 */
declare interface TopicSet {
  /** 当前该主题中消息数目（消息堆积数）。 */
  MsgCount: number | null;
  /** 主题的 ID。 */
  TopicId: string | null;
  /** 消息最大长度。取值范围1024 - 1048576Byte（即1 - 1024K），默认值为65536。 */
  MaxMsgSize: number | null;
  /** 消息轨迹。true表示开启，false表示不开启。 */
  Trace: boolean | null;
  /** 关联的标签。 */
  Tags: Tag[] | null;
  /** 创建者 Uin，CAM 鉴权 resource 由该字段组合而成。 */
  CreateUin: number | null;
  /** 描述用户创建订阅时选择的过滤策略：FilterType = 1表示用户使用 FilterTag 标签过滤;FilterType = 2表示用户使用 BindingKey 过滤。 */
  FilterType: number | null;
  /** 主题名称。 */
  TopicName: string | null;
  /** 最后一次修改主题属性的时间。返回 Unix 时间戳，精确到秒。 */
  LastModifyTime: number | null;
  /** 消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒。固定为一天（86400秒），该属性不能修改。 */
  MsgRetentionSeconds: number | null;
  /** 每秒钟发布消息的条数。 */
  Qps: number | null;
  /** 主题的创建时间。返回 Unix 时间戳，精确到秒。 */
  CreateTime: number | null;
  /** 是否迁移到新版本。0 表示未迁移，1 表示迁移中，2 表示已经迁移完毕，3 表示回切状态，曾经迁移过，4 未知状态。 */
  Migrate: number | null;
}

/** 事务消息策略 */
declare interface TransactionPolicy {
  /** 最大查询次数。 */
  MaxQueryCount: number | null;
  /** 第一次回查时间。 */
  FirstQueryInterval: number | null;
}

declare interface DescribeQueueDetailRequest {
  /** 标签搜索 */
  TagKey?: string;
  /** 分页时本页获取队列的个数，如果不传递该参数，则该参数默认为20，最大值为50。 */
  Limit?: number;
  /** 精确匹配QueueName */
  QueueName?: string;
  /** 筛选参数，目前支持QueueName筛选，且仅支持一个关键字 */
  Filters?: Filter[];
  /** 分页时本页获取队列列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0 */
  Offset?: number;
}

declare interface DescribeQueueDetailResponse {
  /** 总队列数。 */
  TotalCount?: number;
  /** 队列详情列表。 */
  QueueSet?: QueueSet[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeTopicDetailRequest {
  /** 标签匹配。 */
  TagKey?: string;
  /** 分页时本页获取队列的个数，如果不传递该参数，则该参数默认为20，最大值为50。 */
  Limit?: number;
  /** 精确匹配TopicName。 */
  TopicName?: string;
  /** 目前只支持过滤TopicName ， 且只能填一个过滤值。 */
  Filters?: Filter[];
  /** 分页时本页获取队列列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0。 */
  Offset?: number;
}

declare interface DescribeTopicDetailResponse {
  /** 主题列表总数。 */
  TotalCount?: number;
  /** 主题详情列表。 */
  TopicSet?: TopicSet[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Cmq 消息队列 CMQ} */
declare interface Cmq {
  (): Versions;
  /** 枚举队列 {@link DescribeQueueDetailRequest} {@link DescribeQueueDetailResponse} */
  DescribeQueueDetail(data?: DescribeQueueDetailRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeQueueDetailResponse>;
  /** 查询主题列表 {@link DescribeTopicDetailRequest} {@link DescribeTopicDetailResponse} */
  DescribeTopicDetail(data?: DescribeTopicDetailRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTopicDetailResponse>;
}

export declare type Versions = ["2019-03-04"];

export default Cmq;