tencentcloud-sdk-mqtt 3.0.1026 → 3.0.1028

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20240516/client.rb +2 -2
  4. data/lib/v20240516/models.rb +199 -142
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b26c802ba1e6a0e62efd8ca02e31c37f4f13430b
4
- data.tar.gz: cb181237d1951f20d614b6c1b2e961dd775ca67c
3
+ metadata.gz: cdd409eb1b1a37cfabe60554e5a8870ec03b3676
4
+ data.tar.gz: 1aa6eb467d732dd193d13e4ee79fd66d91fda962
5
5
  SHA512:
6
- metadata.gz: aa63604ff9c0e70cf545c90eb1bfb51525f832784aa5c0411646064a36b5aa6ab74e0e30f2b428b09b3a385f342f49aa33116e3c1545296f488f3a5dda74e70c
7
- data.tar.gz: f3da49ba74e1d9102d6062a9ff78001f04a160928c583eb86655e2485db46a1c5f20d28e7a1010c554504db58ad7e8d9aa7defedad17b6bbfb35e92e4ea0ac92
6
+ metadata.gz: 53eb53e3c09e213e9523c5fbf7418898cbc0d0ad82a8513b6103aa5210271cecb563c83cfc29d34953f30a0716aad3ffce99721c807166201d481ab3bbf13b46
7
+ data.tar.gz: 9ab3798fa6c4aaaf341903d890677b3673138bf45b5e2aa11ab9754631b28ccf5bb943399b83543fcdcc9da362fa778e9f99b9ec1656e75c150302c3e3c5f40a
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1026
1
+ 3.0.1028
data/lib/v20240516/client.rb CHANGED
@@ -1192,7 +1192,7 @@ module TencentCloud
1192
1192
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1193
1193
  end
1194
1194
 
1195
- # 注册ca证书
1195
+ # 注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
1196
1196
 
1197
1197
  # @param request: Request instance for RegisterCaCertificate.
1198
1198
  # @type request: :class:`Tencentcloud::mqtt::V20240516::RegisterCaCertificateRequest`
@@ -1216,7 +1216,7 @@ module TencentCloud
1216
1216
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1217
1217
  end
1218
1218
 
1219
- # 注册设备证书
1219
+ # 注册设备证书（仅一机一证场景生效），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8)
1220
1220
 
1221
1221
  # @param request: Request instance for RegisterDeviceCertificate.
1222
1222
  # @type request: :class:`Tencentcloud::mqtt::V20240516::RegisterDeviceCertificateRequest`
data/lib/v20240516/models.rb CHANGED
@@ -19,9 +19,9 @@ module TencentCloud
19
19
  module V20240516
20
20
  # ActivateCaCertificate请求参数结构体
21
21
  class ActivateCaCertificateRequest < TencentCloud::Common::AbstractModel
22
- # @param InstanceId: 集群id
22
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
23
23
  # @type InstanceId: String
24
- # @param CaSn: 证书序列号
24
+ # @param CaSn: CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
25
25
  # @type CaSn: String
26
26
 
27
27
  attr_accessor :InstanceId, :CaSn
@@ -55,9 +55,9 @@ module TencentCloud
55
55
 
56
56
  # ActivateDeviceCertificate请求参数结构体
57
57
  class ActivateDeviceCertificateRequest < TencentCloud::Common::AbstractModel
58
- # @param InstanceId: 集群id
58
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
59
59
  # @type InstanceId: String
60
- # @param DeviceCertificateSn: 设备证书序列号
60
+ # @param DeviceCertificateSn: 设备证书的SN序列号，可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
61
61
  # @type DeviceCertificateSn: String
62
62
 
63
63
  attr_accessor :InstanceId, :DeviceCertificateSn
@@ -91,7 +91,7 @@ module TencentCloud
91
91
 
92
92
  # ApplyRegistrationCode请求参数结构体
93
93
  class ApplyRegistrationCodeRequest < TencentCloud::Common::AbstractModel
94
- # @param InstanceId: 集群id
94
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
95
95
  # @type InstanceId: String
96
96
 
97
97
  attr_accessor :InstanceId
@@ -131,39 +131,47 @@ module TencentCloud
131
131
 
132
132
  # AuthorizationPolicyItem
133
133
  class AuthorizationPolicyItem < TencentCloud::Common::AbstractModel
134
- # @param Id: 规则ID
134
+ # @param Id: 策略规则ID
135
135
  # @type Id: Integer
136
- # @param InstanceId: 集群ID
136
+ # @param InstanceId: MQTT集群ID
137
137
  # @type InstanceId: String
138
- # @param PolicyName: 规则名
138
+ # @param PolicyName: 策略规则名
139
139
  # @type PolicyName: String
140
- # @param Version: 规则语法版本
140
+ # @param Version: 规则语法版本，当前仅支持1，默认为1
141
141
  # @type Version: Integer
142
- # @param Priority: 越小越优先
142
+ # @param Priority: 策略优先级，优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
143
143
  # @type Priority: Integer
144
- # @param Effect: allow/deny
144
+ # @param Effect: 决策
145
+ # allow：允许符合该策略的设备的访问请求。
146
+ # deny：拒绝覆盖该策略的设备的访问请求。
147
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
145
148
  # @type Effect: String
146
- # @param Actions: connect、pub、sub
149
+ # @param Actions: 操作
150
+ # connect：连接
151
+ # pub：发布mqtt消息
152
+ # sub：订阅mqtt消息
153
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
147
154
  # @type Actions: String
148
- # @param Resources: 资源
155
+ # @param Resources: 资源，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
149
156
  # @type Resources: String
