tencentcloud-sdk-nodejs/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts

腾讯云 API NODEJS SDK

/**
 * UpdateAuthorizationPolicyPriority返回参数结构体
 */
export interface UpdateAuthorizationPolicyPriorityResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * MQTT 订阅关系
 */
export interface MQTTClientSubscription {
    /**
     * topic 订阅
     */
    TopicFilter?: string;
    /**
     * 服务质量等级
  0: 至多一次
  1: 至少一次
  2: 恰好一次
     */
    Qos?: number;
    /**
     * 堆积数量
     */
    Lag?: number;
    /**
     * 投递未确认数量
     */
    Inflight?: number;
    /**
     * 用户属性
     */
    UserProperties?: Array<SubscriptionUserProperty>;
}
/**
 * ModifyDeviceIdentity返回参数结构体
 */
export interface ModifyDeviceIdentityResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteUser请求参数结构体
 */
export interface DeleteUserRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
    /**
     * 用户名
     */
    Username: string;
}
/**
 * DescribeSharedSubscriptionGroupsWithSubscriptions返回参数结构体
 */
export interface DescribeSharedSubscriptionGroupsWithSubscriptionsResponse {
    /**
     * <p>集群下共享订阅组列表</p>
     */
    Data?: Array<SharedSubscriptionGroupWithSubscriptions>;
    /**
     * <p>查询总数</p>
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyJWTAuthenticator返回参数结构体
 */
export interface ModifyJWTAuthenticatorResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CA证书信息
 */
export interface CaCertificateItem {
    /**
     * 证书的公用名(Common Name)
     */
    CaCn?: string;
    /**
     * 证书内容
     */
    CaCertificate?: string;
    /**
     * 证书序列号
     */
    CaSn?: string;
    /**
     * 证书格式，当前仅支持 PEM 格式
     */
    Format?: string;
    /**
     * 验证证书内容
     */
    VerificationCertificate?: string;
    /**
     * CA证书的状态
      ACTIVE：激活
      INACTIVE：未激活
      REVOKED：吊销
      PENDING_ACTIVATION：注册待激活
     */
    Status?: string;
    /**
     * 上次激活时间，毫秒级时间戳 。
     */
    LastActivationTime?: number;
    /**
     * 创建时间，毫秒级时间戳 。
     */
    CreatedTime?: number;
    /**
     * 更新时间，毫秒级时间戳 。
     */
    UpdateTime?: number;
    /**
     * 上次去激活时间，毫秒级时间戳 。
     */
    LastInactivationTime?: number;
    /**
     * Ca证书颁发者CN
     */
    CaIssuerCn?: string;
    /**
     * 生效时间，毫秒级时间戳 。
     */
    NotBeforeTime?: number;
    /**
     * 失效时间，毫秒级时间戳 。
     */
    NotAfterTime?: number;
}
/**
 * 消息属性增强规则优先级
 */
export interface MessageEnrichmentRulePriority {
    /**
     * 消息属性增强规则id
     */
    Id: number;
    /**
     * 优先级
     */
    Priority: number;
}
/**
 * ModifyAuthorizationPolicy返回参数结构体
 */
export interface ModifyAuthorizationPolicyResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ActivateDeviceCertificate请求参数结构体
 */
export interface ActivateDeviceCertificateRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 设备证书的SN序列号，可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
     */
    DeviceCertificateSn: string;
}
/**
 * CreateInstance返回参数结构体
 */
export interface CreateInstanceResponse {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ApplyRegistrationCode请求参数结构体
 */
export interface ApplyRegistrationCodeRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
}
/**
 * MessageEnrichmentRuleItem
 */
export interface MessageEnrichmentRuleItem {
    /**
     * 策略规则ID
     */
    Id?: number;
    /**
     * MQTT集群ID
     */
    InstanceId?: string;
    /**
     * 策略规则名
     */
    RuleName?: string;
    /**
     * 规则匹配条件，JSON格式，需要Base64编码
  样例 {"clientId":"client-1","username":"client-1","topic":"home/room1"}
  Base64后 eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9
     */
    Condition?: string;
    /**
     * 规则执行的动作，JSON格式，需要Base64编码
   样例
  {"messageExpiryInterval":360,"response Topic":"replies/devices/${clientid}","correlationData":"${traceid}","userProperty":[{"key":"trace-id","value":"${traceid}"},{"key":"data-source","value":"rule-engine"}]}
  BASE64后 eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2UgVG9waWMiOiJyZXBsaWVzL2RldmljZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9LHsia2V5IjoiZGF0YS1zb3VyY2UiLCJ2YWx1ZSI6InJ1bGUtZW5naW5lIn1dfQ==
     */
    Actions?: string;
    /**
     * 规则优先级，数字越小，优先级越高，高优先级覆盖低优先级。UserProperty字段会合并
     */
    Priority?: number;
    /**
     * 策略状态。 0:未定义；1:激活；2:不激活；默认不激活
     */
    Status?: number;
    /**
     * 备注
     */
    Remark?: string;
    /**
     * 创建时间。毫秒级时间戳 。
     */
    CreatedTime?: number;
    /**
     * 更新时间。毫秒级时间戳 。
     */
    UpdateTime?: number;
}
/**
 * DescribeMessageList请求参数结构体
 */
export interface DescribeMessageListRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 要查询的一级Topic，可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
     */
    Topic: string;
    /**
     * 开始时间，毫秒级时间戳 。
     */
    StartTime: number;
    /**
     * 结束时间，毫秒级时间戳 。
     */
    EndTime: number;
    /**
     * 请求任务id，用于相同查询参数下查询加速，第一次查询时无需传递，第一次查询会根据本次查询参数生成查询任务ID，保留查询条件，查询下一页消息时可传递第一次查询返回的任务ID。
     */
    TaskRequestId: string;
    /**
     * 查询起始位置，默认0
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认20，最大50
     */
    Limit?: number;
}
/**
 * DescribeSharedSubscriptions请求参数结构体
 */
export interface DescribeSharedSubscriptionsRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 共享订阅组名
     */
    SharedName: string;
}
/**
 * DeleteDeviceIdentity请求参数结构体
 */
