tencentcloud-sdk-mqtt 3.0.1028 → 3.0.1029

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdd409eb1b1a37cfabe60554e5a8870ec03b3676
-  data.tar.gz: 1aa6eb467d732dd193d13e4ee79fd66d91fda962
+  metadata.gz: b88a9df5318e3c8ed9757dca626103d00a7a95da
+  data.tar.gz: 91b4d3c1f17dc51209cba4b278ee4c5e5d7bddcc
 SHA512:
-  metadata.gz: 53eb53e3c09e213e9523c5fbf7418898cbc0d0ad82a8513b6103aa5210271cecb563c83cfc29d34953f30a0716aad3ffce99721c807166201d481ab3bbf13b46
-  data.tar.gz: 9ab3798fa6c4aaaf341903d890677b3673138bf45b5e2aa11ab9754631b28ccf5bb943399b83543fcdcc9da362fa778e9f99b9ec1656e75c150302c3e3c5f40a
+  metadata.gz: f70270e9d524920bbad50ada08c4364b12fdcbbdc42181952c9ad42faf813c90796b7257920f62a272a4c4effec3c1170c3f27233b943caa3d15c2feb03bc264
+  data.tar.gz: 10745c6f35ca94e37252fa5239b118e2ee80c438ddd52087bed98c3b73626c274b4bbe1cf2171877e4bef9a10657a8f0ebbe5e60ef1e645031e12274f22fdfec

data/lib/VERSION

@@ -1 +1 @@
-3.0.1028
+3.0.1029

data/lib/v20240516/client.rb

@@ -802,7 +802,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询消息列表，如查询死信，请设置ConsumerGroup参数
+        # 根据一级Topic查询消息列表
 
         # @param request: Request instance for DescribeMessageList.
         # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageListRequest`
@@ -1023,7 +1023,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 修改实例属性
+        # 修改实例属性，只有运行中的集群可以调用该接口进行变更配置。
 
         # @param request: Request instance for ModifyInstance.
         # @type request: :class:`Tencentcloud::mqtt::V20240516::ModifyInstanceRequest`

data/lib/v20240516/models.rb

@@ -325,31 +325,42 @@ module TencentCloud
 
       # CreateAuthorizationPolicy请求参数结构体
       class CreateAuthorizationPolicyRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
         # @type InstanceId: String
-        # @param PolicyName: 策略名称
+        # @param PolicyName: 策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。
         # @type PolicyName: String
-        # @param PolicyVersion: 策略版本
+        # @param PolicyVersion: 策略版本,默认为1，当前仅支持1
         # @type PolicyVersion: Integer
-        # @param Priority: 策略优先级，越小越优先
+        # @param Priority: 策略优先级，越小越优先，不能重复
         # @type Priority: Integer
-        # @param Effect: allow、deny
+        # @param Effect: 决策：
+        # allow 允许
+        # deny 拒绝
         # @type Effect: String
-        # @param Actions: connect、pub、sub
+        # @param Actions: 操作
+        # connect：连接
+        # pub：发布
+        # sub：订阅
         # @type Actions: String
-        # @param Retain: 1,匹配保留消息；2,匹配非保留消息，3.匹配所有消息
+        # @param Retain: 条件-保留消息
+        # 1,匹配保留消息；
+        # 2,匹配非保留消息，
+        # 3.匹配保留和非保留消息
         # @type Retain: Integer
-        # @param Qos: 0、1、2
+        # @param Qos: 条件：服务质量
+        # 0：最多一次
+        # 1：最少一次
+        # 2：精确一次
         # @type Qos: String
-        # @param Resources: 资源
+        # @param Resources: 资源，需要匹配的订阅
         # @type Resources: String
-        # @param Username: 用户名
+        # @param Username: 条件-用户名
         # @type Username: String
-        # @param ClientId: 客户端
+        # @param ClientId: 条件：客户端ID，支持正则
         # @type ClientId: String
-        # @param Ip: IP地址
+        # @param Ip: 条件：客户端IP地址，支持IP或者CIDR
         # @type Ip: String
-        # @param Remark: 备注信息
+        # @param Remark: 备注信息，最长 128 字符
         # @type Remark: String
 
         attr_accessor :InstanceId, :PolicyName, :PolicyVersion, :Priority, :Effect, :Actions, :Retain, :Qos, :Resources, :Username, :ClientId, :Ip, :Remark
@@ -389,16 +400,24 @@ module TencentCloud
 
       # CreateAuthorizationPolicy返回参数结构体
       class CreateAuthorizationPolicyResponse < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 集群Id
+        # @type InstanceId: String
+        # @param Id: 策略id
+        # @type Id: Integer
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :RequestId
+        attr_accessor :InstanceId, :Id, :RequestId
 
-        def initialize(requestid=nil)
+        def initialize(instanceid=nil, id=nil, requestid=nil)
+          @InstanceId = instanceid
+          @Id = id
           @RequestId = requestid
         end
 
         def deserialize(params)
+          @InstanceId = params['InstanceId']
+          @Id = params['Id']
           @RequestId = params['RequestId']
         end
       end