150
- # @param ClientId: client
157
+ # @param ClientId: 条件-连接设备ID，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
151
158
  # @type ClientId: String
152
- # @param Username: 用户
159
+ # @param Username: 条件-用户名，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
153
160
  # @type Username: String
154
- # @param Ip: IP地址
161
+ # @param Ip: 条件-客户端IP地址，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
155
162
  # @type Ip: String
156
- # @param Qos: 0，1，2
163
+ # @param Qos: 条件-服务质量，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
157
164
  # @type Qos: String
158
- # @param Retain: 1：表示匹配retain消息
165
+ # @param Retain: 条件-保留消息，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
166
+ # 1：表示匹配retain消息
159
167
  # 2：表示匹配非retain消息
160
168
  # 3：表示匹配retain和非retain消息
161
169
  # @type Retain: Integer
162
- # @param Remark: 描述
170
+ # @param Remark: 备注，长度不超过128个字符。
163
171
  # @type Remark: String
164
- # @param CreatedTime: 1713164969433
172
+ # @param CreatedTime: 创建时间。毫秒级时间戳 。
165
173
  # @type CreatedTime: Integer
166
- # @param UpdateTime: 1713164969433
174
+ # @param UpdateTime: 更新时间。毫秒级时间戳 。
167
175
  # @type UpdateTime: Integer
168
176
 
169
177
  attr_accessor :Id, :InstanceId, :PolicyName, :Version, :Priority, :Effect, :Actions, :Resources, :ClientId, :Username, :Ip, :Qos, :Retain, :Remark, :CreatedTime, :UpdateTime
@@ -209,7 +217,7 @@ module TencentCloud
209
217
 
210
218
  # 策略规则优先级
211
219
  class AuthorizationPolicyPriority < TencentCloud::Common::AbstractModel
212
- # @param Id: 策略id
220
+ # @param Id: 授权策略规则id，可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
213
221
  # @type Id: Integer
214
222
  # @param Priority: 优先级
215
223
  # @type Priority: Integer
@@ -249,31 +257,35 @@ module TencentCloud
249
257
 
250
258
  # CA证书信息
251
259
  class CaCertificateItem < TencentCloud::Common::AbstractModel
252
- # @param CaCn: common name
260
+ # @param CaCn: 证书的公用名(Common Name)
253
261
  # @type CaCn: String
254
262
  # @param CaCertificate: 证书内容
255
263
  # @type CaCertificate: String
256
264
  # @param CaSn: 证书序列号
257
265
  # @type CaSn: String
258
- # @param Format: 证书格式
266
+ # @param Format: 证书格式，当前仅支持 PEM 格式
259
267
  # @type Format: String
260
268
  # @param VerificationCertificate: 验证证书内容
261
269
  # @type VerificationCertificate: String
262
- # @param Status: ca状态
270
+ # @param Status: CA证书的状态
271
+ # ACTIVE：激活
272
+ # INACTIVE：未激活
273
+ # REVOKED：吊销
274
+ # PENDING_ACTIVATION：注册待激活
263
275
  # @type Status: String
264
- # @param LastActivationTime: 上次激活时间
276
+ # @param LastActivationTime: 上次激活时间，毫秒级时间戳 。
265
277
  # @type LastActivationTime: Integer
266
- # @param CreatedTime: 创建时间
278
+ # @param CreatedTime: 创建时间，毫秒级时间戳 。
267
279
  # @type CreatedTime: Integer
268
- # @param UpdateTime: 预销毁时间
280
+ # @param UpdateTime: 更新时间，毫秒级时间戳 。
269
281
  # @type UpdateTime: Integer
270
- # @param LastInactivationTime: 上次去激活时间
282
+ # @param LastInactivationTime: 上次去激活时间，毫秒级时间戳 。
271
283
  # @type LastInactivationTime: Integer
272
284
  # @param CaIssuerCn: Ca证书颁发者CN
273
285
  # @type CaIssuerCn: String
274
- # @param NotBeforeTime: 生效时间
286
+ # @param NotBeforeTime: 生效时间，毫秒级时间戳 。
275
287
  # @type NotBeforeTime: Integer
276
- # @param NotAfterTime: 失效时间
288
+ # @param NotAfterTime: 失效时间，毫秒级时间戳 。
277
289
  # @type NotAfterTime: Integer
278
290
 
279
291
  attr_accessor :CaCn, :CaCertificate, :CaSn, :Format, :VerificationCertificate, :Status, :LastActivationTime, :CreatedTime, :UpdateTime, :LastInactivationTime, :CaIssuerCn, :NotBeforeTime, :NotAfterTime
@@ -739,11 +751,11 @@ module TencentCloud
739
751
 
740
752
  # CreateTopic请求参数结构体
741
753
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
742
- # @param InstanceId: 实例ID
754
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
743
755
  # @type InstanceId: String
744
- # @param Topic: 主题
756
+ # @param Topic: 主题，不能为空，只能包含字母、数字、“-”及“_”，3-100 字符。
745
757
  # @type Topic: String
746
- # @param Remark: 备注
758
+ # @param Remark: 备注，最长 128 字符
747
759
  # @type Remark: String
748
760
 
749
761
  attr_accessor :InstanceId, :Topic, :Remark
@@ -787,13 +799,13 @@ module TencentCloud
787
799
 
788
800
  # CreateUser请求参数结构体
789
801
  class CreateUserRequest < TencentCloud::Common::AbstractModel
790
- # @param InstanceId: 实例ID
802
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
791
803
  # @type InstanceId: String