export interface DeleteDeviceIdentityRequest {
    /**
     * 集群id
     */
    InstanceId: string;
    /**
     * 设备id
     */
    DeviceId: string;
}
/**
 * ModifyJWTAuthenticator请求参数结构体
 */
export interface ModifyJWTAuthenticatorRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 签名方式：hmac-based，public-key
     */
    Algorithm?: string;
    /**
     * 认证字段
  password：对应 MQTT CONNECT Packet 中 password 字段，
  username：对应 MQTT CONNECT Packet 中 username 字段
     */
    From?: string;
    /**
     * 密钥，Algorithm为hmac-based需要传递该字段。
     */
    Secret?: string;
    /**
     * 公钥，Algorithm为public-key时需要传递该字段。
     */
    PublicKey?: string;
    /**
     * 认证器是否开启：open-启用；close-关闭
     */
    Status?: string;
    /**
     * 说明，不能超过 128 个字符
     */
    Remark?: string;
    /**
     * JSKS文本
     * @deprecated
     */
    Text?: string;
}
/**
 * 策略规则优先级
 */
export interface AuthorizationPolicyPriority {
    /**
     * 授权策略规则id，可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
     */
    Id: number;
    /**
     * 优先级
     */
    Priority: number;
}
/**
 * DescribeInsPublicEndpoints返回参数结构体
 */
export interface DescribeInsPublicEndpointsResponse {
    /**
     * 接入点
     */
    Endpoints?: Array<MQTTEndpointItem>;
    /**
     * 实例id
     */
    InstanceId?: string;
    /**
     * 带宽，单位Mbps
     */
    Bandwidth?: number;
    /**
     * 公网访问规则
     */
    Rules?: Array<PublicAccessRule>;
    /**
     * 公网状态：
      NORMAL-正常
      CLOSING-关闭中
      MODIFYING-修改中
      CREATING-开启中
      CLOSE-关闭
     */
    Status?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSharedSubscriptionLag返回参数结构体
 */
export interface DescribeSharedSubscriptionLagResponse {
    /**
     * 堆积值
     */
    Lag?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteTopic请求参数结构体
 */
export interface DeleteTopicRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
    /**
     * 主题
     */
    Topic: string;
}
/**
 * ModifyUser返回参数结构体
 */
export interface ModifyUserResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCaCertificate返回参数结构体
 */
export interface DescribeCaCertificateResponse {
    /**
     * 创建时间，毫秒级时间戳 。
     */
    CreatedTime?: number;
    /**
     * 上次更新时间，毫秒级时间戳 。
     */
    UpdateTime?: number;
    /**
     * 失效日期，毫秒级时间戳 。
     */
    NotAfterTime?: number;
    /**
     * 上次激活时间，毫秒级时间戳 。
     */
    LastActivationTime?: number;
    /**
     * 上次吊销时间，毫秒级时间戳 。
     */
    LastInactivationTime?: number;
    /**
     * CA证书状态
   ACTIVE：激活
  INACTIVE：未激活
  
     */
    Status?: string;
    /**
     * 证书序列号
     */
    CaSn?: string;
    /**
     * 证书的CN（Common Name），证书中用于标识主体的名称，通常是域名或组织名称
     */
    CaCn?: string;
    /**
     * 证书内容
     */
    CaCertificate?: string;
    /**
     * 证书格式，当仅支持PEM格式
     */
    Format?: string;
    /**
     * Ca证书颁发者CN
     */
    CaIssuerCn?: string;
    /**
     * 生效开始时间，毫秒级时间戳 。
     */
    NotBeforeTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeDeviceCertificates请求参数结构体
 */
export interface DescribeDeviceCertificatesRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 支持搜索参数
  ClientId：客户端id，根据实际业务使用获取
  CaSn：所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
  DeviceCertificateSn：设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
  DeviceCertificateCn：设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
  OrganizationalUnit：证书OU
  NotAfterEnd：过期时间小于等于指定时间的证书
  NotAfterStart：过期时间大于等于指定时间的证书
  Status：设备证书状态     ACTIVE（激活）； INACTIVE（未激活）REVOKED（吊销）；PENDING_ACTIVATION（注册待激活）
  
     */
    Filters?: Array<Filter>;
    /**
     * 分页limit，默认20，最大100
     */
    Limit?: number;
    /**
     * 分页偏移量，默认0
     */
    Offset?: number;
    /**
     * 排序规则
      CREATE_TIME_DESC, 创建时间降序
      CREATE_TIME_ASC,创建时间升序
      UPDATE_TIME_DESC,更新时间降序
      UPDATE_TIME_ASC,更新时间升序
     */
    OrderBy?: string;
}
/**
 * DescribeSharedSubscriptionGroups请求参数结构体
 */
export interface DescribeSharedSubscriptionGroupsRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
}
/**
 * DeleteAuthenticator请求参数结构体
 */
export interface DeleteAuthenticatorRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 认证器类型:
  JWT：JWT认证器
  JWKS：JWKS认证器
  HTTP：HTTP认证器
     */
    Type: string;
}
/**
 * DeleteMessageEnrichmentRule请求参数结构体
 */
export interface DeleteMessageEnrichmentRuleRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 消息属性增强规则id
     */
    Id: number;
}
/**
 * 公网访问安全规则
 */
export interface PublicAccessRule {
    /**
     * ip网段信息
     */
    IpRule?: string;
    /**
     * 当前仅支持允许，默认允许（allow）
     */
    Allow?: boolean;
    /**
     * 备注信息，最多64个字符。
     */
    Remark?: string;
}
/**
 * VPC信息
 */
export interface VpcInfo {
    /**
     * VPC ID
     */
    VpcId?: string;
    /**
     * 子网ID
     */
    SubnetId?: string;
}
/**
 * DeleteAuthorizationPolicy返回参数结构体
 */
export interface DeleteAuthorizationPolicyResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * MQTT ProductSkuItem
 */