@@ -1845,7 +1864,7 @@ module TencentCloud
 
       # DescribeInstance请求参数结构体
       class DescribeInstanceRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 实例ID [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)
         # @type InstanceId: String
 
         attr_accessor :InstanceId
@@ -1864,6 +1883,7 @@ module TencentCloud
         # @param InstanceType: 实例类型
         # BASIC 基础版
         # PRO  专业版
+        # PLATINUM 铂金版
         # @type InstanceType: String
         # @param InstanceId: 实例ID
         # @type InstanceId: String
@@ -1879,7 +1899,7 @@ module TencentCloud
         # @type CreatedTime: Integer
         # @param Remark: 备注信息
         # @type Remark: String
-        # @param InstanceStatus: 实例状态
+        # @param InstanceStatus: 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中
         # @type InstanceStatus: String
         # @param SkuCode: 实例规格
         # @type SkuCode: String
@@ -1895,13 +1915,13 @@ module TencentCloud
         # @type DeviceCertificateProvisionType: String
         # @param AutomaticActivation: 自动注册设备证书时是否自动激活
         # @type AutomaticActivation: Boolean
-        # @param RenewFlag: 是否自动续费
+        # @param RenewFlag: 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
         # @type RenewFlag: Integer
         # @param PayMode: 计费模式， POSTPAID，按量计费 PREPAID，包年包月
         # @type PayMode: String
-        # @param ExpiryTime: 到期时间，秒为单位
+        # @param ExpiryTime: 到期时间，毫秒级时间戳
         # @type ExpiryTime: Integer
-        # @param DestroyTime: 预销毁时间
+        # @param DestroyTime: 预销毁时间，毫秒级时间戳
         # @type DestroyTime: Integer
         # @param X509Mode: TLS,单向认证    mTLS,双向认证    BYOC;一机一证
         # @type X509Mode: String
@@ -1911,12 +1931,14 @@ module TencentCloud
         # @type RegistrationCode: String
         # @param MaxSubscription: 集群最大订阅数
         # @type MaxSubscription: Integer
+        # @param AuthorizationPolicy: 授权策略开关
+        # @type AuthorizationPolicy: Boolean
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :InstanceType, :InstanceId, :InstanceName, :TopicNum, :TopicNumLimit, :TpsLimit, :CreatedTime, :Remark, :InstanceStatus, :SkuCode, :MaxSubscriptionPerClient, :AuthorizationPolicyLimit, :ClientNumLimit, :DeviceCertificateProvisionType, :AutomaticActivation, :RenewFlag, :PayMode, :ExpiryTime, :DestroyTime, :X509Mode, :MaxCaNum, :RegistrationCode, :MaxSubscription, :RequestId
+        attr_accessor :InstanceType, :InstanceId, :InstanceName, :TopicNum, :TopicNumLimit, :TpsLimit, :CreatedTime, :Remark, :InstanceStatus, :SkuCode, :MaxSubscriptionPerClient, :AuthorizationPolicyLimit, :ClientNumLimit, :DeviceCertificateProvisionType, :AutomaticActivation, :RenewFlag, :PayMode, :ExpiryTime, :DestroyTime, :X509Mode, :MaxCaNum, :RegistrationCode, :MaxSubscription, :AuthorizationPolicy, :RequestId
 
-        def initialize(instancetype=nil, instanceid=nil, instancename=nil, topicnum=nil, topicnumlimit=nil, tpslimit=nil, createdtime=nil, remark=nil, instancestatus=nil, skucode=nil, maxsubscriptionperclient=nil, authorizationpolicylimit=nil, clientnumlimit=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, renewflag=nil, paymode=nil, expirytime=nil, destroytime=nil, x509mode=nil, maxcanum=nil, registrationcode=nil, maxsubscription=nil, requestid=nil)
+        def initialize(instancetype=nil, instanceid=nil, instancename=nil, topicnum=nil, topicnumlimit=nil, tpslimit=nil, createdtime=nil, remark=nil, instancestatus=nil, skucode=nil, maxsubscriptionperclient=nil, authorizationpolicylimit=nil, clientnumlimit=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, renewflag=nil, paymode=nil, expirytime=nil, destroytime=nil, x509mode=nil, maxcanum=nil, registrationcode=nil, maxsubscription=nil, authorizationpolicy=nil, requestid=nil)
           @InstanceType = instancetype
           @InstanceId = instanceid
           @InstanceName = instancename
@@ -1940,6 +1962,7 @@ module TencentCloud
           @MaxCaNum = maxcanum
           @RegistrationCode = registrationcode
           @MaxSubscription = maxsubscription
+          @AuthorizationPolicy = authorizationpolicy
           @RequestId = requestid
         end
 
@@ -1967,25 +1990,26 @@ module TencentCloud
           @MaxCaNum = params['MaxCaNum']
           @RegistrationCode = params['RegistrationCode']
           @MaxSubscription = params['MaxSubscription']
+          @AuthorizationPolicy = params['AuthorizationPolicy']
           @RequestId = params['RequestId']
         end
       end
 
       # DescribeMessageList请求参数结构体
       class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
         # @type InstanceId: String