792
- # @param Username: 用户名
804
+ # @param Username: 用户名，不能为空，只支持数字 大小写字母 分隔符("_","-")，不能超过 32 个字符
793
805
  # @type Username: String
794
- # @param Password: 密码，该字段为空时候则后端会默认生成
806
+ # @param Password: 密码，该字段为空时候则后端会默认生成。用户自定义密码时，不能为空，只支持数字 大小写字母 分隔符("_","-")，不能超过 64 个字符。
795
807
  # @type Password: String
796
- # @param Remark: 备注
808
+ # @param Remark: 备注，长度不超过128个字符。
797
809
  # @type Remark: String
798
810
 
799
811
  attr_accessor :InstanceId, :Username, :Password, :Remark
@@ -831,9 +843,9 @@ module TencentCloud
831
843
 
832
844
  # DeactivateCaCertificate请求参数结构体
833
845
  class DeactivateCaCertificateRequest < TencentCloud::Common::AbstractModel
834
- # @param InstanceId: 集群id
846
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
835
847
  # @type InstanceId: String
836
- # @param CaSn: 证书序列号
848
+ # @param CaSn: 证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
837
849
  # @type CaSn: String
838
850
 
839
851
  attr_accessor :InstanceId, :CaSn
@@ -867,9 +879,9 @@ module TencentCloud
867
879
 
868
880
  # DeactivateDeviceCertificate请求参数结构体
869
881
  class DeactivateDeviceCertificateRequest < TencentCloud::Common::AbstractModel
870
- # @param InstanceId: 集群id
882
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
871
883
  # @type InstanceId: String
872
- # @param DeviceCertificateSn: 设备证书序列号
884
+ # @param DeviceCertificateSn: 设备证书的SN序列号，可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
873
885
  # @type DeviceCertificateSn: String
874
886
 
875
887
  attr_accessor :InstanceId, :DeviceCertificateSn
@@ -903,12 +915,12 @@ module TencentCloud
903
915
 
904
916
  # DeleteAuthenticator请求参数结构体
905
917
  class DeleteAuthenticatorRequest < TencentCloud::Common::AbstractModel
906
- # @param InstanceId: 实例ID
918
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
907
919
  # @type InstanceId: String
908
920
  # @param Type: 认证器类型:
909
921
  # JWT：JWT认证器
910
922
  # JWKS：JWKS认证器
911
- # BYOC：一端一证认证器
923
+ # HTTP：HTTP认证器
912
924
  # @type Type: String
913
925
 
914
926
  attr_accessor :InstanceId, :Type
@@ -942,9 +954,9 @@ module TencentCloud
942
954
 
943
955
  # DeleteAuthorizationPolicy请求参数结构体
944
956
  class DeleteAuthorizationPolicyRequest < TencentCloud::Common::AbstractModel
945
- # @param InstanceId: 实例ID
957
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
946
958
  # @type InstanceId: String
947
- # @param Id: 策略规则id
959
+ # @param Id: 授权策略规则id，可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
948
960
  # @type Id: Integer
949
961
 
950
962
  attr_accessor :InstanceId, :Id
@@ -978,9 +990,9 @@ module TencentCloud
978
990
 
979
991
  # DeleteCaCertificate请求参数结构体
980
992
  class DeleteCaCertificateRequest < TencentCloud::Common::AbstractModel
981
- # @param InstanceId: 集群id
993
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
982
994
  # @type InstanceId: String
983
- # @param CaSn: 证书序列号
995
+ # @param CaSn: CA证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
984
996
  # @type CaSn: String
985
997
 
986
998
  attr_accessor :InstanceId, :CaSn
@@ -1050,7 +1062,7 @@ module TencentCloud
1050
1062
 
1051
1063
  # DeleteInsPublicEndpoint请求参数结构体
1052
1064
  class DeleteInsPublicEndpointRequest < TencentCloud::Common::AbstractModel
1053
- # @param InstanceId: 实例ID
1065
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1054
1066
  # @type InstanceId: String
1055
1067
 
1056
1068
  attr_accessor :InstanceId
@@ -1082,7 +1094,7 @@ module TencentCloud
1082
1094
 
1083
1095
  # DeleteInstance请求参数结构体
1084
1096
  class DeleteInstanceRequest < TencentCloud::Common::AbstractModel
1085
- # @param InstanceId: 实例ID
1097
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1086
1098
  # @type InstanceId: String
1087
1099
 
1088
1100
  attr_accessor :InstanceId
@@ -1186,9 +1198,12 @@ module TencentCloud
1186
1198
 
1187
1199
  # DescribeAuthenticator请求参数结构体
1188
1200
  class DescribeAuthenticatorRequest < TencentCloud::Common::AbstractModel
1189
- # @param InstanceId: 实例ID
1201
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1190
1202
  # @type InstanceId: String
1191
- # @param Type: 认证器类型: JWT：JWT认证器 JWKS：JWKS认证器 HTTP:HTTP认证器
1203
+ # @param Type: 认证器类型:
1204
+ # JWT：JWT认证器
1205
+ # JWKS：JWKS认证器
1206
+ # HTTP：HTTP认证器
1192
1207
  # @type Type: String
1193
1208
 
1194
1209
  attr_accessor :InstanceId, :Type
@@ -1233,7 +1248,7 @@ module TencentCloud
1233
1248
 
1234
1249
  # DescribeAuthorizationPolicies请求参数结构体
1235
1250
  class DescribeAuthorizationPoliciesRequest < TencentCloud::Common::AbstractModel
1236
- # @param InstanceId: 集群ID
1251
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1237
1252
  # @type InstanceId: String
1238
1253
 
1239
1254
  attr_accessor :InstanceId