export interface ProductSkuItem {
    /**
     * 规格类型
  BASIC：基础版
  PRO ：专业版
  PLATINUM： 铂金版
     */
    InstanceType?: string;
    /**
     * 规格代码
     */
    SkuCode?: string;
    /**
     * 是否售卖
  1: 可售卖
  0: 不可售卖
     */
    OnSale?: boolean;
    /**
     * topic num限制
     */
    TopicNumLimit?: number;
    /**
     * MQTT 集群下每秒钟生产消息量和消费消息量之和。详细计算方式参考 [计费概述](https://cloud.tencent.com/document/product/1778/109698)
     */
    TpsLimit?: number;
    /**
     * 客户端连接数
     */
    ClientNumLimit?: number;
    /**
     * 单客户端最大订阅数
     */
    MaxSubscriptionPerClient?: number;
    /**
     * 授权规则条数
     */
    AuthorizationPolicyLimit?: number;
    /**
     * 计费项信息
     */
    PriceTags?: Array<PriceTag>;
}
/**
 * ModifyJWKSAuthenticator请求参数结构体
 */
export interface ModifyJWKSAuthenticatorRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * JWKS服务器地址，（Text字段和Endpoint字段必须选择一个填写）
     */
    Endpoint?: string;
    /**
     * 认证器状态：open-启用（默认）；close-关闭
     */
    Status?: string;
    /**
     * 认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址时生效。
     */
    RefreshInterval?: number;
    /**
     * JWKS文本，认证服务器地址为空时生效。（Text字段和Endpoint字段必须选择一个填写）
     */
    Text?: string;
    /**
     * 认证字段；
  username-对应 MQTT CONNECT Packet 中 username 字段，
  password-对应 MQTT CONNECT Packet 中 password 字段。默认username
     */
    From?: string;
    /**
     * 说明，不能超过 128 个字符
     */
    Remark?: string;
}
/**
 * DescribeDeviceIdentities请求参数结构体
 */
export interface DescribeDeviceIdentitiesRequest {
    /**
     * 集群id
     */
    InstanceId: string;
    /**
     * 查询起始位置
     */
    Offset?: number;
    /**
     * 查询结果限制数量
     */
    Limit?: number;
}
/**
 * CreateMessageEnrichmentRule返回参数结构体
 */
export interface CreateMessageEnrichmentRuleResponse {
    /**
     * 集群id
     */
    InstanceId?: string;
    /**
     * 规则id
     */
    Id?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RegisterCaCertificate返回参数结构体
 */
export interface RegisterCaCertificateResponse {
    /**
     * mqtt实例ID
     */
    InstanceId?: string;
    /**
     * ca 证书的序列号
     */
    CaSn?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * map结构返回
 */
export interface UserProperty {
    /**
     * key
     */
    Key?: string;
    /**
     * value
     */
    Value?: string;
}
/**
 * KickOutClient返回参数结构体
 */
export interface KickOutClientResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMessageDetails请求参数结构体
 */
export interface DescribeMessageDetailsRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 消息ID
     */
    MessageId: string;
    /**
     * 订阅表达式
     */
    Subscription?: string;
}
/**
 * DeleteInstance请求参数结构体
 */
export interface DeleteInstanceRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
}
/**
 * ModifyInstance请求参数结构体
 */
export interface ModifyInstanceRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 要修改实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。
     */
    Name?: string;
    /**
     * 要修改的备注信息，最多128个字符。
     */
    Remark?: string;
    /**
     * 需要变更的配置规格
  基础版和专业版集群不能升配到铂金版规格，铂金版集群不能降配至基础版和增强版规格。
     */
    SkuCode?: string;
    /**
     * 客户端证书注册方式：
  JITP：自动注册
  API：手动通过API注册
     */
    DeviceCertificateProvisionType?: string;
    /**
     * 自动注册证书是否自动激活
     */
    AutomaticActivation?: boolean;
    /**
     * 授权策略开关
     */
    AuthorizationPolicy?: boolean;
    /**
     * 是否使用默认的服务端证书
     */
    UseDefaultServerCert?: boolean;
    /**
     * TLS：单向认证
  mTLS；双向认证
  BYOC：一机一证
     */
    X509Mode?: string;
    /**
     * 单客户端消息收发限速单位 条/秒
     */
    MessageRate?: number;
}
/**
 * CreateDeviceIdentity请求参数结构体
 */
export interface CreateDeviceIdentityRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 设备id
     */
    DeviceId: string;
    /**
     * 1:ENABLED-可用（默认）
  2:DISABLE-不可用
     */
    Status?: string;
    /**
     * 主要签名key，不传则由系统自动生成，需要base64编码。
     */
    PrimaryKey?: string;
    /**
     * 次要签名key，不传则由系统自动生成，需要base64编码。
     */
    SecondaryKey?: string;
    /**
     * 该设备id的传播属性设置
     */
    PropagatingProperties?: Array<PropagatingProperty>;
}
/**
 * RegisterDeviceCertificate返回参数结构体
 */