-        # @param Topic: 主题
+        # @param Topic: 要查询的一级Topic，可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
         # @type Topic: String
-        # @param StartTime: 开始时间
+        # @param StartTime: 开始时间，毫秒级时间戳 。
         # @type StartTime: Integer
-        # @param EndTime: 结束时间
+        # @param EndTime: 结束时间，毫秒级时间戳 。
         # @type EndTime: Integer
-        # @param TaskRequestId: 请求任务id
+        # @param TaskRequestId: 请求任务id，用于相同查询参数下查询加速，第一次查询时无需传递，第一次查询会根据本次查询参数生成查询任务ID，保留查询条件，查询下一页消息时可传递第一次查询返回的任务ID。
         # @type TaskRequestId: String
-        # @param Offset: 查询起始位置
+        # @param Offset: 查询起始位置，默认0
         # @type Offset: Integer
-        # @param Limit: 查询结果限制数量
+        # @param Limit: 查询结果限制数量，默认20，最大50
         # @type Limit: Integer
 
         attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit
@@ -2463,16 +2487,35 @@ module TencentCloud
         # JWKS：JWKS认证器
         # HTTP：HTTP认证器
         # @type Type: String
-        # @param Config: HTTP认证器
+        # @param Config: 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（并发数）：最大并发请求数
+        # 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)
         # @type Config: String
         # @param Status: 认证器状态
@@ -2512,7 +2555,7 @@ module TencentCloud
         # @param ProtocolVersion: MQTT 协议版本
         # 3：表示MQTT 3.1版本
         # 4：表示 MQTT 3.1.1
-        # 5:   标识MQTT 5.0协议
+        # 5：表示MQTT 5.0协议
         # @type ProtocolVersion: Integer
         # @param Keepalive: 保持连接时间，单位：秒
         # @type Keepalive: Integer
@@ -2749,7 +2792,7 @@ module TencentCloud
         # @type Keys: String
         # @param ProducerAddr: 客户端地址
         # @type ProducerAddr: String
-        # @param ProduceTime: 消息发送时间
+        # @param ProduceTime: 消息发送时间，格式 日期时间：YYYY-MM-DD hh:mm:ss
         # @type ProduceTime: String
         # @param DeadLetterResendTimes: 死信重发次数
         # @type DeadLetterResendTimes: Integer
@@ -2758,6 +2801,9 @@ module TencentCloud
         # @param SubTopic: 子topic
         # @type SubTopic: String
         # @param Qos: 消息质量等级
+        # 0：至多一次
+        # 1：至少一次
+        # 2：精确一次
         # @type Qos: String
 
         attr_accessor :MsgId, :Tags, :Keys, :ProducerAddr, :ProduceTime, :DeadLetterResendTimes, :DeadLetterResendSuccessTimes, :SubTopic, :Qos
@@ -3115,13 +3161,14 @@ module TencentCloud
 
       # ModifyInstance请求参数结构体
       class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
         # @type InstanceId: String
-        # @param Name: 要修改实例名称
+        # @param Name: 要修改实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。
         # @type Name: String
-        # @param Remark: 要修改的备注信息
+        # @param Remark: 要修改的备注信息，最多64个字符。
         # @type Remark: String
-        # @param SkuCode: 要变更的配置规格
+        # @param SkuCode: 需要变更的配置规格
+        # 基础版和增强版集群不能升配到铂金版规格，铂金版集群不能降配至基础版和增强版规格。
         # @type SkuCode: String
         # @param DeviceCertificateProvisionType: 客户端证书注册方式：
         # JITP：自动注册
@@ -3129,16 +3176,19 @@ module TencentCloud
         # @type DeviceCertificateProvisionType: String
         # @param AutomaticActivation: 自动注册证书是否自动激活
         # @type AutomaticActivation: Boolean
+        # @param AuthorizationPolicy: 授权策略开关
+        # @type AuthorizationPolicy: Boolean
 
-        attr_accessor :InstanceId, :Name, :Remark, :SkuCode, :DeviceCertificateProvisionType, :AutomaticActivation
+        attr_accessor :InstanceId, :Name, :Remark, :SkuCode, :DeviceCertificateProvisionType, :AutomaticActivation, :AuthorizationPolicy
 
-        def initialize(instanceid=nil, name=nil, remark=nil, skucode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil)
+        def initialize(instanceid=nil, name=nil, remark=nil, skucode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, authorizationpolicy=nil)
           @InstanceId = instanceid
           @Name = name
           @Remark = remark
           @SkuCode = skucode
           @DeviceCertificateProvisionType = devicecertificateprovisiontype
           @AutomaticActivation = automaticactivation
+          @AuthorizationPolicy = authorizationpolicy
         end
 
         def deserialize(params)
@@ -3148,6 +3198,7 @@ module TencentCloud
           @SkuCode = params['SkuCode']
           @DeviceCertificateProvisionType = params['DeviceCertificateProvisionType']
           @AutomaticActivation = params['AutomaticActivation']
+          @AuthorizationPolicy = params['AuthorizationPolicy']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-mqtt
 version: !ruby/object:Gem::Version
-  version: 3.0.1028
+  version: 3.0.1029
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common