@@ -1276,9 +1291,9 @@ module TencentCloud
1276
1291
 
1277
1292
  # DescribeCaCertificate请求参数结构体
1278
1293
  class DescribeCaCertificateRequest < TencentCloud::Common::AbstractModel
1279
- # @param CaSn: ca证书sn
1294
+ # @param CaSn: CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
1280
1295
  # @type CaSn: String
1281
- # @param InstanceId: 集群id
1296
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1282
1297
  # @type InstanceId: String
1283
1298
 
1284
1299
  attr_accessor :CaSn, :InstanceId
@@ -1296,29 +1311,31 @@ module TencentCloud
1296
1311
 
1297
1312
  # DescribeCaCertificate返回参数结构体
1298
1313
  class DescribeCaCertificateResponse < TencentCloud::Common::AbstractModel
1299
- # @param CreatedTime: 创建时间
1314
+ # @param CreatedTime: 创建时间，毫秒级时间戳 。
1300
1315
  # @type CreatedTime: Integer
1301
- # @param UpdateTime: 上次更新时间
1316
+ # @param UpdateTime: 上次更新时间，毫秒级时间戳 。
1302
1317
  # @type UpdateTime: Integer
1303
- # @param NotAfterTime: 失效日期
1318
+ # @param NotAfterTime: 失效日期，毫秒级时间戳 。
1304
1319
  # @type NotAfterTime: Integer
1305
- # @param LastActivationTime: 上次激活时间
1320
+ # @param LastActivationTime: 上次激活时间，毫秒级时间戳 。
1306
1321
  # @type LastActivationTime: Integer
1307
- # @param LastInactivationTime: 上次吊销时间
1322
+ # @param LastInactivationTime: 上次吊销时间，毫秒级时间戳 。
1308
1323
  # @type LastInactivationTime: Integer
1309
- # @param Status: 证书状态
1324
+ # @param Status: CA证书状态
1325
+ # ACTIVE：激活
1326
+ # INACTIVE：未激活
1310
1327
  # @type Status: String
1311
1328
  # @param CaSn: 证书序列号
1312
1329
  # @type CaSn: String
1313
- # @param CaCn: common name
1330
+ # @param CaCn: 证书的CN（Common Name），证书中用于标识主体的名称，通常是域名或组织名称
1314
1331
  # @type CaCn: String
1315
1332
  # @param CaCertificate: 证书内容
1316
1333
  # @type CaCertificate: String
1317
- # @param Format: 证书格式
1334
+ # @param Format: 证书格式，当仅支持PEM格式
1318
1335
  # @type Format: String
1319
1336
  # @param CaIssuerCn: Ca证书颁发者CN
1320
1337
  # @type CaIssuerCn: String
1321
- # @param NotBeforeTime: 生效开始时间
1338
+ # @param NotBeforeTime: 生效开始时间，毫秒级时间戳 。
1322
1339
  # @type NotBeforeTime: Integer
1323
1340
  # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
1324
1341
  # @type RequestId: String
@@ -1360,7 +1377,7 @@ module TencentCloud
1360
1377
 
1361
1378
  # DescribeCaCertificates请求参数结构体
1362
1379
  class DescribeCaCertificatesRequest < TencentCloud::Common::AbstractModel
1363
- # @param InstanceId: 集群ID
1380
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1364
1381
  # @type InstanceId: String
1365
1382
 
1366
1383
  attr_accessor :InstanceId
@@ -1403,9 +1420,9 @@ module TencentCloud
1403
1420
 
1404
1421
  # DescribeClientList请求参数结构体
1405
1422
  class DescribeClientListRequest < TencentCloud::Common::AbstractModel
1406
- # @param InstanceId: 实例ID
1423
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1407
1424
  # @type InstanceId: String
1408
- # @param ClientId: 客户端名
1425
+ # @param ClientId: 客户端ID
1409
1426
  # @type ClientId: String
1410
1427
  # @param Number: 客户端数量限制,最大1024，默认1024
1411
1428
  # @type Number: String
@@ -1454,9 +1471,9 @@ module TencentCloud
1454
1471
 
1455
1472
  # DescribeDeviceCertificate请求参数结构体
1456
1473
  class DescribeDeviceCertificateRequest < TencentCloud::Common::AbstractModel
1457
- # @param DeviceCertificateSn: 设备证书sn
1474
+ # @param DeviceCertificateSn: 设备证书的SN序列号，用于唯一标识一个设备证书。
1458
1475
  # @type DeviceCertificateSn: String
1459
- # @param InstanceId: 集群id
1476
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1460
1477
  # @type InstanceId: String
1461
1478
 
1462
1479
  attr_accessor :DeviceCertificateSn, :InstanceId
@@ -1474,17 +1491,21 @@ module TencentCloud
1474
1491
 
1475
1492
  # DescribeDeviceCertificate返回参数结构体
1476
1493
  class DescribeDeviceCertificateResponse < TencentCloud::Common::AbstractModel
1477
- # @param CreatedTime: 创建时间
1494
+ # @param CreatedTime: 创建时间，毫秒级时间戳 。
1478
1495
  # @type CreatedTime: Integer
1479
- # @param UpdateTime: 上次更新时间
1496
+ # @param UpdateTime: 上次更新时间，毫秒级时间戳 。
1480
1497
  # @type UpdateTime: Integer
1481
- # @param NotAfterTime: 证书失效日期
1498
+ # @param NotAfterTime: 证书失效日期，毫秒级时间戳 。
1482
1499
  # @type NotAfterTime: Integer