export interface RegisterDeviceCertificateResponse {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId?: string;
    /**
     * 关联的CA证书SN
     */
    CaSn?: string;
    /**
     * 设备证书的SN
     */
    DeviceCertificateSn?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * MQTT认证器信息
 */
export interface MQTTAuthenticatorItem {
    /**
     * 认证器类型
  JWT：JWT认证器
  JWKS：JWKS认证器
  HTTP：HTTP认证器
     */
    Type?: string;
    /**
     * JWT认证器字段说明
  from（认证字段）
      password：从password字段获取认证字段
      username：从username字段获取认证字段
  secret（签名方式）
      hmac-based：hmac-based签名方式
      public-key：public-key签名方式
  secret（密钥），hmac-based需要配置密钥
  public-key（公钥），public-key签名方式需要配置
  样例：{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
  
  JWKS认证器字段说明
  endpoint（接入点）：公钥获取服务器接入地址
  refreshInterval（认证内容）：公钥集合刷新周期
  from（认证字段）
      password：从password字段获取认证字段
      username：从username字段获取认证字段
  text：公钥集合
  样例：{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
  
  HTTP认证器
  headers（请求头）：标准请求头和自定义请求头
  endpoint（接入点）：认证服务器接入点
  method（http请求方法）：POST/GET
  readTimeout（读超时时间）：读取认证服务器数据超时时间，单位秒
  connectTimeout（连接超时时间）：连接认证服务器超时时间，单位秒
  body（请求体）：http请求体
  concurrency（并发数）：最大并发请求数量
  样例：{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
  参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
     */
    Config?: string;
    /**
     * 认证器状态
  open：认证器打开
  close：认证器关闭
     */
    Status?: string;
    /**
     * 创建时间，毫秒级时间戳 。
     */
    CreateTime?: number;
    /**
     * 说明，最长 128 字符。
     */
    Remark?: string;
}
/**
 * DescribeClientList返回参数结构体
 */
export interface DescribeClientListResponse {
    /**
     * 客户端列表
     */
    Clients?: Array<MQTTClientInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 标签数据
 */
export interface Tag {
    /**
     * 标签名称
     */
    TagKey: string;
    /**
     * 标签值
     */
    TagValue: string;
}
/**
 * DescribeMessageList返回参数结构体
 */
export interface DescribeMessageListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 消息记录列表
     */
    Data?: Array<MQTTMessageItem>;
    /**
     * 请求任务id
     */
    TaskRequestId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * HTTP 认证器header
 */
export interface HeaderItem {
    /**
     * header key
     */
    Key: string;
    /**
     * header value
     */
    Value: string;
}
/**
 * MQTT 实例信息
 */
export interface MQTTInstanceItem {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 实例名称
     */
    InstanceName?: string;
    /**
     * 实例版本
     */
    Version?: string;
    /**
     * 实例类型
  BASIC，基础版
  PRO，专业版
  PLATINUM，铂金版
     */
    InstanceType?: string;
    /**
     * 实例状态，
  RUNNING, 运行中
  MAINTAINING，维护中
  ABNORMAL，异常
  OVERDUE，欠费
  CREATING，创建中
  MODIFYING，变配中
  CREATE_FAILURE，创建失败
  MODIFY_FAILURE，变配失败
  DELETING，删除中
     */
    InstanceStatus?: string;
    /**
     * 实例主题数上限
     */
    TopicNumLimit?: number;
    /**
     * 备注信息
     */
    Remark?: string;
    /**
     * 主题数量
     */
    TopicNum?: number;
    /**
     * 商品规格
     */
    SkuCode?: string;
    /**
     * 弹性TPS限流值
     */
    TpsLimit?: number;
    /**
     * 创建时间，毫秒级时间戳
     */
    CreateTime?: number;
    /**
     * 单客户端最大订阅数量
     */
    MaxSubscriptionPerClient?: number;
    /**
     * 客户端连接数上线
     */
    ClientNumLimit?: number;
    /**
     * 是否自动续费。仅包年包月集群生效。
  1:自动续费
  0:非自动续费
     */
    RenewFlag?: number;
    /**
     * 计费模式， POSTPAID，按量计费 PREPAID，包年包月
     */
    PayMode?: string;
    /**
     * 到期时间，毫秒级时间戳
     */
    ExpiryTime?: number;
    /**
     * 预销毁时间，毫秒级时间戳
     */
    DestroyTime?: number;
    /**
     * 授权规则条数限制
     */
    AuthorizationPolicyLimit?: number;
    /**
     * 最大ca配额
     */
    MaxCaNum?: number;
    /**
     * 最大订阅数
     */
    MaxSubscription?: number;
    /**
     * 共享订阅组数最大限制
     */
    SharedSubscriptionGroupLimit?: number;
    /**
     * 单个共享订阅组TopicFilter数限制
     * @deprecated
     */
    MaxTopicFilterPerSharedSubscriptionGroup?: number;
    /**
     * 自动订阅规则条数限制
     */
    AutoSubscriptionPolicyLimit?: number;
    /**
     * 单条自动订阅规则TopicFilter数限制
     */
    MaxTopicFilterPerAutoSubscriptionPolicy?: number;
    /**
     * 集群删除保护开关
     */
    DeleteProtect?: boolean;
}
/**
 * DescribeInstanceList返回参数结构体
 */
export interface DescribeInstanceListResponse {
    /**
     * <p>查询总数</p>
     */
    TotalCount?: number;
    /**
     * <p>实例列表</p>
     */
    Data?: Array<MQTTInstanceItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ApplyRegistrationCode返回参数结构体
 */
export interface ApplyRegistrationCodeResponse {
    /**
     * 集群ID
     */
    InstanceId?: string;
    /**
     * 注册码
     */
    RegistrationCode?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyMessageEnrichmentRule请求参数结构体
 */
export interface ModifyMessageEnrichmentRuleRequest {
    /**
     * 消息属性增强规则ID
     */
    Id: number;
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
  