1483
- # @param LastActivationTime: 上次激活时间
1500
+ # @param LastActivationTime: 上次激活时间，毫秒级时间戳 。
1484
1501
  # @type LastActivationTime: Integer
1485
- # @param LastInactivationTime: 上次取消激活时间
1502
+ # @param LastInactivationTime: 上次取消激活时间，毫秒级时间戳 。
1486
1503
  # @type LastInactivationTime: Integer
1487
- # @param Status: 证书状态
1504
+ # @param Status: 设备证书的状态
1505
+ # ACTIVE：激活
1506
+ # INACTIVE：未激活
1507
+ # REVOKED：吊销
1508
+ # PENDING_ACTIVATION：注册待激活
1488
1509
  # @type Status: String
1489
1510
  # @param CaSn: Ca证书序列号
1490
1511
  # @type CaSn: String
@@ -1494,14 +1515,15 @@ module TencentCloud
1494
1515
  # @type DeviceCertificate: String
1495
1516
  # @param DeviceCertificateCn: 设备证书common name
1496
1517
  # @type DeviceCertificateCn: String
1497
- # @param Format: 证书格式
1518
+ # @param Format: 证书格式，当前仅支持PEM格式
1498
1519
  # @type Format: String
1499
1520
  # @param ClientId: 客户端id
1500
1521
  # @type ClientId: String
1501
- # @param CertificateSource: API, 手动注册
1502
- # JITP 自动注册
1522
+ # @param CertificateSource: 证书来源
1523
+ # API：手动注册
1524
+ # JITP：自动注册
1503
1525
  # @type CertificateSource: String
1504
- # @param NotBeforeTime: 证书生效开始时间
1526
+ # @param NotBeforeTime: 证书生效开始时间，毫秒级时间戳 。
1505
1527
  # @type NotBeforeTime: Integer
1506
1528
  # @param OrganizationalUnit: 组织单位
1507
1529
  # @type OrganizationalUnit: String
@@ -1551,15 +1573,24 @@ module TencentCloud
1551
1573
 
1552
1574
  # DescribeDeviceCertificates请求参数结构体
1553
1575
  class DescribeDeviceCertificatesRequest < TencentCloud::Common::AbstractModel
1554
- # @param InstanceId: 集群ID
1576
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1555
1577
  # @type InstanceId: String
1556
- # @param Filters: 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
1578
+ # @param Filters: 支持搜索参数
1579
+ # ClientId：客户端id，根据实际业务使用获取
1580
+ # CaSn：所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
1581
+ # DeviceCertificateSn：设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
1582
+ # DeviceCertificateCn：设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
1583
+ # OrganizationalUnit：证书OU
1584
+ # NotAfterEnd：过期时间小于等于指定时间的证书
1585
+ # NotAfterStart：过期时间大于等于指定时间的证书
1586
+ # Status：设备证书状态 ACTIVE（激活）； INACTIVE（未激活）REVOKED（吊销）；PENDING_ACTIVATION（注册待激活）
1557
1587
  # @type Filters: Array
1558
- # @param Limit: 分页limit
1588
+ # @param Limit: 分页limit，默认20，最大100
1559
1589
  # @type Limit: Integer
1560
- # @param Offset: 分页偏移量
1590
+ # @param Offset: 分页偏移量，默认0
1561
1591
  # @type Offset: Integer
1562
- # @param OrderBy: CREATE_TIME_DESC, 创建时间降序
1592
+ # @param OrderBy: 排序规则
1593
+ # CREATE_TIME_DESC, 创建时间降序
1563
1594
  # CREATE_TIME_ASC,创建时间升序
1564
1595
  # UPDATE_TIME_DESC,更新时间降序
1565
1596
  # UPDATE_TIME_ASC,更新时间升序
@@ -1595,7 +1626,7 @@ module TencentCloud
1595
1626
  class DescribeDeviceCertificatesResponse < TencentCloud::Common::AbstractModel
1596
1627
  # @param TotalCount: 总数
1597
1628
  # @type TotalCount: Integer
1598
- # @param Data: 设备证书
1629
+ # @param Data: 设备证书列表
1599
1630
  # @type Data: Array
1600
1631
  # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
1601
1632
  # @type RequestId: String
@@ -1624,7 +1655,7 @@ module TencentCloud
1624
1655
 
1625
1656
  # DescribeInsPublicEndpoints请求参数结构体
1626
1657
  class DescribeInsPublicEndpointsRequest < TencentCloud::Common::AbstractModel
1627
- # @param InstanceId: 实例ID
1658
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1628
1659
  # @type InstanceId: String
1629
1660
 
1630
1661
  attr_accessor :InstanceId
@@ -1644,7 +1675,7 @@ module TencentCloud
1644
1675
  # @type Endpoints: Array
1645
1676
  # @param InstanceId: 实例id
1646
1677
  # @type InstanceId: String
1647
- # @param Bandwidth: 带宽
1678
+ # @param Bandwidth: 带宽，单位Mbps
1648
1679
  # @type Bandwidth: Integer
1649
1680
  # @param Rules: 公网访问规则
1650
1681
  # @type Rules: Array
@@ -1695,7 +1726,7 @@ module TencentCloud
1695
1726
 
1696
1727
  # DescribeInsVPCEndpoints请求参数结构体
1697
1728
  class DescribeInsVPCEndpointsRequest < TencentCloud::Common::AbstractModel
1698
- # @param InstanceId: 实例ID
1729
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1699
1730
  # @type InstanceId: String
1700
1731
 
1701
1732
  attr_accessor :InstanceId
@@ -2099,14 +2130,14 @@ module TencentCloud
2099
2130
 
2100
2131
  # DescribeTopicList请求参数结构体
2101
2132
  class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
2102
- # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2133
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2103
2134
  # @type InstanceId: String
2104
2135
  # @param Filters: 查询条件列表:
2105
2136
  # 支持TopicName模糊查询
2106
2137
  # @type Filters: Array
2107
- # @param Offset: 查询起始位置
2138
+ # @param Offset: 查询起始位置，默认0。
2108
2139
  # @type Offset: Integer
2109
- # @param Limit: 查询结果限制数量
2140
+ # @param Limit: 查询结果限制数量，默认20，最大20
2110
2141
  # @type Limit: Integer
2111
2142
 
2112
2143
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -2218,14 +2249,14 @@ module TencentCloud
2218
2249
 
2219
2250
  # DescribeUserList请求参数结构体
2220
2251
  class DescribeUserListRequest < TencentCloud::Common::AbstractModel
2221
- # @param InstanceId: 实例ID
2252
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2222
2253
  # @type InstanceId: String
2223
2254
  # @param Filters: 查询条件列表支持字段
2224
- # Username：Username模糊查询
2255
+ # Username：按照【用户名】进行过滤，支持模糊过滤，类型：String
2225
2256
  # @type Filters: Array
2226
- # @param Offset: 查询起始位置
2257
+ # @param Offset: 查询起始位置，默认值0
2227
2258
  # @type Offset: Integer
2228
- # @param Limit: 查询结果限制数量
2259
+ # @param Limit: 查询结果限制数量，默认值20，最大值100
2229
2260
  # @type Limit: Integer
2230
2261
 
2231
2262
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -2289,37 +2320,37 @@ module TencentCloud
2289
2320
  # @type ClientId: String
2290
2321
  # @param DeviceCertificate: 设备证书
2291
2322
  # @type DeviceCertificate: String
2292
- # @param DeviceCertificateSn: 设备证书Sn
2323
+ # @param DeviceCertificateSn: 设备证书SN序列号，用于唯一标识一个设备证书
2293
2324
  # @type DeviceCertificateSn: String
2294
2325
  # @param DeviceCertificateCn: 设备证书Cn
2295
2326
  # @type DeviceCertificateCn: String
2296
- # @param CaSn: 签发ca的序列号
2327
+ # @param CaSn: 签发该证书的CA证书的序列号
2297
2328
  # @type CaSn: String
2298
- # @param Format: 证书格式
2329
+ # @param Format: 证书格式，当前仅支持PEM
2299
2330
  # @type Format: String
2300
- # @param Status: 证书状态
2301
- # ACTIVE,//激活
2302
- # INACTIVE,//未激活
2303
- # REVOKED,//吊销
2304
- # PENDING_ACTIVATION,//注册待激活
2331
+ # @param Status: 设备证书状态
2332
+ # ACTIVE：激活
2333
+ # INACTIVE：未激活
2334
+ # REVOKED：吊销
2335
+ # PENDING_ACTIVATION：注册待激活
2305
2336
  # @type Status: String
2306
2337
  # @param OrganizationalUnit: 组织单位
2307
2338
  # @type OrganizationalUnit: String
2308
- # @param LastActivationTime: 上次激活时间
2339
+ # @param LastActivationTime: 上次激活时间，毫秒级时间戳 。
2309
2340
  # @type LastActivationTime: Integer
2310
- # @param LastInactivationTime: 上次取消激活时间
2341
+ # @param LastInactivationTime: 上次取消激活时间，毫秒级时间戳 。
2311
2342
  # @type LastInactivationTime: Integer
2312
- # @param CreatedTime: 创建时间
2343
+ # @param CreatedTime: 创建时间，毫秒级时间戳 。
2313
2344
  # @type CreatedTime: Integer
2314
- # @param UpdateTime: 预销毁时间
2345
+ # @param UpdateTime: 更新时间，毫秒级时间戳 。
2315
2346
  # @type UpdateTime: Integer
2316
2347
  # @param CertificateSource: 证书来源：
2317
2348
  # API, 手动注册
2318
2349
  # JITP 自动注册
2319
2350
  # @type CertificateSource: String
2320
- # @param NotAfterTime: 证书失效日期
2351
+ # @param NotAfterTime: 证书失效日期，毫秒级时间戳 。
2321
2352
  # @type NotAfterTime: Integer
2322
- # @param NotBeforeTime: 证书生效开始日期
2353
+ # @param NotBeforeTime: 证书生效开始日期，毫秒级时间戳 。
2323
2354
  # @type NotBeforeTime: Integer
2324
2355
 
2325
2356
  attr_accessor :ClientId, :DeviceCertificate, :DeviceCertificateSn, :DeviceCertificateCn, :CaSn, :Format, :Status, :OrganizationalUnit, :LastActivationTime, :LastInactivationTime, :CreatedTime, :UpdateTime, :CertificateSource, :NotAfterTime, :NotBeforeTime
@@ -2427,15 +2458,30 @@ module TencentCloud
2427
2458
 
2428
2459
  # MQTT认证器信息
2429
2460
  class MQTTAuthenticatorItem < TencentCloud::Common::AbstractModel
2430
- # @param Type: 认证器类型: JWT：JWT认证器 JWKS：JWKS认证器 BYOC：一端一证认证器
2461
+ # @param Type: 认证器类型
2462
+ # JWT：JWT认证器
2463
+ # JWKS：JWKS认证器
2464
+ # HTTP：HTTP认证器
2431
2465
  # @type Type: String