     */
    InstanceId: string;
    /**
     * 策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。
     */
    RuleName?: string;
    /**
     * 规则匹配条件，JSON格式，需要Base64编码
  样例
  {"clientId":"client-1","username":"client-1","topic":"home/room1"}
  Base64后
  eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9
     */
    Condition?: string;
    /**
     * 规则执行的动作，JSON格式，需要Base64编码
  样例
  {"messageExpiryInterval":360,"responseTopic":"replies/${clientid}","correlationData":"${traceid}","userProperty":[{"key":"trace-id","value":"${traceid}"}]}
   BASE64后 eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=
     */
    Actions?: string;
    /**
     * 规则优先级，数字越小，优先级越高，高优先级覆盖低优先级。UserProperty字段会合并
     */
    Priority?: number;
    /**
     * 策略状态。 0:未定义；1:激活；2:不激活；默认不激活
     */
    Status?: number;
    /**
     * 备注信息，最长 128 字符
     */
    Remark?: string;
}
/**
 * ModifyInstance返回参数结构体
 */
export interface ModifyInstanceResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyX509Config返回参数结构体
 */
export interface ModifyX509ConfigResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * AddClientSubscription请求参数结构体
 */
export interface AddClientSubscriptionRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
    /**
     * 客户端id
     */
    ClientId: string;
    /**
     * 订阅
     */
    TopicFilter: string;
    /**
     * 服务质量:0,1,2
     */
    Qos?: string;
}
/**
 * CreateHttpAuthenticator返回参数结构体
 */
export interface CreateHttpAuthenticatorResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * MQTT消息
 */
export interface MQTTMessage {
    /**
     * 消息id
     */
    MessageId?: string;
    /**
     * 消息发送的客户端Id
     */
    ClientId?: string;
    /**
     * 消息服务质量等级
     */
    Qos?: string;
    /**
     * 消息在服务端的存储时间，毫秒级时间戳
     */
    StoreTimestamp?: number;
    /**
     * 源topic
     */
    OriginTopic?: string;
}
/**
 * 消息记录
 */
export interface MQTTMessageItem {
    /**
     * 消息ID
     */
    MsgId?: string;
    /**
     * 消息tag
     */
    Tags?: string;
    /**
     * 消息key
     */
    Keys?: string;
    /**
     * 客户端地址
     */
    ProducerAddr?: string;
    /**
     * 消息发送时间，格式 日期时间：YYYY-MM-DD hh:mm:ss
     */
    ProduceTime?: string;
    /**
     * 死信重发次数
     * @deprecated
     */
    DeadLetterResendTimes?: number;
    /**
     * 死信重发成功次数
     * @deprecated
     */
    DeadLetterResendSuccessTimes?: number;
    /**
     * 子topic
     * @deprecated
     */
    SubTopic?: string;
    /**
     * 消息质量等级
  0：至多一次
  1：至少一次
  2：精确一次
     */
    Qos?: string;
}
/**
 * DescribeInstance返回参数结构体
 */
export interface DescribeInstanceResponse {
    /**
     * <p>实例类型<br>BASIC 基础版<br>PRO  专业版<br>PLATINUM 铂金版</p>
     */
    InstanceType?: string;
    /**
     * <p>实例ID</p>
     */
    InstanceId?: string;
    /**
     * <p>实例名称</p>
     */
    InstanceName?: string;
    /**
     * <p>主题数量</p>
     */
    TopicNum?: number;
    /**
     * <p>实例最大主题数量</p>
     */
    TopicNumLimit?: number;
    /**
     * <p>TPS限流值</p>
     */
    TpsLimit?: number;
    /**
     * <p>创建时间，秒为单位</p>
     */
    CreatedTime?: number;
    /**
     * <p>备注信息</p>
     */
    Remark?: string;
    /**
     * <p>实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中</p>
     */
    InstanceStatus?: string;
    /**
     * <p>实例规格</p>
     */
    SkuCode?: string;
    /**
     * <p>单客户端最大订阅数</p>
     */
    MaxSubscriptionPerClient?: number;
    /**
     * <p>授权规则条数</p>
     */
    AuthorizationPolicyLimit?: number;
    /**
     * <p>客户端数量上限</p>
     */
    ClientNumLimit?: number;
    /**
     * <p>客户端证书注册方式：<br>JITP：自动注册<br>API：通过API手动注册</p>
     */
    DeviceCertificateProvisionType?: string;
    /**
     * <p>自动注册设备证书时是否自动激活</p>
     */
    AutomaticActivation?: boolean;
    /**
     * <p>是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费</p>
     */
    RenewFlag?: number;
    /**
     * <p>计费模式， POSTPAID，按量计费 PREPAID，包年包月</p>
     */
    PayMode?: string;
    /**
     * <p>到期时间，毫秒级时间戳</p>
     */
    ExpiryTime?: number;
    /**
     * <p>预销毁时间，毫秒级时间戳</p>
     */
    DestroyTime?: number;
    /**
     * <p>TLS,单向认证    mTLS,双向认证    BYOC;一机一证</p>
     */
    X509Mode?: string;
    /**
     * <p>最大Ca配额</p>
     */
    MaxCaNum?: number;
    /**
     * <p>证书注册码</p>
     */
    RegistrationCode?: string;
    /**
     * <p>集群最大订阅数</p>
     */
    MaxSubscription?: number;
    /**
     * <p>授权策略开关</p>
     */
    AuthorizationPolicy?: boolean;
    /**
     * <p>共享订阅组数最大限制</p>
     */
    SharedSubscriptionGroupLimit?: number;
    /**
     * <p>单个共享订阅组TopicFilter数限制</p>
     * @deprecated
     */
    MaxTopicFilterPerSharedSubscriptionGroup?: number;
    /**
     * <p>自动订阅规则条数限制</p>
     */
    AutoSubscriptionPolicyLimit?: number;
    /**
     * <p>单条自动订阅规则TopicFilter数限制</p>
     */
    MaxTopicFilterPerAutoSubscriptionPolicy?: number;
    /**
     * <p>是否使用默认的服务端证书</p>
     */
    UseDefaultServerCert?: boolean;
    /**
     * <p>服务端CA最大数量</p>
     */
    TrustedCaLimit?: number;
    /**
     * <p>服务端证书最大数量</p>
     */
    ServerCertLimit?: number;
    /**
     * <p>topic前缀最大层级</p>
     */
    TopicPrefixSlashLimit?: number;
    /**
     * <p>单客户端发送消息限速，单位 条/秒</p>
     */
    MessageRate?: number;
    /**
     * <p>服务端tls支持的协议，使用“,”分割。例如：TLSv1.3,TLSv1.2,TLSv1.1,TLSv1</p>
     */
    TransportLayerSecurity?: string;
    /**
     * <p>消息属性增强规则配额</p>
     */
    MessageEnrichmentRuleLimit?: number;
    /**
     * <p>封禁规则最大数量</p>
     */
    BlockRuleLimit?: number;
    /**
     * <p>删除保护开关</p>
     */
    DeleteProtect?: boolean;
    /**
     * <p>集群客户端事件格式</p><p>枚举值：</p><ul><li>V1： 详见官网文档</li><li>V2： 详见官网文档</li><li>V3： 详见官网文档</li></ul><p>默认值：V3</p>
     */
    EventDialect?: string;
    /**
     * <p>消息HASH策略</p><p>枚举值：</p><ul><li>TOPIC_NAME： 按主题名</li><li>CLIENT_ID： 按客户端ID</li></ul><p>默认值：TOPIC_NAME</p>
     */
    HashMessagePolicy?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateMessageEnrichmentRulePriority返回参数结构体
 */
export interface UpdateMessageEnrichmentRulePriorityResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyJWKSAuthenticator返回参数结构体
 */
export interface ModifyJWKSAuthenticatorResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeWillMessage返回参数结构体
 */
export interface DescribeWillMessageResponse {
    /**
     * <p>保留消息Topic</p>
     */
    Topic?: string;
    /**
     * <p>消息服务质量</p>
     */
    Qos?: number;
    /**
     * <p>是否保留消息</p>
     */
    Retained?: boolean;
    /**
     * <p>消息负载(Base64编码)</p>
     */
    Payload?: string;
    /**
     * <p>创建时间，毫秒级时间戳 。</p>
     */
    CreateTime?: number;
    /**
     * <p>更新时间，毫秒级时间戳 。</p>
     */
    UpdateTime?: number;
    /**
     * <p>遗嘱消息延迟时间，单位秒</p>
     */
    WillDelayInterval?: number;
    /**
     * <p>响应内容类型</p>
     */
    ContentType?: string;
    /**
     * <p>响应主题</p>
     */
    ResponseTopic?: string;
    /**
     * <p>关联数据（Base64编码）</p>
     */
    CorrelationData?: string;
    /**
     * <p>消息过期时间，单位秒</p>
     */
    MessageExpiryInterval?: number;
    /**
     * <p>负载格式指示器 1:UTF-8文本</p>
     */
    PayloadFormatIndicator?: number;
    /**
     * <p>用户属性</p>
     */
    UserProperties?: Array<UserProperty>;
    /**
     * <p>遗嘱消息发布时间</p>
     */
    PublishAfter?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteDeviceIdentity返回参数结构体
 */
export interface DeleteDeviceIdentityResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateInsPublicEndpoint返回参数结构体
 */
export interface CreateInsPublicEndpointResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateUser返回参数结构体
 */
export interface CreateUserResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateAuthorizationPolicy请求参数结构体
 */
export interface CreateAuthorizationPolicyRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。
     */
    PolicyName: string;
    /**
     * 策略版本,默认为1，当前仅支持1
     */
    PolicyVersion: number;
    /**
     * 策略优先级，越小越优先，不能重复，优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Priority: number;
    /**
     * 决策：
  allow：允许符合该策略的设备的访问请求。
  deny：拒绝覆盖该策略的设备的访问请求。
  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Effect: string;
    /**
     * 操作,支持多选，多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
  connect：连接
  pub：发布
  sub：订阅
     */
    Actions: string;
    /**
     * 条件-保留消息，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
  1,匹配保留消息；
  2,匹配非保留消息，
  3.匹配保留和非保留消息
     */
    Retain: number;
    /**
     * 条件：服务质量
  0：最多一次
  1：最少一次
  2：精确一次
  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Qos: string;
    /**
     * 资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
  
     */
    Resources?: string;
    /**
     * 条件-用户名
     */
    Username?: string;
    /**
     * 条件：客户端ID，支持正则
     */
    ClientId?: string;
    /**
     * 条件：客户端IP地址，支持IP或者CIDR，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Ip?: string;
    /**
     * 备注信息，最长 128 字符
     */
    Remark?: string;
}
/**
 * PublishMessage返回参数结构体
 */
export interface PublishMessageResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMessageEnrichmentRules返回参数结构体
 */
export interface DescribeMessageEnrichmentRulesResponse {
    /**
     * 消息增强策略
     */
    Data?: Array<MessageEnrichmentRuleItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAuthenticator返回参数结构体
 */
export interface DescribeAuthenticatorResponse {
    /**
     * 集群认证器列表
     */
    Authenticators?: Array<MQTTAuthenticatorItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeactivateCaCertificate返回参数结构体
 */
export interface DeactivateCaCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteCaCertificate请求参数结构体
 */
export interface DeleteCaCertificateRequest {
    /**
     * 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * CA证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
     */
    CaSn: string;
}
/**
 * DeleteDeviceCertificate请求参数结构体
 */
export interface DeleteDeviceCertificateRequest {
    /**
     * 集群id
     */
    InstanceId: string;
    /**
     * 设备证书序列号
     */
    DeviceCertificateSn: string;
}
/**
 * DescribeMessageByTopic请求参数结构体
 */
export interface DescribeMessageByTopicRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * home/room
     */
    Topic: string;
    /**
     * 开始时间，毫秒级时间戳 。
     */
    StartTime: number;
    /**
     * 查询消息条数，最大1024，默认100.
     */
    MaxNumber?: number;
}
/**
 * DescribeUserList请求参数结构体
 */
export interface DescribeUserListRequest {
    /**
     * 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 查询条件列表支持字段
  Username：按照【用户名】进行过滤，支持模糊过滤，类型：String
     */
    Filters?: Array<Filter>;
    /**
     * 查询起始位置，默认值0
     */
    Offset?: number;
    /**
     * 查询结果限制数量，默认值20，最大值100
     */
    Limit?: number;
}
/**
 * DeleteUser返回参数结构体
 */
export interface DeleteUserResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyX509Config请求参数结构体
 */
export interface ModifyX509ConfigRequest {
    /**
     * <p>腾讯云MQTT实例ID，从 <a href="https://cloud.tencent.com/document/api/1778/111029">DescribeInstanceList</a>接口或控制台获得。</p>
     */
    InstanceId: string;
    /**
     * <p>证书验证模式</p><p>枚举值：</p><ul><li>TLS： 单向认证</li><li>mTLS： 双向认证</li><li>BYOC： 一机一证</li></ul>
     */
    X509Mode?: string;
    /**
     * <p>证书注册方式</p><p>枚举值：</p><ul><li>JITP： 自动注册</li><li>API： 手工注册</li></ul>
     */
    DeviceCertificateProvisionType?: string;
    /**
     * <p>证书自动后激活状态</p><p>枚举值：</p><ul><li>true： 自动激活</li><li>false： 不激活</li></ul>
     */
    AutomaticActivation?: boolean;
}
/**
 * ActivateCaCertificate返回参数结构体
 */
export interface ActivateCaCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteDeviceCertificate返回参数结构体
 */
export interface DeleteDeviceCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMessageByTopic返回参数结构体
 */
export interface DescribeMessageByTopicResponse {
    /**
     * 消息列表
     */
    Data?: Array<MQTTMessage>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteInstance返回参数结构体
 */
export interface DeleteInstanceResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeProductSKUList返回参数结构体
 */
export interface DescribeProductSKUListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * mqtt商品配置信息
     */
    MQTTProductSkuList?: Array<ProductSkuItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateJWKSAuthenticator请求参数结构体
 */
export interface CreateJWKSAuthenticatorRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * JWKS服务地址，（Text字段和Endpoint字段必须选择一个填写）
     */
    Endpoint?: string;
    /**
     * 认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址（Endpoint）时生效。
     */
    RefreshInterval?: number;
    /**
     * jwks文本，（Text字段和Endpoint字段必须选择一个填写）
     */
    Text?: string;
    /**
     * 认证器是否开启：open-启用；close-关闭，默认open-启用
     */
    Status?: string;
    /**
     * 说明，不能超过 128 个字符
     */
    Remark?: string;
    /**
     * 认证字段；
  username-对应 MQTT CONNECT Packet 中 username 字段，
  password-对应 MQTT CONNECT Packet 中 password 字段。
  
  默认username
     */
    From?: string;
}
/**
 * DescribeTopic返回参数结构体
 */
export interface DescribeTopicResponse {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 主题名称
     */
    Topic?: string;
    /**
     * 备注
     */
    Remark?: string;
    /**
     * 创建时间，秒为单位
     */
    CreatedTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateJWKSAuthenticator返回参数结构体
 */
export interface CreateJWKSAuthenticatorResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyHttpAuthenticator返回参数结构体
 */
export interface ModifyHttpAuthenticatorResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAuthorizationPolicies返回参数结构体
 */
export interface DescribeAuthorizationPoliciesResponse {
    /**
     * 规则
     */
    Data?: Array<AuthorizationPolicyItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateTopic请求参数结构体
 */
export interface CreateTopicRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 主题，不能为空，只能包含字母、数字、“-”及“_”，3-100 字符。
     */
    Topic: string;
    /**
     * 备注，最长 128 字符
     */
    Remark?: string;
}
/**
 * DeleteCaCertificate返回参数结构体
 */
export interface DeleteCaCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSharedSubscriptionClient返回参数结构体
 */
export interface DescribeSharedSubscriptionClientResponse {
    /**
     * 共享订阅组下Client信息
     */
    Data?: Array<SharedSubscriptionClient>;
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 设备标识列表
 */
export interface DeviceIdentityBackupHistoryItem {
    /**
     * <p>设备id</p>
     */
    DeviceId?: string;
    /**
     * <p>1:ENABLED-可用2:DISABLE-不可用</p>
     */
    Status?: number;
    /**
     * <p>主要签名key（Base64编码）</p>
     */
    PrimaryKey?: string;
    /**
     * <p>次要签名key（Base64编码）</p>
     */
    SecondaryKey?: string;
    /**
     * <p>传播属性列表</p>
     */
    PropagatingProperties?: Array<PropagatingProperty>;
    /**
     * <p>数据来源</p>
     */
    Source?: string;
    /**
     * <p>修改时间</p><p>单位：毫秒级时间戳</p>
     */
    ModificationTime?: number;
}
/**
 * DeleteClientSubscription请求参数结构体
 */
export interface DeleteClientSubscriptionRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
    /**
     * 客户端id
     */
    ClientId?: string;
    /**
     * 订阅
     */
    TopicFilter?: string;
}
/**
 * 标签过滤器
 */
export interface TagFilter {
    /**
     * 标签键名称
     */
    TagKey?: string;
    /**
     * 标签键名称
     */
    TagValues?: Array<string>;
}
/**
 * DescribeMessageDetails返回参数结构体
 */
export interface DescribeMessageDetailsResponse {
    /**
     * 消息体
     */
    Body?: string;
    /**
     * 用户自定义属性
     */
    UserProperties?: Array<UserProperty>;
    /**
     * 消息存储时间，毫秒级时间戳。
     */
    StoreTimestamp?: number;
    /**
     * 消息ID
     */
    MessageId?: string;
    /**
     * 生产者地址
     */
    ClientId?: string;
    /**
     * Topic
     */
    Qos?: string;
    /**
     * 源topic
     */
    OriginTopic?: string;
    /**
     * 内容类型（MQTT5）
  含义：指示消息载荷的内容类型，使用标准的 MIME 类型格式。这帮助接收方正确解析和处理消息内容。
  示例：
  application/json：表示载荷是 JSON 格式的数据。
  text/plain：表示载荷是纯文本。
  application/octet-stream：表示载荷是二进制数据。
     */
    ContentType?: string;
    /**
     * 载荷格式指示符（MQTT5）
  含义：指示载荷的格式，是一个布尔值。0表示未指定格式（二进制），1表示 UTF-8 编码的字符串。
  示例：
  值为0：当载荷是二进制数据，如图片、音频等。
  值为1：当载荷是 UTF-8 编码的文本，如 JSON 字符串、XML 等。
     */
    PayloadFormatIndicator?: number;
    /**
     * 消息过期间隔（MQTT5）
  含义：指定消息在被丢弃前的有效时间（秒）。如果消息在过期前未能送达，则会被 MQTT 服务器丢弃。
  示例：
  值为60：表示消息在发布后的 60 秒内有效，过期后未送达则被丢弃。
  值为0：表示消息不过期，永久有效（直到被接收或会话结束）。
     */
    MessageExpiryInterval?: number;
    /**
     * 响应主题（MQTT5）
  含义：指定一个主题，用于请求 - 响应模式中的响应消息。发送方可以指定接收方应该将响应发送到哪个主题。
  示例：
  发送方发布请求到主题devices/device1/commands，并设置ResponseTopic为devices/device1/responses。
  接收方处理请求后，将响应发布到devices/device1/responses主题。
     */
    ResponseTopic?: string;
    /**
     * 关联数据（MQTT5）
  含义：用于关联请求和响应的标识符，通常是一个字节数组。在请求 - 响应模式中，发送方设置此值，接收方在响应中包含相同的值，以便发送方识别响应对应的请求。
  示例：
  发送方生成一个唯一 ID（如 UUID 的字节数组）作为CorrelationData，附加到请求消息中。
  接收方在响应消息中包含相同的CorrelationData，发送方通过比较此值来匹配响应和请求。
     */
    CorrelationData?: string;
    /**
     * 订阅标识符（MQTT5）
  含义：为订阅分配的唯一标识符，用于标识客户端的特定订阅。当服务器向客户端发送消息时，可以包含此标识符，帮助客户端识别消息对应的订阅。
  示例：
  客户端订阅主题devices/+/temperature，并设置SubscriptionIdentifier为123。
  当服务器向客户端发送此主题的消息时，会在消息中包含SubscriptionIdentifier: 123，客户端可以根据此值知道消息是通过哪个订阅接收的。
     */
    SubscriptionIdentifier?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeUserList返回参数结构体
 */
export interface DescribeUserListResponse {
    /**
     * 查询总数
     */
    TotalCount?: number;
    /**
     * 角色信息列表
     */
    Data?: Array<MQTTUserItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteMessageEnrichmentRule返回参数结构体
 */
export interface DeleteMessageEnrichmentRuleResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeactivateDeviceCertificate返回参数结构体
 */
export interface DeactivateDeviceCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSharedSubscriptionGroupsWithSubscriptions请求参数结构体
 */
export interface DescribeSharedSubscriptionGroupsWithSubscriptionsRequest {
    /**
     * <p>腾讯云MQTT实例ID，从 <a href="https://cloud.tencent.com/document/api/1778/111029">DescribeInstanceList</a>接口或控制台获得。</p>
     */
    InstanceId: string;
}
/**
 * ActivateCaCertificate请求参数结构体
 */
export interface ActivateCaCertificateRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
     */
    CaSn: string;
}
/**
 * HTTP 认证器body
 */
export interface BodyItem {
    /**
     * body key
     */
    Key: string;
    /**
     * body key
     */
    Value: string;
}
/**
 * ActivateDeviceCertificate返回参数结构体
 */
export interface ActivateDeviceCertificateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeTopic请求参数结构体
 */
export interface DescribeTopicRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
    /**
     * 主题
     */
    Topic: string;
}
/**
 * PublishMessage请求参数结构体
 */
export interface PublishMessageRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码
     */
    Payload: string;
    /**
     * 消息目的主题，该参数与 TargetClientId 二选一
     */
    TargetTopic?: string;
    /**
     * 消息目的客户端 ID，该参数与 TargetTopic 二选一
     */
    TargetClientId?: string;
    /**
     * 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）
     */
    Encoding?: string;
    /**
     * 消息的服务质量等级，默认为 1
  QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。
  QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。
  QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。
     */
    Qos?: number;
    /**
     * 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true
     */
    Retain?: boolean;
}
/**
 * AuthorizationPolicyItem
 */
export interface AuthorizationPolicyItem {
    /**
     * 策略规则ID
     */
    Id?: number;
    /**
     * MQTT集群ID
     */
    InstanceId?: string;
    /**
     * 策略规则名
     */
    PolicyName?: string;
    /**
     * 规则语法版本，当前仅支持1，默认为1
     */
    Version?: number;
    /**
     * 策略优先级，优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Priority?: number;
    /**
     * 决策
  allow：允许符合该策略的设备的访问请求。
  deny：拒绝覆盖该策略的设备的访问请求。
  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Effect?: string;
    /**
     * 操作
  connect：连接
  pub：发布mqtt消息
  sub：订阅mqtt消息
  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Actions?: string;
    /**
     * 资源，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Resources?: string;
    /**
     * 条件-连接设备ID，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    ClientId?: string;
    /**
     * 条件-用户名，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Username?: string;
    /**
     * 条件-客户端IP地址，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Ip?: string;
    /**
     * 条件-服务质量，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
     */
    Qos?: string;
    /**
     * 条件-保留消息，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
  1：表示匹配retain消息
  2：表示匹配非retain消息
  3：表示匹配retain和非retain消息
     */
    Retain?: number;
    /**
     * 备注，长度不超过128个字符。
     */
    Remark?: string;
    /**
     * 创建时间。毫秒级时间戳 。
     */
    CreatedTime?: number;
    /**
     * 更新时间。毫秒级时间戳 。
     */
    UpdateTime?: number;
}
/**
 * DescribeClientList请求参数结构体
 */
export interface DescribeClientListRequest {
    /**
     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
     */
    InstanceId: string;
    /**
     * 客户端ID
     */
    ClientId?: string;
    /**
     * 客户端数量限制,最大1024，默认1024
     */
    Number?: string;
    /**
     * 0:查询在线和离线客户端（默认值）
  1:查询在线客户端
  2:查询离线客户端
     */
    OnlineStatus?: number;
    /**
     * 在线连接：表示最后的连接时间
  离线连接：表示最后的断开连接时间
     */
    MaxTimestamp?: number;
}
/**
 * 共享订阅组
 */
export interface SharedGroup {
    /**
     * 腾讯云MQTT实例ID
     */
    InstanceId?: string;
    /**
     * 共享订阅组名
     */
    SharedName?: string;
    /**
     * 共享组消费负载均衡策略 1.RANDOM 2.HASH_PARTITION
     */
    LbStrategy?: number;
    /**
     * HASH_PARTITION 策略下生效，表示Client掉线或新Client上线加入共享订阅组消费的延迟时间。
  范围：0～600秒
     */
    ExpiryInterval?: number;
    /**
     * 备注，长度不超过128个字符。
  注意：此字段可能返回 null，表示取不到