2432
- # @param Config: 认证器配置
2466
+ # @param Config: HTTP认证器
2467
+ # headers（请求头）：标准请求头和自定义请求头
2468
+ # endpoint（接入点）：认证服务器接入点
2469
+ # method（http请求方法）：POST/GET
2470
+ # readTimeout（读超时时间）：读取认证服务器数据超时时间，单位秒
2471
+ # connectTimeout（连接超时时间）：连接认证服务器超时时间，单位秒
2472
+ # body（请求体）：http请求体
2473
+ # concurrency（并发数）：最大并发请求数
2474
+ # 样例：{"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}
2475
+
2476
+ # 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
2433
2477
  # @type Config: String
2434
2478
  # @param Status: 认证器状态
2479
+ # open：认证器打开
2480
+ # close：认证器关闭
2435
2481
  # @type Status: String
2436
- # @param CreateTime: 创建时间
2482
+ # @param CreateTime: 创建时间，毫秒级时间戳 。
2437
2483
  # @type CreateTime: Integer
2438
- # @param Remark: 说明
2484
+ # @param Remark: 说明，最长 128 字符。
2439
2485
  # @type Remark: String
2440
2486
 
2441
2487
  attr_accessor :Type, :Config, :Status, :CreateTime, :Remark
@@ -2459,21 +2505,24 @@ module TencentCloud
2459
2505
 
2460
2506
  # MQTT客户端信息
2461
2507
  class MQTTClientInfo < TencentCloud::Common::AbstractModel
2462
- # @param ClientId: 客户端唯一标识
2508
+ # @param ClientId: 客户端ID
2463
2509
  # @type ClientId: String
2464
2510
  # @param ClientAddress: 客户端网络地址
2465
2511
  # @type ClientAddress: String
2466
- # @param ProtocolVersion: MQTT 协议版本，4 表示 MQTT 3.1.1
2512
+ # @param ProtocolVersion: MQTT 协议版本
2513
+ # 3：表示MQTT 3.1版本
2514
+ # 4：表示 MQTT 3.1.1
2515
+ # 5: 标识MQTT 5.0协议
2467
2516
  # @type ProtocolVersion: Integer
2468
2517
  # @param Keepalive: 保持连接时间，单位：秒
2469
2518
  # @type Keepalive: Integer
2470
2519
  # @param ConnectionStatus: 连接状态，CONNECTED 已连接，DISCONNECTED 未连接
2471
2520
  # @type ConnectionStatus: String
2472
- # @param CreateTime: 客户端创建时间
2521
+ # @param CreateTime: 客户端创建时间，毫秒级时间戳 。
2473
2522
  # @type CreateTime: Integer
2474
- # @param ConnectTime: 上次建立连接时间
2523
+ # @param ConnectTime: 上次建立连接时间，毫秒级时间戳 。
2475
2524
  # @type ConnectTime: Integer
2476
- # @param DisconnectTime: 上次断开连接时间，仅对持久会话（cleanSession=false）并且客户端当前未连接时有意义
2525
+ # @param DisconnectTime: 上次断开连接时间，仅对持久会话（cleanSession=false）并且客户端当前未连接时有意义，毫秒级时间戳 。
2477
2526
  # @type DisconnectTime: Integer
2478
2527
  # @param MQTTClientSubscriptions: 客户端的订阅列表
2479
2528
  # @type MQTTClientSubscriptions: Array
@@ -2517,6 +2566,9 @@ module TencentCloud
2517
2566
  # @param TopicFilter: topic 订阅
2518
2567
  # @type TopicFilter: String
2519
2568
  # @param Qos: 服务质量等级
2569
+ # 0: 至多一次
2570
+ # 1: 至少一次
2571
+ # 2: 恰好一次
2520
2572
  # @type Qos: Integer
2521
2573
  # @param Lag: 堆积数量
2522
2574
  # @type Lag: Integer
@@ -2621,7 +2673,7 @@ module TencentCloud
2621
2673
  # @type MaxSubscriptionPerClient: Integer
2622
2674
  # @param ClientNumLimit: 客户端连接数上线
2623
2675
  # @type ClientNumLimit: Integer
2624
- # @param RenewFlag: 是否自动续费。仅包年包月就去那生效。
2676
+ # @param RenewFlag: 是否自动续费。仅包年包月集群生效。
2625
2677
  # 1:自动续费
2626
2678
  # 0:非自动续费
2627
2679
  # @type RenewFlag: Integer
@@ -2767,9 +2819,9 @@ module TencentCloud
2767
2819
  # @type Password: String
2768
2820
  # @param Remark: 备注信息
2769
2821
  # @type Remark: String
2770
- # @param CreatedTime: 创建时间，秒为单位
2822
+ # @param CreatedTime: 创建时间，毫秒级时间戳 。
2771
2823
  # @type CreatedTime: Integer
2772
- # @param ModifiedTime: 修改时间，秒为单位
2824
+ # @param ModifiedTime: 修改时间，毫秒级时间戳 。
2773
2825
  # @type ModifiedTime: Integer
2774
2826
 
2775
2827
  attr_accessor :Username, :Password, :Remark, :CreatedTime, :ModifiedTime
@@ -3231,11 +3283,11 @@ module TencentCloud
3231
3283
 
3232
3284
  # ModifyTopic请求参数结构体
3233
3285
  class ModifyTopicRequest < TencentCloud::Common::AbstractModel
3234
- # @param InstanceId: 实例ID
3286
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3235
3287
  # @type InstanceId: String
3236
- # @param Topic: 主题
3288
+ # @param Topic: 主题，不能为空，只能包含字母、数字、“-”及“_”，3-100 字符。
3237
3289
  # @type Topic: String
3238
- # @param Remark: 备注信息
3290
+ # @param Remark: 备注信息，最长 128 字符
3239
3291
  # @type Remark: String
3240
3292
 
3241
3293
  attr_accessor :InstanceId, :Topic, :Remark
@@ -3271,11 +3323,11 @@ module TencentCloud
3271
3323
 
3272
3324
  # ModifyUser请求参数结构体
3273
3325
  class ModifyUserRequest < TencentCloud::Common::AbstractModel
3274
- # @param InstanceId: 实例ID
3326
+ # @param InstanceId: 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3275
3327
  # @type InstanceId: String
3276
3328
  # @param Username: 用户名
3277
3329
  # @type Username: String
3278
- # @param Remark: 备注
3330
+ # @param Remark: 备注，长度不超过128个字符。
3279
3331
  # @type Remark: String
3280
3332
 
3281
3333
  attr_accessor :InstanceId, :Username, :Remark
@@ -3420,9 +3472,9 @@ module TencentCloud
3420
3472
 
3421
3473
  # PublishMessage请求参数结构体
3422
3474
  class PublishMessageRequest < TencentCloud::Common::AbstractModel
3423
- # @param InstanceId: 实例ID
3475
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3424
3476
  # @type InstanceId: String
3425
- # @param Payload: 消息 payload，需要按 encoding 指定的编码方式进行编码
3477
+ # @param Payload: 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码
3426
3478
  # @type Payload: String
3427
3479
  # @param TargetTopic: 消息目的主题，该参数与 TargetClientId 二选一
3428
3480
  # @type TargetTopic: String
@@ -3431,6 +3483,9 @@ module TencentCloud
3431
3483
  # @param Encoding: 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）
3432
3484
  # @type Encoding: String
3433
3485
  # @param Qos: 消息的服务质量等级，默认为 1
3486
+ # QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。
3487
+ # QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。
3488
+ # QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。
3434
3489
  # @type Qos: Integer
3435
3490
  # @param Retain: 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true
3436
3491
  # @type Retain: Boolean
@@ -3476,19 +3531,17 @@ module TencentCloud
3476
3531
 
3477
3532
  # RegisterCaCertificate请求参数结构体
3478
3533
  class RegisterCaCertificateRequest < TencentCloud::Common::AbstractModel
3479
- # @param InstanceId: 集群id
3534
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3480
3535
  # @type InstanceId: String
3481
- # @param CaCertificate: CA证书
3536
+ # @param CaCertificate: CA证书内容，自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
3482
3537
  # @type CaCertificate: String
3483
- # @param VerificationCertificate: 验证证书
3538
+ # @param VerificationCertificate: 验证证书内容，可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
3484
3539
  # @type VerificationCertificate: String
3485
- # @param Format: 证书格式，不传默认PEM格式
3540
+ # @param Format: 证书格式，不传默认PEM格式，当前仅支持PEM格式
3486
3541
  # @type Format: String
3487
3542
  # @param Status: 证书状态，不传默认ACTIVE状态
3488
- # ACTIVE,//激活
3489
- # INACTIVE,//未激活
3490
- # REVOKED,//吊销
3491
- # PENDING_ACTIVATION,//注册待激活
3543
+ # ACTIVE：激活
3544
+ # INACTIVE：未激活
3492
3545
  # @type Status: String
3493
3546
 
3494
3547
  attr_accessor :InstanceId, :CaCertificate, :VerificationCertificate, :Format, :Status
@@ -3528,17 +3581,21 @@ module TencentCloud
3528
3581
 
3529
3582
  # RegisterDeviceCertificate请求参数结构体
3530
3583
  class RegisterDeviceCertificateRequest < TencentCloud::Common::AbstractModel
3531
- # @param InstanceId: 集群id
3584
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3532
3585
  # @type InstanceId: String
3533
- # @param DeviceCertificate: 设备证书
3586
+ # @param DeviceCertificate: 设备证书内容，可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
3534
3587
  # @type DeviceCertificate: String
3535
3588
  # @param CaSn: 关联的CA证书SN
3536
3589
  # @type CaSn: String
3537
- # @param ClientId: 客户端ID
3590
+ # @param ClientId: 客户端ID，需要关联该证书的客户端ID。根据实际业务使用填写
3538
3591
  # @type ClientId: String
3539
- # @param Format: 证书格式
3592
+ # @param Format: 证书格式，默认为PEM，当前仅支持PEM格式
3540
3593
  # @type Format: String
3541
- # @param Status: ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
3594
+ # @param Status: 客户端证书状态，默认激活状态（ACTIVE）
3595
+ # ACTIVE：激活
3596
+ # INACTIVE：未激活
3597
+ # REVOKED：吊销
3598
+ # PENDING_ACTIVATION：注册待激活
3542
3599
  # @type Status: String
3543
3600
 
3544
3601
  attr_accessor :InstanceId, :DeviceCertificate, :CaSn, :ClientId, :Format, :Status
@@ -3656,7 +3713,7 @@ module TencentCloud
3656
3713
 
3657
3714
  # UpdateAuthorizationPolicyPriority请求参数结构体
3658
3715
  class UpdateAuthorizationPolicyPriorityRequest < TencentCloud::Common::AbstractModel
3659
- # @param InstanceId: 实例ID
3716
+ # @param InstanceId: 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3660
3717
  # @type InstanceId: String
3661
3718
  # @param Priorities: 策略ID和优先级
3662
3719
  # @type Priorities: Array
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-mqtt
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1026
4
+ version: 3.0.1028
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-03-24 00:00:00.000000000 Z
11
+ date: 2025-03-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common