tccli-intl-en 3.0.1282.1__py2.py3-none-any.whl → 3.1.33.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/argument.py +1 -1
- tccli/services/__init__.py +15 -0
- tccli/services/advisor/advisor_client.py +2 -2
- tccli/services/ai3d/__init__.py +4 -0
- tccli/services/ai3d/ai3d_client.py +266 -0
- tccli/services/ai3d/v20250513/api.json +264 -0
- tccli/services/ai3d/v20250513/examples.json +20 -0
- tccli/services/aiart/aiart_client.py +1 -1
- tccli/services/ams/ams_client.py +4 -4
- tccli/services/antiddos/antiddos_client.py +70 -70
- tccli/services/apigateway/apigateway_client.py +93 -93
- tccli/services/apm/apm_client.py +783 -55
- tccli/services/apm/v20210622/api.json +3936 -1145
- tccli/services/apm/v20210622/examples.json +133 -23
- tccli/services/asr/asr_client.py +2 -2
- tccli/services/autoscaling/autoscaling_client.py +58 -58
- tccli/services/autoscaling/v20180419/api.json +77 -27
- tccli/services/batch/batch_client.py +28 -28
- tccli/services/bi/bi_client.py +24 -24
- tccli/services/billing/billing_client.py +42 -42
- tccli/services/cam/cam_client.py +81 -81
- tccli/services/captcha/captcha_client.py +1 -1
- tccli/services/car/car_client.py +33 -33
- tccli/services/cbs/cbs_client.py +38 -38
- tccli/services/ccc/ccc_client.py +70 -70
- tccli/services/ccc/v20200210/api.json +71 -26
- tccli/services/cdb/cdb_client.py +1262 -422
- tccli/services/cdb/v20170320/api.json +2166 -335
- tccli/services/cdb/v20170320/examples.json +126 -6
- tccli/services/cdc/cdc_client.py +20 -20
- tccli/services/cdn/cdn_client.py +44 -44
- tccli/services/cdn/v20180606/api.json +22 -22
- tccli/services/cdn/v20180606/examples.json +1 -1
- tccli/services/cdwdoris/cdwdoris_client.py +77 -77
- tccli/services/cdwpg/cdwpg_client.py +24 -24
- tccli/services/cdz/cdz_client.py +1 -1
- tccli/services/cfg/cfg_client.py +16 -16
- tccli/services/cfs/cfs_client.py +39 -39
- tccli/services/cfw/cfw_client.py +66 -66
- tccli/services/chdfs/chdfs_client.py +29 -29
- tccli/services/ciam/ciam_client.py +16 -16
- tccli/services/ckafka/ckafka_client.py +468 -76
- tccli/services/ckafka/v20190819/api.json +1009 -246
- tccli/services/ckafka/v20190819/examples.json +73 -23
- tccli/services/clb/clb_client.py +720 -384
- tccli/services/clb/v20180317/api.json +2255 -1017
- tccli/services/clb/v20180317/examples.json +184 -124
- tccli/services/cloudaudit/cloudaudit_client.py +18 -18
- tccli/services/cls/cls_client.py +86 -86
- tccli/services/cmq/cmq_client.py +2 -2
- tccli/services/config/config_client.py +6 -6
- tccli/services/controlcenter/controlcenter_client.py +225 -1
- tccli/services/controlcenter/v20230110/api.json +528 -5
- tccli/services/controlcenter/v20230110/examples.json +32 -0
- tccli/services/csip/csip_client.py +34 -34
- tccli/services/ctsdb/ctsdb_client.py +2 -2
- tccli/services/cvm/cvm_client.py +84 -84
- tccli/services/cvm/v20170312/api.json +175 -116
- tccli/services/cvm/v20170312/examples.json +93 -93
- tccli/services/cwp/cwp_client.py +465 -465
- tccli/services/cynosdb/cynosdb_client.py +154 -154
- tccli/services/dataintegration/dataintegration_client.py +1 -1
- tccli/services/dayu/dayu_client.py +103 -103
- tccli/services/dbbrain/dbbrain_client.py +42 -42
- tccli/services/dc/dc_client.py +18 -18
- tccli/services/dcdb/dcdb_client.py +62 -62
- tccli/services/dlc/dlc_client.py +109 -109
- tccli/services/dms/dms_client.py +2 -2
- tccli/services/dnspod/dnspod_client.py +40 -40
- tccli/services/domain/domain_client.py +24 -24
- tccli/services/dts/dts_client.py +83 -83
- tccli/services/eb/eb_client.py +26 -26
- tccli/services/ecdn/ecdn_client.py +15 -15
- tccli/services/ecm/ecm_client.py +124 -124
- tccli/services/eiam/eiam_client.py +40 -40
- tccli/services/emr/emr_client.py +77 -77
- tccli/services/emr/v20190103/api.json +6 -6
- tccli/services/es/es_client.py +21 -21
- tccli/services/facefusion/facefusion_client.py +3 -3
- tccli/services/faceid/faceid_client.py +19 -19
- tccli/services/faceid/v20180301/api.json +124 -46
- tccli/services/gaap/gaap_client.py +88 -88
- tccli/services/gme/gme_client.py +10 -10
- tccli/services/gpm/gpm_client.py +18 -18
- tccli/services/gse/gse_client.py +22 -22
- tccli/services/gwlb/gwlb_client.py +18 -18
- tccli/services/hunyuan/__init__.py +4 -0
- tccli/services/hunyuan/hunyuan_client.py +546 -0
- tccli/services/hunyuan/v20230901/api.json +628 -0
- tccli/services/hunyuan/v20230901/examples.json +60 -0
- tccli/services/iai/iai_client.py +29 -29
- tccli/services/iap/iap_client.py +6 -6
- tccli/services/ims/ims_client.py +1 -1
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +42 -42
- tccli/services/iotcloud/iotcloud_client.py +20 -20
- tccli/services/ip/ip_client.py +6 -6
- tccli/services/kms/kms_client.py +68 -68
- tccli/services/kms/v20190118/api.json +80 -3
- tccli/services/kms/v20190118/examples.json +3 -3
- tccli/services/lcic/lcic_client.py +53 -53
- tccli/services/lighthouse/lighthouse_client.py +434 -98
- tccli/services/lighthouse/v20200324/api.json +488 -0
- tccli/services/lighthouse/v20200324/examples.json +54 -0
- tccli/services/live/live_client.py +120 -120
- tccli/services/lke/lke_client.py +90 -90
- tccli/services/lkeap/lkeap_client.py +63 -7
- tccli/services/lkeap/v20240522/api.json +134 -0
- tccli/services/lkeap/v20240522/examples.json +21 -1
- tccli/services/mariadb/mariadb_client.py +50 -50
- tccli/services/mdc/mdc_client.py +18 -18
- tccli/services/mdl/mdl_client.py +225 -57
- tccli/services/mdl/v20200326/api.json +903 -59
- tccli/services/mdl/v20200326/examples.json +24 -0
- tccli/services/mdp/mdp_client.py +62 -62
- tccli/services/mdp/v20200527/api.json +191 -28
- tccli/services/message/message_client.py +1 -1
- tccli/services/mongodb/mongodb_client.py +1081 -129
- tccli/services/mongodb/v20190725/api.json +1798 -141
- tccli/services/mongodb/v20190725/examples.json +136 -0
- tccli/services/monitor/monitor_client.py +149 -149
- tccli/services/monitor/v20180724/api.json +8 -8
- tccli/services/mps/mps_client.py +1118 -278
- tccli/services/mps/v20190612/api.json +2117 -117
- tccli/services/mps/v20190612/examples.json +164 -62
- tccli/services/mqtt/__init__.py +4 -0
- tccli/services/mqtt/mqtt_client.py +1610 -0
- tccli/services/mqtt/v20240516/api.json +3057 -0
- tccli/services/mqtt/v20240516/examples.json +213 -0
- tccli/services/msp/msp_client.py +7 -7
- tccli/services/ocr/ocr_client.py +206 -38
- tccli/services/ocr/v20181119/api.json +726 -83
- tccli/services/ocr/v20181119/examples.json +36 -6
- tccli/services/omics/omics_client.py +20 -20
- tccli/services/organization/organization_client.py +116 -116
- tccli/services/postgres/postgres_client.py +91 -91
- tccli/services/privatedns/privatedns_client.py +31 -31
- tccli/services/pts/pts_client.py +48 -48
- tccli/services/quota/quota_client.py +5 -5
- tccli/services/rce/rce_client.py +1 -1
- tccli/services/redis/redis_client.py +109 -109
- tccli/services/redis/v20180412/api.json +12 -12
- tccli/services/region/region_client.py +3 -3
- tccli/services/rum/rum_client.py +60 -60
- tccli/services/scf/scf_client.py +42 -42
- tccli/services/ses/ses_client.py +29 -29
- tccli/services/smh/__init__.py +4 -0
- tccli/services/smh/smh_client.py +714 -0
- tccli/services/smh/v20210712/api.json +1287 -0
- tccli/services/smh/v20210712/examples.json +85 -0
- tccli/services/sms/sms_client.py +18 -18
- tccli/services/sqlserver/sqlserver_client.py +139 -139
- tccli/services/ssl/ssl_client.py +38 -38
- tccli/services/ssm/ssm_client.py +24 -24
- tccli/services/sts/sts_client.py +5 -5
- tccli/services/tag/tag_client.py +30 -30
- tccli/services/tat/tat_client.py +19 -19
- tccli/services/tbaas/tbaas_client.py +4 -4
- tccli/services/tcaplusdb/tcaplusdb_client.py +52 -52
- tccli/services/tchd/tchd_client.py +1 -1
- tccli/services/tcmpp/tcmpp_client.py +104 -104
- tccli/services/tcr/tcr_client.py +76 -76
- tccli/services/tcsas/tcsas_client.py +2340 -268
- tccli/services/tcsas/v20250106/api.json +8410 -3423
- tccli/services/tcsas/v20250106/examples.json +308 -12
- tccli/services/tcss/tcss_client.py +330 -330
- tccli/services/tdid/tdid_client.py +48 -48
- tccli/services/tdmq/tdmq_client.py +2500 -372
- tccli/services/tdmq/v20200217/api.json +11607 -3958
- tccli/services/tdmq/v20200217/examples.json +562 -264
- tccli/services/tem/tem_client.py +56 -56
- tccli/services/teo/teo_client.py +466 -298
- tccli/services/teo/v20220901/api.json +324 -16
- tccli/services/teo/v20220901/examples.json +64 -22
- tccli/services/tione/tione_client.py +1 -1
- tccli/services/tiw/tiw_client.py +51 -51
- tccli/services/tke/tke_client.py +306 -138
- tccli/services/tke/v20180525/api.json +227 -0
- tccli/services/tke/v20180525/examples.json +24 -0
- tccli/services/tms/tms_client.py +1 -1
- tccli/services/tmt/tmt_client.py +1 -1
- tccli/services/trabbit/trabbit_client.py +29 -29
- tccli/services/trocket/__init__.py +4 -0
- tccli/services/trocket/trocket_client.py +2450 -0
- tccli/services/trocket/v20230308/api.json +6062 -0
- tccli/services/trocket/v20230308/examples.json +339 -0
- tccli/services/trro/trro_client.py +19 -19
- tccli/services/trtc/trtc_client.py +51 -51
- tccli/services/trtc/v20190722/api.json +15 -15
- tccli/services/tts/tts_client.py +1 -1
- tccli/services/vclm/vclm_client.py +2 -2
- tccli/services/vm/vm_client.py +4 -4
- tccli/services/vod/v20180717/api.json +2929 -296
- tccli/services/vod/v20180717/examples.json +40 -6
- tccli/services/vod/vod_client.py +459 -179
- tccli/services/vpc/v20170312/api.json +99 -29
- tccli/services/vpc/v20170312/examples.json +21 -13
- tccli/services/vpc/vpc_client.py +357 -301
- tccli/services/waf/waf_client.py +107 -107
- tccli/services/wedata/wedata_client.py +310 -310
- tccli/services/yunjing/yunjing_client.py +71 -71
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/METADATA +2 -2
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/RECORD +207 -187
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/WHEEL +1 -1
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/entry_points.txt +0 -0
- {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,3057 @@
|
|
|
1
|
+
{
|
|
2
|
+
"actions": {
|
|
3
|
+
"AddClientSubscription": {
|
|
4
|
+
"document": "This API is used to add a subscription for an MQTT client.",
|
|
5
|
+
"input": "AddClientSubscriptionRequest",
|
|
6
|
+
"name": "This API is used to add a subscription for an MQTT client.",
|
|
7
|
+
"output": "AddClientSubscriptionResponse",
|
|
8
|
+
"status": "online"
|
|
9
|
+
},
|
|
10
|
+
"CreateAuthorizationPolicy": {
|
|
11
|
+
"document": "This API is used to create a performance test task for an MQTT instance.",
|
|
12
|
+
"input": "CreateAuthorizationPolicyRequest",
|
|
13
|
+
"name": "Creates an authorization policy",
|
|
14
|
+
"output": "CreateAuthorizationPolicyResponse",
|
|
15
|
+
"status": "online"
|
|
16
|
+
},
|
|
17
|
+
"CreateInstance": {
|
|
18
|
+
"document": "This API is used to purchase a new MQTT instance.",
|
|
19
|
+
"input": "CreateInstanceRequest",
|
|
20
|
+
"name": "Purchase an MQTT instance",
|
|
21
|
+
"output": "CreateInstanceResponse",
|
|
22
|
+
"status": "online"
|
|
23
|
+
},
|
|
24
|
+
"CreateMessageEnrichmentRule": {
|
|
25
|
+
"document": "This API is used to create a message enrichment rule.",
|
|
26
|
+
"input": "CreateMessageEnrichmentRuleRequest",
|
|
27
|
+
"name": "Create message enrichment rule",
|
|
28
|
+
"output": "CreateMessageEnrichmentRuleResponse",
|
|
29
|
+
"status": "online"
|
|
30
|
+
},
|
|
31
|
+
"CreateUser": {
|
|
32
|
+
"document": "This API is used to add an MQTT role.",
|
|
33
|
+
"input": "CreateUserRequest",
|
|
34
|
+
"name": "Adds an MQTT role",
|
|
35
|
+
"output": "CreateUserResponse",
|
|
36
|
+
"status": "online"
|
|
37
|
+
},
|
|
38
|
+
"DeleteAuthorizationPolicy": {
|
|
39
|
+
"document": "This API is used to delete policy rules.",
|
|
40
|
+
"input": "DeleteAuthorizationPolicyRequest",
|
|
41
|
+
"name": "Delete an authorization policy",
|
|
42
|
+
"output": "DeleteAuthorizationPolicyResponse",
|
|
43
|
+
"status": "online"
|
|
44
|
+
},
|
|
45
|
+
"DeleteClientSubscription": {
|
|
46
|
+
"document": "This API is used to delete a subscription of an MQTT client.",
|
|
47
|
+
"input": "DeleteClientSubscriptionRequest",
|
|
48
|
+
"name": "Delete a subscription for an MQTT client",
|
|
49
|
+
"output": "DeleteClientSubscriptionResponse",
|
|
50
|
+
"status": "online"
|
|
51
|
+
},
|
|
52
|
+
"DeleteInstance": {
|
|
53
|
+
"document": "This API is used to delete an MQTT instance.",
|
|
54
|
+
"input": "DeleteInstanceRequest",
|
|
55
|
+
"name": "This API is used to delete an MQTT instance.",
|
|
56
|
+
"output": "DeleteInstanceResponse",
|
|
57
|
+
"status": "online"
|
|
58
|
+
},
|
|
59
|
+
"DeleteMessageEnrichmentRule": {
|
|
60
|
+
"document": "This API is used to delete the message enrichment rule.",
|
|
61
|
+
"input": "DeleteMessageEnrichmentRuleRequest",
|
|
62
|
+
"name": "Delete message enrichment rule",
|
|
63
|
+
"output": "DeleteMessageEnrichmentRuleResponse",
|
|
64
|
+
"status": "online"
|
|
65
|
+
},
|
|
66
|
+
"DeleteTopic": {
|
|
67
|
+
"document": "This API is used to delete an MQTT topic.",
|
|
68
|
+
"input": "DeleteTopicRequest",
|
|
69
|
+
"name": "This API is used to delete an MQTT topic.",
|
|
70
|
+
"output": "DeleteTopicResponse",
|
|
71
|
+
"status": "online"
|
|
72
|
+
},
|
|
73
|
+
"DeleteUser": {
|
|
74
|
+
"document": "This API is used to delete an MQTT user.",
|
|
75
|
+
"input": "DeleteUserRequest",
|
|
76
|
+
"name": "Delete an MQTT role",
|
|
77
|
+
"output": "DeleteUserResponse",
|
|
78
|
+
"status": "online"
|
|
79
|
+
},
|
|
80
|
+
"DescribeAuthorizationPolicies": {
|
|
81
|
+
"document": "This API is used to query authorization rules.",
|
|
82
|
+
"input": "DescribeAuthorizationPoliciesRequest",
|
|
83
|
+
"name": "Query an authorization policy",
|
|
84
|
+
"output": "DescribeAuthorizationPoliciesResponse",
|
|
85
|
+
"status": "online"
|
|
86
|
+
},
|
|
87
|
+
"DescribeClientList": {
|
|
88
|
+
"document": "This API is used to query the MQTT client details.",
|
|
89
|
+
"input": "DescribeClientListRequest",
|
|
90
|
+
"name": "Query the MQTT client list",
|
|
91
|
+
"output": "DescribeClientListResponse",
|
|
92
|
+
"status": "online"
|
|
93
|
+
},
|
|
94
|
+
"DescribeInstance": {
|
|
95
|
+
"document": "This API is used to query instance information.",
|
|
96
|
+
"input": "DescribeInstanceRequest",
|
|
97
|
+
"name": "Query MQTT instance details",
|
|
98
|
+
"output": "DescribeInstanceResponse",
|
|
99
|
+
"status": "online"
|
|
100
|
+
},
|
|
101
|
+
"DescribeMessageByTopic": {
|
|
102
|
+
"document": "This API is used to query messages based on subscription.",
|
|
103
|
+
"input": "DescribeMessageByTopicRequest",
|
|
104
|
+
"name": "Query messages based on subscription",
|
|
105
|
+
"output": "DescribeMessageByTopicResponse",
|
|
106
|
+
"status": "online"
|
|
107
|
+
},
|
|
108
|
+
"DescribeMessageDetails": {
|
|
109
|
+
"document": "This API is used to query the MQTT message details.",
|
|
110
|
+
"input": "DescribeMessageDetailsRequest",
|
|
111
|
+
"name": "Query MQTT detailed information",
|
|
112
|
+
"output": "DescribeMessageDetailsResponse",
|
|
113
|
+
"status": "online"
|
|
114
|
+
},
|
|
115
|
+
"DescribeMessageEnrichmentRules": {
|
|
116
|
+
"document": "This API is used to query message enrichment rules.",
|
|
117
|
+
"input": "DescribeMessageEnrichmentRulesRequest",
|
|
118
|
+
"name": "Query message enrichment rules",
|
|
119
|
+
"output": "DescribeMessageEnrichmentRulesResponse",
|
|
120
|
+
"status": "online"
|
|
121
|
+
},
|
|
122
|
+
"DescribeTopic": {
|
|
123
|
+
"document": "This API is used to query the MQTT topic details.",
|
|
124
|
+
"input": "DescribeTopicRequest",
|
|
125
|
+
"name": "Query MQTT topic details",
|
|
126
|
+
"output": "DescribeTopicResponse",
|
|
127
|
+
"status": "online"
|
|
128
|
+
},
|
|
129
|
+
"DescribeUserList": {
|
|
130
|
+
"document": "This API is used to query the user list. Filter parameter usage instructions are as follows:.\n\nThis API is used to perform Username fuzzy search.",
|
|
131
|
+
"input": "DescribeUserListRequest",
|
|
132
|
+
"name": "Query the MQTT user list",
|
|
133
|
+
"output": "DescribeUserListResponse",
|
|
134
|
+
"status": "online"
|
|
135
|
+
},
|
|
136
|
+
"KickOutClient": {
|
|
137
|
+
"document": "This API is used to kick out a client.",
|
|
138
|
+
"input": "KickOutClientRequest",
|
|
139
|
+
"name": "Kick out a client",
|
|
140
|
+
"output": "KickOutClientResponse",
|
|
141
|
+
"status": "online"
|
|
142
|
+
},
|
|
143
|
+
"ModifyAuthorizationPolicy": {
|
|
144
|
+
"document": "This API is used to modify policy rules. See the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
145
|
+
"input": "ModifyAuthorizationPolicyRequest",
|
|
146
|
+
"name": "Modify an authorization policy",
|
|
147
|
+
"output": "ModifyAuthorizationPolicyResponse",
|
|
148
|
+
"status": "online"
|
|
149
|
+
},
|
|
150
|
+
"ModifyInstance": {
|
|
151
|
+
"document": "This API is used to modify instance attributes. Only running clusters can call this API to perform configuration change.",
|
|
152
|
+
"input": "ModifyInstanceRequest",
|
|
153
|
+
"name": "Modify MQTT instance attributes",
|
|
154
|
+
"output": "ModifyInstanceResponse",
|
|
155
|
+
"status": "online"
|
|
156
|
+
},
|
|
157
|
+
"ModifyMessageEnrichmentRule": {
|
|
158
|
+
"document": "This API is used to modify message enrichment rules.\nNote: All attributes of the current rule must be submitted, even if specific fields are not modified.",
|
|
159
|
+
"input": "ModifyMessageEnrichmentRuleRequest",
|
|
160
|
+
"name": "Modify message enrichment rule",
|
|
161
|
+
"output": "ModifyMessageEnrichmentRuleResponse",
|
|
162
|
+
"status": "online"
|
|
163
|
+
},
|
|
164
|
+
"ModifyUser": {
|
|
165
|
+
"document": "This API is used to modify an MQTT role.",
|
|
166
|
+
"input": "ModifyUserRequest",
|
|
167
|
+
"name": "This API is used to modify an MQTT role.",
|
|
168
|
+
"output": "ModifyUserResponse",
|
|
169
|
+
"status": "online"
|
|
170
|
+
},
|
|
171
|
+
"UpdateAuthorizationPolicyPriority": {
|
|
172
|
+
"document": "This API is used to modify policy rule priority.",
|
|
173
|
+
"input": "UpdateAuthorizationPolicyPriorityRequest",
|
|
174
|
+
"name": "Update authorization policy priority",
|
|
175
|
+
"output": "UpdateAuthorizationPolicyPriorityResponse",
|
|
176
|
+
"status": "online"
|
|
177
|
+
},
|
|
178
|
+
"UpdateMessageEnrichmentRulePriority": {
|
|
179
|
+
"document": "This API is used to modify the priority for message enrichment rule.",
|
|
180
|
+
"input": "UpdateMessageEnrichmentRulePriorityRequest",
|
|
181
|
+
"name": "Update message enhancement rule priority",
|
|
182
|
+
"output": "UpdateMessageEnrichmentRulePriorityResponse",
|
|
183
|
+
"status": "online"
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"metadata": {
|
|
187
|
+
"apiVersion": "2024-05-16",
|
|
188
|
+
"serviceNameCN": "消息队列 MQTT 版",
|
|
189
|
+
"serviceShortName": "mqtt"
|
|
190
|
+
},
|
|
191
|
+
"objects": {
|
|
192
|
+
"AddClientSubscriptionRequest": {
|
|
193
|
+
"document": "AddClientSubscription request structure.",
|
|
194
|
+
"members": [
|
|
195
|
+
{
|
|
196
|
+
"disabled": false,
|
|
197
|
+
"document": "Instance ID.",
|
|
198
|
+
"example": "mqtt-xxxx",
|
|
199
|
+
"member": "string",
|
|
200
|
+
"name": "InstanceId",
|
|
201
|
+
"required": true,
|
|
202
|
+
"type": "string"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"disabled": false,
|
|
206
|
+
"document": "Client ID.",
|
|
207
|
+
"example": "client1",
|
|
208
|
+
"member": "string",
|
|
209
|
+
"name": "ClientId",
|
|
210
|
+
"required": true,
|
|
211
|
+
"type": "string"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"disabled": false,
|
|
215
|
+
"document": "Specifies the subscription.",
|
|
216
|
+
"example": "humidity/+/",
|
|
217
|
+
"member": "string",
|
|
218
|
+
"name": "TopicFilter",
|
|
219
|
+
"required": true,
|
|
220
|
+
"type": "string"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"disabled": false,
|
|
224
|
+
"document": "Service quality. valid values: 0, 1, 2.",
|
|
225
|
+
"example": "1",
|
|
226
|
+
"member": "string",
|
|
227
|
+
"name": "Qos",
|
|
228
|
+
"required": false,
|
|
229
|
+
"type": "string"
|
|
230
|
+
}
|
|
231
|
+
],
|
|
232
|
+
"type": "object"
|
|
233
|
+
},
|
|
234
|
+
"AddClientSubscriptionResponse": {
|
|
235
|
+
"document": "AddClientSubscription response structure.",
|
|
236
|
+
"members": [
|
|
237
|
+
{
|
|
238
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
239
|
+
"member": "string",
|
|
240
|
+
"name": "RequestId",
|
|
241
|
+
"type": "string"
|
|
242
|
+
}
|
|
243
|
+
],
|
|
244
|
+
"type": "object"
|
|
245
|
+
},
|
|
246
|
+
"AuthorizationPolicyItem": {
|
|
247
|
+
"document": "AuthorizationPolicyItem",
|
|
248
|
+
"members": [
|
|
249
|
+
{
|
|
250
|
+
"disabled": false,
|
|
251
|
+
"document": "Policy rule ID.",
|
|
252
|
+
"example": "1",
|
|
253
|
+
"member": "int64",
|
|
254
|
+
"name": "Id",
|
|
255
|
+
"output_required": false,
|
|
256
|
+
"type": "int",
|
|
257
|
+
"value_allowed_null": false
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"disabled": false,
|
|
261
|
+
"document": "MQTT cluster ID.",
|
|
262
|
+
"example": "mqtt-xxxx",
|
|
263
|
+
"member": "string",
|
|
264
|
+
"name": "InstanceId",
|
|
265
|
+
"output_required": false,
|
|
266
|
+
"type": "string",
|
|
267
|
+
"value_allowed_null": false
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"disabled": false,
|
|
271
|
+
"document": "Specifies the policy rule name.",
|
|
272
|
+
"example": "allow-connect",
|
|
273
|
+
"member": "string",
|
|
274
|
+
"name": "PolicyName",
|
|
275
|
+
"output_required": false,
|
|
276
|
+
"type": "string",
|
|
277
|
+
"value_allowed_null": false
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"disabled": false,
|
|
281
|
+
"document": "Rule syntax version. currently only support 1. defaults to 1.",
|
|
282
|
+
"example": "1",
|
|
283
|
+
"member": "int64",
|
|
284
|
+
"name": "Version",
|
|
285
|
+
"output_required": false,
|
|
286
|
+
"type": "int",
|
|
287
|
+
"value_allowed_null": false
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"disabled": false,
|
|
291
|
+
"document": "Policy priority. a smaller priority ID indicates the policy takes effect with higher priority. see [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
292
|
+
"example": "1",
|
|
293
|
+
"member": "int64",
|
|
294
|
+
"name": "Priority",
|
|
295
|
+
"output_required": false,
|
|
296
|
+
"type": "int",
|
|
297
|
+
"value_allowed_null": false
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"disabled": false,
|
|
301
|
+
"document": "Specifies the decision.\nallow specifies permission for access requests from devices that match this policy.\ndeny: denies access requests to the device that override the policy.\nRefer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
302
|
+
"example": "allow",
|
|
303
|
+
"member": "string",
|
|
304
|
+
"name": "Effect",
|
|
305
|
+
"output_required": false,
|
|
306
|
+
"type": "string",
|
|
307
|
+
"value_allowed_null": false
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"disabled": false,
|
|
311
|
+
"document": "Operation.\nSpecifies the connection.\nPublishes an mqtt message.\nSub. specifies the subscription to mqtt messages.\nRefer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
312
|
+
"example": "connect",
|
|
313
|
+
"member": "string",
|
|
314
|
+
"name": "Actions",
|
|
315
|
+
"output_required": false,
|
|
316
|
+
"type": "string",
|
|
317
|
+
"value_allowed_null": false
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"disabled": false,
|
|
321
|
+
"document": "Resource. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
322
|
+
"example": "topic1",
|
|
323
|
+
"member": "string",
|
|
324
|
+
"name": "Resources",
|
|
325
|
+
"output_required": false,
|
|
326
|
+
"type": "string",
|
|
327
|
+
"value_allowed_null": false
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"disabled": false,
|
|
331
|
+
"document": "Specifies the device ID for connection. refer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
332
|
+
"example": "client1",
|
|
333
|
+
"member": "string",
|
|
334
|
+
"name": "ClientId",
|
|
335
|
+
"output_required": false,
|
|
336
|
+
"type": "string",
|
|
337
|
+
"value_allowed_null": false
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"disabled": false,
|
|
341
|
+
"document": "Condition - username. refer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
342
|
+
"example": "user1",
|
|
343
|
+
"member": "string",
|
|
344
|
+
"name": "Username",
|
|
345
|
+
"output_required": false,
|
|
346
|
+
"type": "string",
|
|
347
|
+
"value_allowed_null": false
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"disabled": false,
|
|
351
|
+
"document": "Specifies the client IP address. see the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
352
|
+
"example": "127.0.0.1",
|
|
353
|
+
"member": "string",
|
|
354
|
+
"name": "Ip",
|
|
355
|
+
"output_required": false,
|
|
356
|
+
"type": "string",
|
|
357
|
+
"value_allowed_null": false
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"disabled": false,
|
|
361
|
+
"document": "Condition - service quality. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
362
|
+
"example": "0",
|
|
363
|
+
"member": "string",
|
|
364
|
+
"name": "Qos",
|
|
365
|
+
"output_required": false,
|
|
366
|
+
"type": "string",
|
|
367
|
+
"value_allowed_null": false
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"disabled": false,
|
|
371
|
+
"document": "Condition - message retention. refer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\nIndicates the match of retain messages.\n2: indicates non-retain messages.\n3: indicates matching retain and non-retain messages.",
|
|
372
|
+
"example": "1",
|
|
373
|
+
"member": "int64",
|
|
374
|
+
"name": "Retain",
|
|
375
|
+
"output_required": false,
|
|
376
|
+
"type": "int",
|
|
377
|
+
"value_allowed_null": false
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"disabled": false,
|
|
381
|
+
"document": "Specifies the remark with length not exceeding 128 characters.",
|
|
382
|
+
"example": "remark",
|
|
383
|
+
"member": "string",
|
|
384
|
+
"name": "Remark",
|
|
385
|
+
"output_required": false,
|
|
386
|
+
"type": "string",
|
|
387
|
+
"value_allowed_null": false
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"disabled": false,
|
|
391
|
+
"document": "Creation time. millisecond-level timestamp.",
|
|
392
|
+
"example": "1713164969433",
|
|
393
|
+
"member": "int64",
|
|
394
|
+
"name": "CreatedTime",
|
|
395
|
+
"output_required": false,
|
|
396
|
+
"type": "int",
|
|
397
|
+
"value_allowed_null": false
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
"disabled": false,
|
|
401
|
+
"document": "Update time. millisecond-level timestamp.",
|
|
402
|
+
"example": "1713164969433",
|
|
403
|
+
"member": "int64",
|
|
404
|
+
"name": "UpdateTime",
|
|
405
|
+
"output_required": false,
|
|
406
|
+
"type": "int",
|
|
407
|
+
"value_allowed_null": false
|
|
408
|
+
}
|
|
409
|
+
],
|
|
410
|
+
"usage": "out"
|
|
411
|
+
},
|
|
412
|
+
"AuthorizationPolicyPriority": {
|
|
413
|
+
"document": "Rule priority.",
|
|
414
|
+
"members": [
|
|
415
|
+
{
|
|
416
|
+
"disabled": false,
|
|
417
|
+
"document": "Specifies the authorization policy rule id, which can be obtained from the DescribeAuthorizationPolicies api (https://www.tencentcloud.com/document/api/1778/111074?from_cn_redirect=1).",
|
|
418
|
+
"example": "1",
|
|
419
|
+
"member": "int64",
|
|
420
|
+
"name": "Id",
|
|
421
|
+
"output_required": false,
|
|
422
|
+
"required": true,
|
|
423
|
+
"type": "int",
|
|
424
|
+
"value_allowed_null": false
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"disabled": false,
|
|
428
|
+
"document": "Priority",
|
|
429
|
+
"example": "1",
|
|
430
|
+
"member": "int64",
|
|
431
|
+
"name": "Priority",
|
|
432
|
+
"output_required": false,
|
|
433
|
+
"required": true,
|
|
434
|
+
"type": "int",
|
|
435
|
+
"value_allowed_null": false
|
|
436
|
+
}
|
|
437
|
+
],
|
|
438
|
+
"usage": "both"
|
|
439
|
+
},
|
|
440
|
+
"CreateAuthorizationPolicyRequest": {
|
|
441
|
+
"document": "CreateAuthorizationPolicy request structure.",
|
|
442
|
+
"members": [
|
|
443
|
+
{
|
|
444
|
+
"disabled": false,
|
|
445
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
446
|
+
"example": "mqtt-xxxx",
|
|
447
|
+
"member": "string",
|
|
448
|
+
"name": "InstanceId",
|
|
449
|
+
"required": true,
|
|
450
|
+
"type": "string"
|
|
451
|
+
},
|
|
452
|
+
{
|
|
453
|
+
"disabled": false,
|
|
454
|
+
"document": "Policy name, which cannot be empty, contains 3 to 64 characters, and supports chinese, letters, digits, \"-\", and \"_\".",
|
|
455
|
+
"example": "name",
|
|
456
|
+
"member": "string",
|
|
457
|
+
"name": "PolicyName",
|
|
458
|
+
"required": true,
|
|
459
|
+
"type": "string"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"disabled": false,
|
|
463
|
+
"document": "Policy version, defaults to 1. currently only support 1.",
|
|
464
|
+
"example": "1",
|
|
465
|
+
"member": "int64",
|
|
466
|
+
"name": "PolicyVersion",
|
|
467
|
+
"required": true,
|
|
468
|
+
"type": "int"
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"disabled": false,
|
|
472
|
+
"document": "Policy priority. a smaller value indicates higher priority and must be unique. a smaller priority ID means the policy takes effect with higher priority. see [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
473
|
+
"example": "1",
|
|
474
|
+
"member": "int64",
|
|
475
|
+
"name": "Priority",
|
|
476
|
+
"required": true,
|
|
477
|
+
"type": "int"
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"disabled": false,
|
|
481
|
+
"document": "Specifies the decision.\nallow specifies permission for access requests from devices that match this policy.\ndeny: denies access requests to the device that override the policy.\nRefer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
482
|
+
"example": "allow",
|
|
483
|
+
"member": "string",
|
|
484
|
+
"name": "Effect",
|
|
485
|
+
"required": true,
|
|
486
|
+
"type": "string"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"disabled": false,
|
|
490
|
+
"document": "Operation, supports multiple selections separated by commas. see the data plane policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\nSpecifies the connection.\nSpecifies the publish action.\nSub. specifies the subscription.",
|
|
491
|
+
"example": "connect",
|
|
492
|
+
"member": "string",
|
|
493
|
+
"name": "Actions",
|
|
494
|
+
"required": true,
|
|
495
|
+
"type": "string"
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"disabled": false,
|
|
499
|
+
"document": "Condition - message retention. refer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\nMatches message retention.\nMatches non-retention messages.\n3. match retained and non-retained messages.",
|
|
500
|
+
"example": "1",
|
|
501
|
+
"member": "int64",
|
|
502
|
+
"name": "Retain",
|
|
503
|
+
"required": true,
|
|
504
|
+
"type": "int"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"disabled": false,
|
|
508
|
+
"document": "Condition: specifies the service quality.\n0: at most once.\nMinimum once.\n2: exactly once.\nRefer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
509
|
+
"example": "1",
|
|
510
|
+
"member": "string",
|
|
511
|
+
"name": "Qos",
|
|
512
|
+
"required": true,
|
|
513
|
+
"type": "string"
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
"disabled": false,
|
|
517
|
+
"document": "Specifies the resource and subscription to match. supports configuration of multiple match rules, separated by commas. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\n",
|
|
518
|
+
"example": "topic1",
|
|
519
|
+
"member": "string",
|
|
520
|
+
"name": "Resources",
|
|
521
|
+
"required": false,
|
|
522
|
+
"type": "string"
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"disabled": false,
|
|
526
|
+
"document": "Specifies the condition-username.",
|
|
527
|
+
"example": "user1",
|
|
528
|
+
"member": "string",
|
|
529
|
+
"name": "Username",
|
|
530
|
+
"required": false,
|
|
531
|
+
"type": "string"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"disabled": false,
|
|
535
|
+
"document": "Client ID. supports regular expressions.",
|
|
536
|
+
"example": "client1",
|
|
537
|
+
"member": "string",
|
|
538
|
+
"name": "ClientId",
|
|
539
|
+
"required": false,
|
|
540
|
+
"type": "string"
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"disabled": false,
|
|
544
|
+
"document": "Specifies the client IP address, supporting IP or CIDR. refer to the [data plane authorization policy description](https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).",
|
|
545
|
+
"example": "127.0.0.1",
|
|
546
|
+
"member": "string",
|
|
547
|
+
"name": "Ip",
|
|
548
|
+
"required": false,
|
|
549
|
+
"type": "string"
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"disabled": false,
|
|
553
|
+
"document": "Specifies the remark information with a maximum length of 128 characters.",
|
|
554
|
+
"example": "remark",
|
|
555
|
+
"member": "string",
|
|
556
|
+
"name": "Remark",
|
|
557
|
+
"required": false,
|
|
558
|
+
"type": "string"
|
|
559
|
+
}
|
|
560
|
+
],
|
|
561
|
+
"type": "object"
|
|
562
|
+
},
|
|
563
|
+
"CreateAuthorizationPolicyResponse": {
|
|
564
|
+
"document": "CreateAuthorizationPolicy response structure.",
|
|
565
|
+
"members": [
|
|
566
|
+
{
|
|
567
|
+
"disabled": false,
|
|
568
|
+
"document": "Cluster ID",
|
|
569
|
+
"example": "mqtt-xxxx",
|
|
570
|
+
"member": "string",
|
|
571
|
+
"name": "InstanceId",
|
|
572
|
+
"output_required": true,
|
|
573
|
+
"type": "string",
|
|
574
|
+
"value_allowed_null": false
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"disabled": false,
|
|
578
|
+
"document": "Policy ID",
|
|
579
|
+
"example": "1",
|
|
580
|
+
"member": "int64",
|
|
581
|
+
"name": "Id",
|
|
582
|
+
"output_required": true,
|
|
583
|
+
"type": "int",
|
|
584
|
+
"value_allowed_null": false
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
588
|
+
"member": "string",
|
|
589
|
+
"name": "RequestId",
|
|
590
|
+
"type": "string"
|
|
591
|
+
}
|
|
592
|
+
],
|
|
593
|
+
"type": "object"
|
|
594
|
+
},
|
|
595
|
+
"CreateInstanceRequest": {
|
|
596
|
+
"document": "CreateInstance request structure.",
|
|
597
|
+
"members": [
|
|
598
|
+
{
|
|
599
|
+
"disabled": false,
|
|
600
|
+
"document": "Instance type, which needs to correspond to SkuCode. for details, see the [get MQTT product sales spec](https://www.tencentcloud.com/document/api/1778/116232?from_cn_redirect=1) api.\nBASIC: basic edition.\nPRO edition.\nPLATINUM version.\n",
|
|
601
|
+
"example": "BASIC",
|
|
602
|
+
"member": "string",
|
|
603
|
+
"name": "InstanceType",
|
|
604
|
+
"required": true,
|
|
605
|
+
"type": "string"
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"disabled": false,
|
|
609
|
+
"document": "Specifies the cluster name, cannot be empty, 3-64 characters, only comprised of digits, letters, \"-\", and \"_\".",
|
|
610
|
+
"example": "instance-1",
|
|
611
|
+
"member": "string",
|
|
612
|
+
"name": "Name",
|
|
613
|
+
"required": true,
|
|
614
|
+
"type": "string"
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"disabled": false,
|
|
618
|
+
"document": "Product specification, which must correspond to InstanceType. see the [get MQTT product sales spec](https://www.tencentcloud.com/document/api/1778/116232?from_cn_redirect=1) api to obtain details.",
|
|
619
|
+
"example": "pro_10k_1",
|
|
620
|
+
"member": "string",
|
|
621
|
+
"name": "SkuCode",
|
|
622
|
+
"required": true,
|
|
623
|
+
"type": "string"
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"disabled": false,
|
|
627
|
+
"document": "Specifies the remark information with a maximum length of 128 characters.",
|
|
628
|
+
"example": "remark",
|
|
629
|
+
"member": "string",
|
|
630
|
+
"name": "Remark",
|
|
631
|
+
"required": false,
|
|
632
|
+
"type": "string"
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"disabled": false,
|
|
636
|
+
"document": "Tag list",
|
|
637
|
+
"example": "[{\"tag1-key\":\"tag1-value\",\"tag2-key\":\"tag2-value\"}]",
|
|
638
|
+
"member": "Tag",
|
|
639
|
+
"name": "TagList",
|
|
640
|
+
"required": false,
|
|
641
|
+
"type": "list"
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"disabled": false,
|
|
645
|
+
"document": "Specifies the VPC information associated with the instance. the available VPC and SUBNET under the current user must be provided.",
|
|
646
|
+
"example": "无",
|
|
647
|
+
"member": "VpcInfo",
|
|
648
|
+
"name": "VpcList",
|
|
649
|
+
"required": false,
|
|
650
|
+
"type": "list"
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"disabled": false,
|
|
654
|
+
"document": "Whether public network access is enabled. default false (disabled).",
|
|
655
|
+
"example": "true",
|
|
656
|
+
"member": "bool",
|
|
657
|
+
"name": "EnablePublic",
|
|
658
|
+
"required": false,
|
|
659
|
+
"type": "bool"
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"disabled": false,
|
|
663
|
+
"document": "Public network bandwidth (unit: Mbps). this field is mandatory and must be more than 0 when EnablePublic is True.",
|
|
664
|
+
"example": "1",
|
|
665
|
+
"member": "int64",
|
|
666
|
+
"name": "Bandwidth",
|
|
667
|
+
"required": false,
|
|
668
|
+
"type": "int"
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"disabled": false,
|
|
672
|
+
"document": "Public network access allowlist. if not passed, it means deny all IP network access.",
|
|
673
|
+
"example": "无",
|
|
674
|
+
"member": "IpRule",
|
|
675
|
+
"name": "IpRules",
|
|
676
|
+
"required": false,
|
|
677
|
+
"type": "list"
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"disabled": false,
|
|
681
|
+
"document": "Whether the instance is automatically renewed (0: no auto-renewal; 1: auto-renewal). this parameter is valid only when you purchase a prepaid cluster. default value: 1 (auto-renewal).",
|
|
682
|
+
"example": "1",
|
|
683
|
+
"member": "int64",
|
|
684
|
+
"name": "RenewFlag",
|
|
685
|
+
"required": false,
|
|
686
|
+
"type": "int"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"disabled": false,
|
|
690
|
+
"document": "Specifies the purchase duration (measurement unit: month). this parameter is valid only when you purchase a prepaid cluster. default: 1m (month). valid values: 1-12, 24, 36, 48, 60.",
|
|
691
|
+
"example": "1",
|
|
692
|
+
"member": "int64",
|
|
693
|
+
"name": "TimeSpan",
|
|
694
|
+
"required": false,
|
|
695
|
+
"type": "int"
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"disabled": false,
|
|
699
|
+
"document": "Payment mode (0: postpaid; 1: prepaid). default: 0 (postpaid).",
|
|
700
|
+
"example": "1",
|
|
701
|
+
"member": "int64",
|
|
702
|
+
"name": "PayMode",
|
|
703
|
+
"required": false,
|
|
704
|
+
"type": "int"
|
|
705
|
+
}
|
|
706
|
+
],
|
|
707
|
+
"type": "object"
|
|
708
|
+
},
|
|
709
|
+
"CreateInstanceResponse": {
|
|
710
|
+
"document": "CreateInstance response structure.",
|
|
711
|
+
"members": [
|
|
712
|
+
{
|
|
713
|
+
"disabled": false,
|
|
714
|
+
"document": "Instance ID.",
|
|
715
|
+
"example": "rmq-xxxx",
|
|
716
|
+
"member": "string",
|
|
717
|
+
"name": "InstanceId",
|
|
718
|
+
"output_required": true,
|
|
719
|
+
"type": "string",
|
|
720
|
+
"value_allowed_null": false
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
724
|
+
"member": "string",
|
|
725
|
+
"name": "RequestId",
|
|
726
|
+
"type": "string"
|
|
727
|
+
}
|
|
728
|
+
],
|
|
729
|
+
"type": "object"
|
|
730
|
+
},
|
|
731
|
+
"CreateMessageEnrichmentRuleRequest": {
|
|
732
|
+
"document": "CreateMessageEnrichmentRule request structure.",
|
|
733
|
+
"members": [
|
|
734
|
+
{
|
|
735
|
+
"disabled": false,
|
|
736
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
737
|
+
"example": "mqtt-xxxx",
|
|
738
|
+
"member": "string",
|
|
739
|
+
"name": "InstanceId",
|
|
740
|
+
"required": true,
|
|
741
|
+
"type": "string"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"disabled": false,
|
|
745
|
+
"document": "Rule name",
|
|
746
|
+
"example": "rule1",
|
|
747
|
+
"member": "string",
|
|
748
|
+
"name": "RuleName",
|
|
749
|
+
"required": true,
|
|
750
|
+
"type": "string"
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"disabled": false,
|
|
754
|
+
"document": "Rule matching conditions in JSON format, Base64 encoding is required.\nCreating a Billing Resource Order\n{\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"}\nSpecifies the Base64-encoded content.\neyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
|
|
755
|
+
"example": "eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
|
|
756
|
+
"member": "string",
|
|
757
|
+
"name": "Condition",
|
|
758
|
+
"required": true,
|
|
759
|
+
"type": "string"
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"disabled": false,
|
|
763
|
+
"document": "Specifies the action of rule execution in JSON format, which must be Base64 encoded.\nCreating a Billing Resource Order\n{\"messageExpiryInterval\":360,\"responseTopic\":\"replies/devices/${clientid}\",\"correlationData\":\"${traceid}\",\"userProperty\":[{\"key\":\"trace-id\",\"value\":\"${traceid}\"}]}\nSpecifies the BASE64-encoded value.\neyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvZGV2aWNlcy8ke2NsaWVudGlkfSIsImNvcnJlbGF0aW9uRGF0YSI6IiR7dHJhY2VpZH0iLCJ1c2VyUHJvcGVydHkiOlt7ImtleSI6InRyYWNlLWlkIiwidmFsdWUiOiIke3RyYWNlaWR9In1dfQ==",
|
|
764
|
+
"example": "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvZGV2aWNlcy8ke2NsaWVudGlkfSIsImNvcnJlbGF0aW9uRGF0YSI6IiR7dHJhY2VpZH0iLCJ1c2VyUHJvcGVydHkiOlt7ImtleSI6InRyYWNlLWlkIiwidmFsdWUiOiIke3RyYWNlaWR9In1dfQ==",
|
|
765
|
+
"member": "string",
|
|
766
|
+
"name": "Actions",
|
|
767
|
+
"required": true,
|
|
768
|
+
"type": "string"
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
"disabled": false,
|
|
772
|
+
"document": "Rule priority. a smaller number indicates a higher priority. high priority overwrites low-priority. the userproperty field will be merged.",
|
|
773
|
+
"example": "1",
|
|
774
|
+
"member": "int64",
|
|
775
|
+
"name": "Priority",
|
|
776
|
+
"required": true,
|
|
777
|
+
"type": "int"
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"disabled": false,
|
|
781
|
+
"document": "Rule status. valid values: 0 (undefined), 1 (activate), 2 (deactivate). default: deactivate.",
|
|
782
|
+
"example": "1",
|
|
783
|
+
"member": "int64",
|
|
784
|
+
"name": "Status",
|
|
785
|
+
"required": false,
|
|
786
|
+
"type": "int"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"disabled": false,
|
|
790
|
+
"document": "Specifies the remark with length not exceeding 128 characters.",
|
|
791
|
+
"example": "remark",
|
|
792
|
+
"member": "string",
|
|
793
|
+
"name": "Remark",
|
|
794
|
+
"required": false,
|
|
795
|
+
"type": "string"
|
|
796
|
+
}
|
|
797
|
+
],
|
|
798
|
+
"type": "object"
|
|
799
|
+
},
|
|
800
|
+
"CreateMessageEnrichmentRuleResponse": {
|
|
801
|
+
"document": "CreateMessageEnrichmentRule response structure.",
|
|
802
|
+
"members": [
|
|
803
|
+
{
|
|
804
|
+
"disabled": false,
|
|
805
|
+
"document": "Cluster ID.",
|
|
806
|
+
"example": "mqtt-xxxx",
|
|
807
|
+
"member": "string",
|
|
808
|
+
"name": "InstanceId",
|
|
809
|
+
"output_required": true,
|
|
810
|
+
"type": "string",
|
|
811
|
+
"value_allowed_null": false
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"disabled": false,
|
|
815
|
+
"document": "Rule ID",
|
|
816
|
+
"example": "1",
|
|
817
|
+
"member": "int64",
|
|
818
|
+
"name": "Id",
|
|
819
|
+
"output_required": true,
|
|
820
|
+
"type": "int",
|
|
821
|
+
"value_allowed_null": false
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
825
|
+
"member": "string",
|
|
826
|
+
"name": "RequestId",
|
|
827
|
+
"type": "string"
|
|
828
|
+
}
|
|
829
|
+
],
|
|
830
|
+
"type": "object"
|
|
831
|
+
},
|
|
832
|
+
"CreateUserRequest": {
|
|
833
|
+
"document": "CreateUser request structure.",
|
|
834
|
+
"members": [
|
|
835
|
+
{
|
|
836
|
+
"disabled": false,
|
|
837
|
+
"document": "Instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
838
|
+
"example": "mqtt-xxxx",
|
|
839
|
+
"member": "string",
|
|
840
|
+
"name": "InstanceId",
|
|
841
|
+
"required": true,
|
|
842
|
+
"type": "string"
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"disabled": false,
|
|
846
|
+
"document": "Specifies the username, which cannot be empty, only supports numbers, uppercase and lowercase letters, and separators (\"_\", \"-\"), and must not exceed 32 characters.",
|
|
847
|
+
"example": "user1",
|
|
848
|
+
"member": "string",
|
|
849
|
+
"name": "Username",
|
|
850
|
+
"required": true,
|
|
851
|
+
"type": "string"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"disabled": false,
|
|
855
|
+
"document": "Specifies the password. if this field is empty, the backend performs default generation. when using a user-defined password, the value cannot be empty, only supports numbers, uppercase and lowercase letters, and separators (\"_\", \"-\"), and must not exceed 64 characters.",
|
|
856
|
+
"example": "pwd",
|
|
857
|
+
"member": "string",
|
|
858
|
+
"name": "Password",
|
|
859
|
+
"required": false,
|
|
860
|
+
"type": "string"
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"disabled": false,
|
|
864
|
+
"document": "Specifies the remark with length not exceeding 128 characters.",
|
|
865
|
+
"example": "remark",
|
|
866
|
+
"member": "string",
|
|
867
|
+
"name": "Remark",
|
|
868
|
+
"required": false,
|
|
869
|
+
"type": "string"
|
|
870
|
+
}
|
|
871
|
+
],
|
|
872
|
+
"type": "object"
|
|
873
|
+
},
|
|
874
|
+
"CreateUserResponse": {
|
|
875
|
+
"document": "CreateUser response structure.",
|
|
876
|
+
"members": [
|
|
877
|
+
{
|
|
878
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
879
|
+
"member": "string",
|
|
880
|
+
"name": "RequestId",
|
|
881
|
+
"type": "string"
|
|
882
|
+
}
|
|
883
|
+
],
|
|
884
|
+
"type": "object"
|
|
885
|
+
},
|
|
886
|
+
"DeleteAuthorizationPolicyRequest": {
|
|
887
|
+
"document": "DeleteAuthorizationPolicy request structure.",
|
|
888
|
+
"members": [
|
|
889
|
+
{
|
|
890
|
+
"disabled": false,
|
|
891
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
892
|
+
"example": "mqtt-xxxx",
|
|
893
|
+
"member": "string",
|
|
894
|
+
"name": "InstanceId",
|
|
895
|
+
"required": true,
|
|
896
|
+
"type": "string"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"disabled": false,
|
|
900
|
+
"document": "Specifies the authorization policy rule id, which can be obtained from the DescribeAuthorizationPolicies api (https://www.tencentcloud.com/document/api/1778/111074?from_cn_redirect=1).",
|
|
901
|
+
"example": "1",
|
|
902
|
+
"member": "int64",
|
|
903
|
+
"name": "Id",
|
|
904
|
+
"required": true,
|
|
905
|
+
"type": "int"
|
|
906
|
+
}
|
|
907
|
+
],
|
|
908
|
+
"type": "object"
|
|
909
|
+
},
|
|
910
|
+
"DeleteAuthorizationPolicyResponse": {
|
|
911
|
+
"document": "DeleteAuthorizationPolicy response structure.",
|
|
912
|
+
"members": [
|
|
913
|
+
{
|
|
914
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
915
|
+
"member": "string",
|
|
916
|
+
"name": "RequestId",
|
|
917
|
+
"type": "string"
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"type": "object"
|
|
921
|
+
},
|
|
922
|
+
"DeleteClientSubscriptionRequest": {
|
|
923
|
+
"document": "DeleteClientSubscription request structure.",
|
|
924
|
+
"members": [
|
|
925
|
+
{
|
|
926
|
+
"disabled": false,
|
|
927
|
+
"document": "Instance ID.",
|
|
928
|
+
"example": "mqtt-xxxx",
|
|
929
|
+
"member": "string",
|
|
930
|
+
"name": "InstanceId",
|
|
931
|
+
"required": true,
|
|
932
|
+
"type": "string"
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"disabled": false,
|
|
936
|
+
"document": "Client ID.",
|
|
937
|
+
"example": "client1",
|
|
938
|
+
"member": "string",
|
|
939
|
+
"name": "ClientId",
|
|
940
|
+
"required": false,
|
|
941
|
+
"type": "string"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"disabled": false,
|
|
945
|
+
"document": "Specifies the subscription.",
|
|
946
|
+
"example": "humidity/+/",
|
|
947
|
+
"member": "string",
|
|
948
|
+
"name": "TopicFilter",
|
|
949
|
+
"required": false,
|
|
950
|
+
"type": "string"
|
|
951
|
+
}
|
|
952
|
+
],
|
|
953
|
+
"type": "object"
|
|
954
|
+
},
|
|
955
|
+
"DeleteClientSubscriptionResponse": {
|
|
956
|
+
"document": "DeleteClientSubscription response structure.",
|
|
957
|
+
"members": [
|
|
958
|
+
{
|
|
959
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
960
|
+
"member": "string",
|
|
961
|
+
"name": "RequestId",
|
|
962
|
+
"type": "string"
|
|
963
|
+
}
|
|
964
|
+
],
|
|
965
|
+
"type": "object"
|
|
966
|
+
},
|
|
967
|
+
"DeleteInstanceRequest": {
|
|
968
|
+
"document": "DeleteInstance request structure.",
|
|
969
|
+
"members": [
|
|
970
|
+
{
|
|
971
|
+
"disabled": false,
|
|
972
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
973
|
+
"example": "mqtt-xxxx",
|
|
974
|
+
"member": "string",
|
|
975
|
+
"name": "InstanceId",
|
|
976
|
+
"required": true,
|
|
977
|
+
"type": "string"
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"type": "object"
|
|
981
|
+
},
|
|
982
|
+
"DeleteInstanceResponse": {
|
|
983
|
+
"document": "DeleteInstance response structure.",
|
|
984
|
+
"members": [
|
|
985
|
+
{
|
|
986
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
987
|
+
"member": "string",
|
|
988
|
+
"name": "RequestId",
|
|
989
|
+
"type": "string"
|
|
990
|
+
}
|
|
991
|
+
],
|
|
992
|
+
"type": "object"
|
|
993
|
+
},
|
|
994
|
+
"DeleteMessageEnrichmentRuleRequest": {
|
|
995
|
+
"document": "DeleteMessageEnrichmentRule request structure.",
|
|
996
|
+
"members": [
|
|
997
|
+
{
|
|
998
|
+
"disabled": false,
|
|
999
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1000
|
+
"example": "mqtt-xxxx",
|
|
1001
|
+
"member": "string",
|
|
1002
|
+
"name": "InstanceId",
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"type": "string"
|
|
1005
|
+
},
|
|
1006
|
+
{
|
|
1007
|
+
"disabled": false,
|
|
1008
|
+
"document": "Message enrichment rule id.",
|
|
1009
|
+
"example": "1",
|
|
1010
|
+
"member": "int64",
|
|
1011
|
+
"name": "Id",
|
|
1012
|
+
"required": true,
|
|
1013
|
+
"type": "int"
|
|
1014
|
+
}
|
|
1015
|
+
],
|
|
1016
|
+
"type": "object"
|
|
1017
|
+
},
|
|
1018
|
+
"DeleteMessageEnrichmentRuleResponse": {
|
|
1019
|
+
"document": "DeleteMessageEnrichmentRule response structure.",
|
|
1020
|
+
"members": [
|
|
1021
|
+
{
|
|
1022
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1023
|
+
"member": "string",
|
|
1024
|
+
"name": "RequestId",
|
|
1025
|
+
"type": "string"
|
|
1026
|
+
}
|
|
1027
|
+
],
|
|
1028
|
+
"type": "object"
|
|
1029
|
+
},
|
|
1030
|
+
"DeleteTopicRequest": {
|
|
1031
|
+
"document": "DeleteTopic request structure.",
|
|
1032
|
+
"members": [
|
|
1033
|
+
{
|
|
1034
|
+
"disabled": false,
|
|
1035
|
+
"document": "Instance ID.",
|
|
1036
|
+
"example": "mqtt-xxxx",
|
|
1037
|
+
"member": "string",
|
|
1038
|
+
"name": "InstanceId",
|
|
1039
|
+
"required": true,
|
|
1040
|
+
"type": "string"
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"disabled": false,
|
|
1044
|
+
"document": "Topic.",
|
|
1045
|
+
"example": "sample-topic-name",
|
|
1046
|
+
"member": "string",
|
|
1047
|
+
"name": "Topic",
|
|
1048
|
+
"required": true,
|
|
1049
|
+
"type": "string"
|
|
1050
|
+
}
|
|
1051
|
+
],
|
|
1052
|
+
"type": "object"
|
|
1053
|
+
},
|
|
1054
|
+
"DeleteTopicResponse": {
|
|
1055
|
+
"document": "DeleteTopic response structure.",
|
|
1056
|
+
"members": [
|
|
1057
|
+
{
|
|
1058
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1059
|
+
"member": "string",
|
|
1060
|
+
"name": "RequestId",
|
|
1061
|
+
"type": "string"
|
|
1062
|
+
}
|
|
1063
|
+
],
|
|
1064
|
+
"type": "object"
|
|
1065
|
+
},
|
|
1066
|
+
"DeleteUserRequest": {
|
|
1067
|
+
"document": "DeleteUser request structure.",
|
|
1068
|
+
"members": [
|
|
1069
|
+
{
|
|
1070
|
+
"disabled": false,
|
|
1071
|
+
"document": "Instance ID.",
|
|
1072
|
+
"example": "mqtt-xxxx",
|
|
1073
|
+
"member": "string",
|
|
1074
|
+
"name": "InstanceId",
|
|
1075
|
+
"required": true,
|
|
1076
|
+
"type": "string"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"disabled": false,
|
|
1080
|
+
"document": "Username.",
|
|
1081
|
+
"example": "user1",
|
|
1082
|
+
"member": "string",
|
|
1083
|
+
"name": "Username",
|
|
1084
|
+
"required": true,
|
|
1085
|
+
"type": "string"
|
|
1086
|
+
}
|
|
1087
|
+
],
|
|
1088
|
+
"type": "object"
|
|
1089
|
+
},
|
|
1090
|
+
"DeleteUserResponse": {
|
|
1091
|
+
"document": "DeleteUser response structure.",
|
|
1092
|
+
"members": [
|
|
1093
|
+
{
|
|
1094
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1095
|
+
"member": "string",
|
|
1096
|
+
"name": "RequestId",
|
|
1097
|
+
"type": "string"
|
|
1098
|
+
}
|
|
1099
|
+
],
|
|
1100
|
+
"type": "object"
|
|
1101
|
+
},
|
|
1102
|
+
"DescribeAuthorizationPoliciesRequest": {
|
|
1103
|
+
"document": "DescribeAuthorizationPolicies request structure.",
|
|
1104
|
+
"members": [
|
|
1105
|
+
{
|
|
1106
|
+
"disabled": false,
|
|
1107
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1108
|
+
"example": "mqtt-xxxx",
|
|
1109
|
+
"member": "string",
|
|
1110
|
+
"name": "InstanceId",
|
|
1111
|
+
"required": false,
|
|
1112
|
+
"type": "string"
|
|
1113
|
+
}
|
|
1114
|
+
],
|
|
1115
|
+
"type": "object"
|
|
1116
|
+
},
|
|
1117
|
+
"DescribeAuthorizationPoliciesResponse": {
|
|
1118
|
+
"document": "DescribeAuthorizationPolicies response structure.",
|
|
1119
|
+
"members": [
|
|
1120
|
+
{
|
|
1121
|
+
"disabled": false,
|
|
1122
|
+
"document": "Rule",
|
|
1123
|
+
"example": "无",
|
|
1124
|
+
"member": "AuthorizationPolicyItem",
|
|
1125
|
+
"name": "Data",
|
|
1126
|
+
"output_required": false,
|
|
1127
|
+
"type": "list",
|
|
1128
|
+
"value_allowed_null": false
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1132
|
+
"member": "string",
|
|
1133
|
+
"name": "RequestId",
|
|
1134
|
+
"type": "string"
|
|
1135
|
+
}
|
|
1136
|
+
],
|
|
1137
|
+
"type": "object"
|
|
1138
|
+
},
|
|
1139
|
+
"DescribeClientListRequest": {
|
|
1140
|
+
"document": "DescribeClientList request structure.",
|
|
1141
|
+
"members": [
|
|
1142
|
+
{
|
|
1143
|
+
"disabled": false,
|
|
1144
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1145
|
+
"example": "mqtt-xxxx",
|
|
1146
|
+
"member": "string",
|
|
1147
|
+
"name": "InstanceId",
|
|
1148
|
+
"required": true,
|
|
1149
|
+
"type": "string"
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
"disabled": false,
|
|
1153
|
+
"document": "Client ID",
|
|
1154
|
+
"example": "client1",
|
|
1155
|
+
"member": "string",
|
|
1156
|
+
"name": "ClientId",
|
|
1157
|
+
"required": false,
|
|
1158
|
+
"type": "string"
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"disabled": false,
|
|
1162
|
+
"document": "Limit on the number of clients. Maximum value: 1024. Default value: 1024.",
|
|
1163
|
+
"example": "1024",
|
|
1164
|
+
"member": "string",
|
|
1165
|
+
"name": "Number",
|
|
1166
|
+
"required": false,
|
|
1167
|
+
"type": "string"
|
|
1168
|
+
}
|
|
1169
|
+
],
|
|
1170
|
+
"type": "object"
|
|
1171
|
+
},
|
|
1172
|
+
"DescribeClientListResponse": {
|
|
1173
|
+
"document": "DescribeClientList response structure.",
|
|
1174
|
+
"members": [
|
|
1175
|
+
{
|
|
1176
|
+
"disabled": false,
|
|
1177
|
+
"document": "Specifies the client list.",
|
|
1178
|
+
"example": "无",
|
|
1179
|
+
"member": "MQTTClientInfo",
|
|
1180
|
+
"name": "Clients",
|
|
1181
|
+
"output_required": true,
|
|
1182
|
+
"type": "list",
|
|
1183
|
+
"value_allowed_null": false
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1187
|
+
"member": "string",
|
|
1188
|
+
"name": "RequestId",
|
|
1189
|
+
"type": "string"
|
|
1190
|
+
}
|
|
1191
|
+
],
|
|
1192
|
+
"type": "object"
|
|
1193
|
+
},
|
|
1194
|
+
"DescribeInstanceRequest": {
|
|
1195
|
+
"document": "DescribeInstance request structure.",
|
|
1196
|
+
"members": [
|
|
1197
|
+
{
|
|
1198
|
+
"disabled": false,
|
|
1199
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1200
|
+
"example": "mqtt-xxxx",
|
|
1201
|
+
"member": "string",
|
|
1202
|
+
"name": "InstanceId",
|
|
1203
|
+
"required": true,
|
|
1204
|
+
"type": "string"
|
|
1205
|
+
}
|
|
1206
|
+
],
|
|
1207
|
+
"type": "object"
|
|
1208
|
+
},
|
|
1209
|
+
"DescribeInstanceResponse": {
|
|
1210
|
+
"document": "DescribeInstance response structure.",
|
|
1211
|
+
"members": [
|
|
1212
|
+
{
|
|
1213
|
+
"disabled": false,
|
|
1214
|
+
"document": "Instance type\nBASIC: basic edition.\nPRO edition.\nPLATINUM edition.",
|
|
1215
|
+
"example": "PRO",
|
|
1216
|
+
"member": "string",
|
|
1217
|
+
"name": "InstanceType",
|
|
1218
|
+
"output_required": true,
|
|
1219
|
+
"type": "string",
|
|
1220
|
+
"value_allowed_null": false
|
|
1221
|
+
},
|
|
1222
|
+
{
|
|
1223
|
+
"disabled": false,
|
|
1224
|
+
"document": "Instance ID.",
|
|
1225
|
+
"example": "mqtt-mwmdg9dm",
|
|
1226
|
+
"member": "string",
|
|
1227
|
+
"name": "InstanceId",
|
|
1228
|
+
"output_required": true,
|
|
1229
|
+
"type": "string",
|
|
1230
|
+
"value_allowed_null": false
|
|
1231
|
+
},
|
|
1232
|
+
{
|
|
1233
|
+
"disabled": false,
|
|
1234
|
+
"document": "Instance name",
|
|
1235
|
+
"example": "name",
|
|
1236
|
+
"member": "string",
|
|
1237
|
+
"name": "InstanceName",
|
|
1238
|
+
"output_required": true,
|
|
1239
|
+
"type": "string",
|
|
1240
|
+
"value_allowed_null": false
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
"disabled": false,
|
|
1244
|
+
"document": "Number of topics",
|
|
1245
|
+
"example": "2",
|
|
1246
|
+
"member": "int64",
|
|
1247
|
+
"name": "TopicNum",
|
|
1248
|
+
"output_required": true,
|
|
1249
|
+
"type": "int",
|
|
1250
|
+
"value_allowed_null": false
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
"disabled": false,
|
|
1254
|
+
"document": "Maximum number of topics per instance",
|
|
1255
|
+
"example": "1000",
|
|
1256
|
+
"member": "int64",
|
|
1257
|
+
"name": "TopicNumLimit",
|
|
1258
|
+
"output_required": true,
|
|
1259
|
+
"type": "int",
|
|
1260
|
+
"value_allowed_null": false
|
|
1261
|
+
},
|
|
1262
|
+
{
|
|
1263
|
+
"disabled": false,
|
|
1264
|
+
"document": "TPS throttle value",
|
|
1265
|
+
"example": "1000",
|
|
1266
|
+
"member": "int64",
|
|
1267
|
+
"name": "TpsLimit",
|
|
1268
|
+
"output_required": true,
|
|
1269
|
+
"type": "int",
|
|
1270
|
+
"value_allowed_null": false
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"disabled": false,
|
|
1274
|
+
"document": "Creation time, in seconds",
|
|
1275
|
+
"example": "1711955420",
|
|
1276
|
+
"member": "int64",
|
|
1277
|
+
"name": "CreatedTime",
|
|
1278
|
+
"output_required": true,
|
|
1279
|
+
"type": "int",
|
|
1280
|
+
"value_allowed_null": false
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
"disabled": false,
|
|
1284
|
+
"document": "Remarks",
|
|
1285
|
+
"example": "remark",
|
|
1286
|
+
"member": "string",
|
|
1287
|
+
"name": "Remark",
|
|
1288
|
+
"output_required": true,
|
|
1289
|
+
"type": "string",
|
|
1290
|
+
"value_allowed_null": false
|
|
1291
|
+
},
|
|
1292
|
+
{
|
|
1293
|
+
"disabled": false,
|
|
1294
|
+
"document": "Instance status. RUNNING: running; MAINTAINING: maintaining; ABNORMAL: abnormal; OVERDUE: in arrears; DESTROYED: deleted; CREATING: creating; MODIFYING: adjusting the configuration; CREATE_FAILURE: creation failed; MODIFY_FAILURE: configuration adjustment failed; DELETING: deleting.",
|
|
1295
|
+
"example": "RUNNING",
|
|
1296
|
+
"member": "string",
|
|
1297
|
+
"name": "InstanceStatus",
|
|
1298
|
+
"output_required": true,
|
|
1299
|
+
"type": "string",
|
|
1300
|
+
"value_allowed_null": false
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"disabled": false,
|
|
1304
|
+
"document": "Specifies the instance specification.",
|
|
1305
|
+
"example": "pro_10k_1",
|
|
1306
|
+
"member": "string",
|
|
1307
|
+
"name": "SkuCode",
|
|
1308
|
+
"output_required": true,
|
|
1309
|
+
"type": "string",
|
|
1310
|
+
"value_allowed_null": false
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
"disabled": false,
|
|
1314
|
+
"document": "Maximum number of subscriptions for a single client.",
|
|
1315
|
+
"example": "30",
|
|
1316
|
+
"member": "int64",
|
|
1317
|
+
"name": "MaxSubscriptionPerClient",
|
|
1318
|
+
"output_required": true,
|
|
1319
|
+
"type": "int",
|
|
1320
|
+
"value_allowed_null": false
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
"disabled": false,
|
|
1324
|
+
"document": "Number of authorization rules.",
|
|
1325
|
+
"example": "10",
|
|
1326
|
+
"member": "int64",
|
|
1327
|
+
"name": "AuthorizationPolicyLimit",
|
|
1328
|
+
"output_required": true,
|
|
1329
|
+
"type": "int",
|
|
1330
|
+
"value_allowed_null": false
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
"disabled": false,
|
|
1334
|
+
"document": "Maximum number of clients.",
|
|
1335
|
+
"example": "1000",
|
|
1336
|
+
"member": "int64",
|
|
1337
|
+
"name": "ClientNumLimit",
|
|
1338
|
+
"output_required": true,
|
|
1339
|
+
"type": "int",
|
|
1340
|
+
"value_allowed_null": false
|
|
1341
|
+
},
|
|
1342
|
+
{
|
|
1343
|
+
"disabled": false,
|
|
1344
|
+
"document": "Specifies the registration method for the client certificate.\nJITP: automatically register.\nAPI: register manually through api.",
|
|
1345
|
+
"example": "API",
|
|
1346
|
+
"member": "string",
|
|
1347
|
+
"name": "DeviceCertificateProvisionType",
|
|
1348
|
+
"output_required": true,
|
|
1349
|
+
"type": "string",
|
|
1350
|
+
"value_allowed_null": false
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"disabled": false,
|
|
1354
|
+
"document": "Specifies whether to automatically activate the device certificate during automatic registration.",
|
|
1355
|
+
"example": "false",
|
|
1356
|
+
"member": "bool",
|
|
1357
|
+
"name": "AutomaticActivation",
|
|
1358
|
+
"output_required": false,
|
|
1359
|
+
"type": "bool",
|
|
1360
|
+
"value_allowed_null": false
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
"disabled": false,
|
|
1364
|
+
"document": "Whether the instance is automatically renewed. this parameter is valid only for monthly subscription clusters. valid values: 1 (auto-renewal), 0 (non-automatic renewal).",
|
|
1365
|
+
"example": "1",
|
|
1366
|
+
"member": "int64",
|
|
1367
|
+
"name": "RenewFlag",
|
|
1368
|
+
"output_required": true,
|
|
1369
|
+
"type": "int",
|
|
1370
|
+
"value_allowed_null": false
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"disabled": false,
|
|
1374
|
+
"document": "Billing mode. POSTPAID: pay-as-you-go billing. PREPAID: monthly subscription.",
|
|
1375
|
+
"example": "POSTPAID",
|
|
1376
|
+
"member": "string",
|
|
1377
|
+
"name": "PayMode",
|
|
1378
|
+
"output_required": true,
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"value_allowed_null": false
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"disabled": false,
|
|
1384
|
+
"document": "Expiry time. millisecond-level timestamp.",
|
|
1385
|
+
"example": "1713164969433",
|
|
1386
|
+
"member": "int64",
|
|
1387
|
+
"name": "ExpiryTime",
|
|
1388
|
+
"output_required": true,
|
|
1389
|
+
"type": "int",
|
|
1390
|
+
"value_allowed_null": false
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
"disabled": false,
|
|
1394
|
+
"document": "Scheduled destruction time. millisecond-level timestamp.",
|
|
1395
|
+
"example": "1713164969433",
|
|
1396
|
+
"member": "int64",
|
|
1397
|
+
"name": "DestroyTime",
|
|
1398
|
+
"output_required": true,
|
|
1399
|
+
"type": "int",
|
|
1400
|
+
"value_allowed_null": false
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"disabled": false,
|
|
1404
|
+
"document": "TLS, one-way authentication. mTLS, mutual authentication. BYOC, one certificate per device.",
|
|
1405
|
+
"example": "TLS",
|
|
1406
|
+
"member": "string",
|
|
1407
|
+
"name": "X509Mode",
|
|
1408
|
+
"output_required": true,
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"value_allowed_null": false
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"disabled": false,
|
|
1414
|
+
"document": "Specifies the maximum Ca quota.",
|
|
1415
|
+
"example": "1",
|
|
1416
|
+
"member": "int64",
|
|
1417
|
+
"name": "MaxCaNum",
|
|
1418
|
+
"output_required": false,
|
|
1419
|
+
"type": "int",
|
|
1420
|
+
"value_allowed_null": false
|
|
1421
|
+
},
|
|
1422
|
+
{
|
|
1423
|
+
"disabled": false,
|
|
1424
|
+
"document": "FPS cert registration code.",
|
|
1425
|
+
"example": "2140c1c2-e26d-47f6-9048-0573f91b219b",
|
|
1426
|
+
"member": "string",
|
|
1427
|
+
"name": "RegistrationCode",
|
|
1428
|
+
"output_required": false,
|
|
1429
|
+
"type": "string",
|
|
1430
|
+
"value_allowed_null": false
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"disabled": false,
|
|
1434
|
+
"document": "Maximum number of subscriptions for a cluster.",
|
|
1435
|
+
"example": "120000",
|
|
1436
|
+
"member": "int64",
|
|
1437
|
+
"name": "MaxSubscription",
|
|
1438
|
+
"output_required": false,
|
|
1439
|
+
"type": "int",
|
|
1440
|
+
"value_allowed_null": false
|
|
1441
|
+
},
|
|
1442
|
+
{
|
|
1443
|
+
"disabled": false,
|
|
1444
|
+
"document": "Authorization policy switch.",
|
|
1445
|
+
"example": "false",
|
|
1446
|
+
"member": "bool",
|
|
1447
|
+
"name": "AuthorizationPolicy",
|
|
1448
|
+
"output_required": false,
|
|
1449
|
+
"type": "bool",
|
|
1450
|
+
"value_allowed_null": false
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"disabled": false,
|
|
1454
|
+
"document": "Maximum limit of shared subscription groups.",
|
|
1455
|
+
"example": "20",
|
|
1456
|
+
"member": "int64",
|
|
1457
|
+
"name": "SharedSubscriptionGroupLimit",
|
|
1458
|
+
"output_required": false,
|
|
1459
|
+
"type": "int",
|
|
1460
|
+
"value_allowed_null": false
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
"disabled": false,
|
|
1464
|
+
"document": "Specifies the topic filter number limit for each shared subscription group.",
|
|
1465
|
+
"example": "10",
|
|
1466
|
+
"member": "int64",
|
|
1467
|
+
"name": "MaxTopicFilterPerSharedSubscriptionGroup",
|
|
1468
|
+
"output_required": false,
|
|
1469
|
+
"type": "int",
|
|
1470
|
+
"value_allowed_null": false
|
|
1471
|
+
},
|
|
1472
|
+
{
|
|
1473
|
+
"disabled": false,
|
|
1474
|
+
"document": "Specifies the limit on number of auto-subscription rules.",
|
|
1475
|
+
"example": "10",
|
|
1476
|
+
"member": "int64",
|
|
1477
|
+
"name": "AutoSubscriptionPolicyLimit",
|
|
1478
|
+
"output_required": false,
|
|
1479
|
+
"type": "int",
|
|
1480
|
+
"value_allowed_null": false
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
"disabled": false,
|
|
1484
|
+
"document": "Specifies the number limit of TopicFilter in a single auto-subscription rule.",
|
|
1485
|
+
"example": "5",
|
|
1486
|
+
"member": "int64",
|
|
1487
|
+
"name": "MaxTopicFilterPerAutoSubscriptionPolicy",
|
|
1488
|
+
"output_required": false,
|
|
1489
|
+
"type": "int",
|
|
1490
|
+
"value_allowed_null": false
|
|
1491
|
+
},
|
|
1492
|
+
{
|
|
1493
|
+
"disabled": false,
|
|
1494
|
+
"document": "Specifies whether to use the default server certificate.",
|
|
1495
|
+
"example": "false",
|
|
1496
|
+
"member": "bool",
|
|
1497
|
+
"name": "UseDefaultServerCert",
|
|
1498
|
+
"output_required": false,
|
|
1499
|
+
"type": "bool",
|
|
1500
|
+
"value_allowed_null": false
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
"disabled": false,
|
|
1504
|
+
"document": "Maximum allowed number of server cas.",
|
|
1505
|
+
"example": "3",
|
|
1506
|
+
"member": "int64",
|
|
1507
|
+
"name": "TrustedCaLimit",
|
|
1508
|
+
"output_required": false,
|
|
1509
|
+
"type": "int",
|
|
1510
|
+
"value_allowed_null": false
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
"disabled": false,
|
|
1514
|
+
"document": "Specifies the maximum allowed number of server certificates.",
|
|
1515
|
+
"example": "3",
|
|
1516
|
+
"member": "int64",
|
|
1517
|
+
"name": "ServerCertLimit",
|
|
1518
|
+
"output_required": false,
|
|
1519
|
+
"type": "int",
|
|
1520
|
+
"value_allowed_null": false
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"disabled": false,
|
|
1524
|
+
"document": "Specifies the max level of the topic prefix.",
|
|
1525
|
+
"example": "3",
|
|
1526
|
+
"member": "int64",
|
|
1527
|
+
"name": "TopicPrefixSlashLimit",
|
|
1528
|
+
"output_required": false,
|
|
1529
|
+
"type": "int",
|
|
1530
|
+
"value_allowed_null": false
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"disabled": false,
|
|
1534
|
+
"document": "Specifies the speed limit for sending messages by a single client in messages per second.",
|
|
1535
|
+
"example": "10",
|
|
1536
|
+
"member": "int64",
|
|
1537
|
+
"name": "MessageRate",
|
|
1538
|
+
"output_required": false,
|
|
1539
|
+
"type": "int",
|
|
1540
|
+
"value_allowed_null": false
|
|
1541
|
+
},
|
|
1542
|
+
{
|
|
1543
|
+
"disabled": false,
|
|
1544
|
+
"document": "Specifies the protocols supported by the server tls, separated by \",\". example: TLSv1.3,TLSv1.2,TLSv1.1,TLSv1.",
|
|
1545
|
+
"example": "TLSv1.3,TLSv1.2,TLSv1.1,TLSv1",
|
|
1546
|
+
"member": "string",
|
|
1547
|
+
"name": "TransportLayerSecurity",
|
|
1548
|
+
"output_required": false,
|
|
1549
|
+
"type": "string",
|
|
1550
|
+
"value_allowed_null": false
|
|
1551
|
+
},
|
|
1552
|
+
{
|
|
1553
|
+
"disabled": false,
|
|
1554
|
+
"document": "Specifies the message property enrichment rule quota.",
|
|
1555
|
+
"example": "10",
|
|
1556
|
+
"member": "int64",
|
|
1557
|
+
"name": "MessageEnrichmentRuleLimit",
|
|
1558
|
+
"output_required": false,
|
|
1559
|
+
"type": "int",
|
|
1560
|
+
"value_allowed_null": false
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1564
|
+
"member": "string",
|
|
1565
|
+
"name": "RequestId",
|
|
1566
|
+
"type": "string"
|
|
1567
|
+
}
|
|
1568
|
+
],
|
|
1569
|
+
"type": "object"
|
|
1570
|
+
},
|
|
1571
|
+
"DescribeMessageByTopicRequest": {
|
|
1572
|
+
"document": "DescribeMessageByTopic request structure.",
|
|
1573
|
+
"members": [
|
|
1574
|
+
{
|
|
1575
|
+
"disabled": false,
|
|
1576
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1577
|
+
"example": "mqtt-xxxx",
|
|
1578
|
+
"member": "string",
|
|
1579
|
+
"name": "InstanceId",
|
|
1580
|
+
"required": true,
|
|
1581
|
+
"type": "string"
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"disabled": false,
|
|
1585
|
+
"document": "home/room",
|
|
1586
|
+
"example": "发送topic或者订阅表达式",
|
|
1587
|
+
"member": "string",
|
|
1588
|
+
"name": "Topic",
|
|
1589
|
+
"required": true,
|
|
1590
|
+
"type": "string"
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"disabled": false,
|
|
1594
|
+
"document": "Start time. millisecond-level timestamp.",
|
|
1595
|
+
"example": "1712025623202",
|
|
1596
|
+
"member": "int64",
|
|
1597
|
+
"name": "StartTime",
|
|
1598
|
+
"required": true,
|
|
1599
|
+
"type": "int"
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"disabled": false,
|
|
1603
|
+
"document": "Specifies the number of query messages. value range: 1-1024. default: 100.",
|
|
1604
|
+
"example": "100",
|
|
1605
|
+
"member": "int64",
|
|
1606
|
+
"name": "MaxNumber",
|
|
1607
|
+
"required": false,
|
|
1608
|
+
"type": "int"
|
|
1609
|
+
}
|
|
1610
|
+
],
|
|
1611
|
+
"type": "object"
|
|
1612
|
+
},
|
|
1613
|
+
"DescribeMessageByTopicResponse": {
|
|
1614
|
+
"document": "DescribeMessageByTopic response structure.",
|
|
1615
|
+
"members": [
|
|
1616
|
+
{
|
|
1617
|
+
"disabled": false,
|
|
1618
|
+
"document": "Message List",
|
|
1619
|
+
"example": "无",
|
|
1620
|
+
"member": "MQTTMessage",
|
|
1621
|
+
"name": "Data",
|
|
1622
|
+
"output_required": false,
|
|
1623
|
+
"type": "list",
|
|
1624
|
+
"value_allowed_null": false
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1628
|
+
"member": "string",
|
|
1629
|
+
"name": "RequestId",
|
|
1630
|
+
"type": "string"
|
|
1631
|
+
}
|
|
1632
|
+
],
|
|
1633
|
+
"type": "object"
|
|
1634
|
+
},
|
|
1635
|
+
"DescribeMessageDetailsRequest": {
|
|
1636
|
+
"document": "DescribeMessageDetails request structure.",
|
|
1637
|
+
"members": [
|
|
1638
|
+
{
|
|
1639
|
+
"disabled": false,
|
|
1640
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1641
|
+
"example": "mqtt-xxxx",
|
|
1642
|
+
"member": "string",
|
|
1643
|
+
"name": "InstanceId",
|
|
1644
|
+
"required": true,
|
|
1645
|
+
"type": "string"
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"disabled": false,
|
|
1649
|
+
"document": "Message ID.",
|
|
1650
|
+
"example": "0B8D67D3003505C29BFD077EC65B0002",
|
|
1651
|
+
"member": "string",
|
|
1652
|
+
"name": "MessageId",
|
|
1653
|
+
"required": true,
|
|
1654
|
+
"type": "string"
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"disabled": false,
|
|
1658
|
+
"document": "Subscription expression.",
|
|
1659
|
+
"example": "home/room",
|
|
1660
|
+
"member": "string",
|
|
1661
|
+
"name": "Subscription",
|
|
1662
|
+
"required": false,
|
|
1663
|
+
"type": "string"
|
|
1664
|
+
}
|
|
1665
|
+
],
|
|
1666
|
+
"type": "object"
|
|
1667
|
+
},
|
|
1668
|
+
"DescribeMessageDetailsResponse": {
|
|
1669
|
+
"document": "DescribeMessageDetails response structure.",
|
|
1670
|
+
"members": [
|
|
1671
|
+
{
|
|
1672
|
+
"disabled": false,
|
|
1673
|
+
"document": "Message body.",
|
|
1674
|
+
"example": "body",
|
|
1675
|
+
"member": "string",
|
|
1676
|
+
"name": "Body",
|
|
1677
|
+
"output_required": true,
|
|
1678
|
+
"type": "string",
|
|
1679
|
+
"value_allowed_null": false
|
|
1680
|
+
},
|
|
1681
|
+
{
|
|
1682
|
+
"disabled": false,
|
|
1683
|
+
"document": "Describes the user-customized attribute.",
|
|
1684
|
+
"example": "无",
|
|
1685
|
+
"member": "UserProperty",
|
|
1686
|
+
"name": "UserProperties",
|
|
1687
|
+
"output_required": false,
|
|
1688
|
+
"type": "list",
|
|
1689
|
+
"value_allowed_null": false
|
|
1690
|
+
},
|
|
1691
|
+
{
|
|
1692
|
+
"disabled": false,
|
|
1693
|
+
"document": "Specifies the message storage time. millisecond-level timestamp.",
|
|
1694
|
+
"example": "1745828681259",
|
|
1695
|
+
"member": "int64",
|
|
1696
|
+
"name": "StoreTimestamp",
|
|
1697
|
+
"output_required": true,
|
|
1698
|
+
"type": "int",
|
|
1699
|
+
"value_allowed_null": false
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"disabled": false,
|
|
1703
|
+
"document": "Message ID.",
|
|
1704
|
+
"example": "0B8D67D3003505C29BFD077EC65B0002",
|
|
1705
|
+
"member": "string",
|
|
1706
|
+
"name": "MessageId",
|
|
1707
|
+
"output_required": true,
|
|
1708
|
+
"type": "string",
|
|
1709
|
+
"value_allowed_null": false
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"disabled": false,
|
|
1713
|
+
"document": "Producer address.",
|
|
1714
|
+
"example": "client-1",
|
|
1715
|
+
"member": "string",
|
|
1716
|
+
"name": "ClientId",
|
|
1717
|
+
"output_required": true,
|
|
1718
|
+
"type": "string",
|
|
1719
|
+
"value_allowed_null": false
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"disabled": false,
|
|
1723
|
+
"document": "Topic",
|
|
1724
|
+
"example": "1",
|
|
1725
|
+
"member": "string",
|
|
1726
|
+
"name": "Qos",
|
|
1727
|
+
"output_required": true,
|
|
1728
|
+
"type": "string",
|
|
1729
|
+
"value_allowed_null": false
|
|
1730
|
+
},
|
|
1731
|
+
{
|
|
1732
|
+
"disabled": false,
|
|
1733
|
+
"document": "Specifies the source topic.",
|
|
1734
|
+
"example": "home/room",
|
|
1735
|
+
"member": "string",
|
|
1736
|
+
"name": "OriginTopic",
|
|
1737
|
+
"output_required": true,
|
|
1738
|
+
"type": "string",
|
|
1739
|
+
"value_allowed_null": false
|
|
1740
|
+
},
|
|
1741
|
+
{
|
|
1742
|
+
"disabled": false,
|
|
1743
|
+
"document": "Content type (MQTT5).\nIndicates the content type of the message payload using standard MIME type format. helps the receiver correctly parse and process the message content.\nSpecifies the example.\napplication/json: indicates the payload is data in json format.\nText/Plain: indicates the payload is plain text.\napplication/octet-stream: indicates the payload is binary data.",
|
|
1744
|
+
"example": "application/json",
|
|
1745
|
+
"member": "string",
|
|
1746
|
+
"name": "ContentType",
|
|
1747
|
+
"output_required": false,
|
|
1748
|
+
"type": "string",
|
|
1749
|
+
"value_allowed_null": false
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"disabled": false,
|
|
1753
|
+
"document": "Payload format indicator (MQTT5).\nIndicates the payload format, which is a boolean value. 0 means an unspecified format (binary), and 1 means a UTF-8 encoded string.\nSpecifies the example.\nValid values: 0 indicates the payload is binary data, such as images or audio.\nValid value 1: when the payload is UTF-8 encoded text, such as JSON string or XML.",
|
|
1754
|
+
"example": "0",
|
|
1755
|
+
"member": "int64",
|
|
1756
|
+
"name": "PayloadFormatIndicator",
|
|
1757
|
+
"output_required": false,
|
|
1758
|
+
"type": "int",
|
|
1759
|
+
"value_allowed_null": false
|
|
1760
|
+
},
|
|
1761
|
+
{
|
|
1762
|
+
"disabled": false,
|
|
1763
|
+
"document": "Message expiration interval (MQTT5).\nSpecifies the validity time (in seconds) of the specified message before it is discarded. if the message fails to reach the MQTT server before expiration, it will be discarded.\nSpecifies the example.\nThe value 60 indicates that the message is valid within 60 seconds after release. unreached messages will be dropped after expiry.\nA value of 0 indicates the message never expires and remains permanently valid until received or the session ends.",
|
|
1764
|
+
"example": "60",
|
|
1765
|
+
"member": "int64",
|
|
1766
|
+
"name": "MessageExpiryInterval",
|
|
1767
|
+
"output_required": false,
|
|
1768
|
+
"type": "int",
|
|
1769
|
+
"value_allowed_null": false
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
"disabled": false,
|
|
1773
|
+
"document": "Response topic (MQTT5).\nSpecifies a topic for the response message in request-response mode. the sender can specify which topic the recipient should send the response to.\nSpecifies the example.\nSender publishes a request to the topic devices/device1/commands and sets ResponseTopic to devices/device1/responses.\nSpecifies the topic where the response is published after the recipient processes the request.",
|
|
1774
|
+
"example": "home/room1",
|
|
1775
|
+
"member": "string",
|
|
1776
|
+
"name": "ResponseTopic",
|
|
1777
|
+
"output_required": false,
|
|
1778
|
+
"type": "string",
|
|
1779
|
+
"value_allowed_null": false
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"disabled": false,
|
|
1783
|
+
"document": "Associated data (MQTT5).\nSpecifies the identifier used to associate a request and response, usually a byte array. in request-response mode, the sender sets this value, and the recipient includes the same value in the response so that the sender can identify the corresponding request.\nSpecifies the example.\nThe sender generates a unique ID (such as a byte[] of UUID) as CorrelationData and adds it to the request message.\nThe recipient includes the same CorrelationData in the response message. the sender compares this value to match the response and the request.",
|
|
1784
|
+
"example": "uuid",
|
|
1785
|
+
"member": "string",
|
|
1786
|
+
"name": "CorrelationData",
|
|
1787
|
+
"output_required": false,
|
|
1788
|
+
"type": "string",
|
|
1789
|
+
"value_allowed_null": false
|
|
1790
|
+
},
|
|
1791
|
+
{
|
|
1792
|
+
"disabled": false,
|
|
1793
|
+
"document": "Subscription identifier (MQTT5).\nSpecifies the unique identifier assigned to the subscription, used to identify a specific subscription of the client. when sending a message to the client, the server can include this identifier to help with client identification of the corresponding subscription.\nSpecifies the example.\nThe client subscribes to the topic devices/+/temperature and sets SubscriptionIdentifier to 123.\nWhen the server sends a message of this topic to the client, the message will contain SubscriptionIdentifier: 123. the client can know which subscription the message is sent through based on this value.",
|
|
1794
|
+
"example": "subs-1",
|
|
1795
|
+
"member": "string",
|
|
1796
|
+
"name": "SubscriptionIdentifier",
|
|
1797
|
+
"output_required": false,
|
|
1798
|
+
"type": "string",
|
|
1799
|
+
"value_allowed_null": false
|
|
1800
|
+
},
|
|
1801
|
+
{
|
|
1802
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1803
|
+
"member": "string",
|
|
1804
|
+
"name": "RequestId",
|
|
1805
|
+
"type": "string"
|
|
1806
|
+
}
|
|
1807
|
+
],
|
|
1808
|
+
"type": "object"
|
|
1809
|
+
},
|
|
1810
|
+
"DescribeMessageEnrichmentRulesRequest": {
|
|
1811
|
+
"document": "DescribeMessageEnrichmentRules request structure.",
|
|
1812
|
+
"members": [
|
|
1813
|
+
{
|
|
1814
|
+
"disabled": false,
|
|
1815
|
+
"document": "Tencent cloud MQTT instance ID, obtained from the DescribeInstanceList API or console.",
|
|
1816
|
+
"example": "mqtt-xxxx",
|
|
1817
|
+
"member": "string",
|
|
1818
|
+
"name": "InstanceId",
|
|
1819
|
+
"required": true,
|
|
1820
|
+
"type": "string"
|
|
1821
|
+
}
|
|
1822
|
+
],
|
|
1823
|
+
"type": "object"
|
|
1824
|
+
},
|
|
1825
|
+
"DescribeMessageEnrichmentRulesResponse": {
|
|
1826
|
+
"document": "DescribeMessageEnrichmentRules response structure.",
|
|
1827
|
+
"members": [
|
|
1828
|
+
{
|
|
1829
|
+
"disabled": false,
|
|
1830
|
+
"document": "Message enrichment rule.",
|
|
1831
|
+
"example": "无",
|
|
1832
|
+
"member": "MessageEnrichmentRuleItem",
|
|
1833
|
+
"name": "Data",
|
|
1834
|
+
"output_required": false,
|
|
1835
|
+
"type": "list",
|
|
1836
|
+
"value_allowed_null": false
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1840
|
+
"member": "string",
|
|
1841
|
+
"name": "RequestId",
|
|
1842
|
+
"type": "string"
|
|
1843
|
+
}
|
|
1844
|
+
],
|
|
1845
|
+
"type": "object"
|
|
1846
|
+
},
|
|
1847
|
+
"DescribeTopicRequest": {
|
|
1848
|
+
"document": "DescribeTopic request structure.",
|
|
1849
|
+
"members": [
|
|
1850
|
+
{
|
|
1851
|
+
"disabled": false,
|
|
1852
|
+
"document": "Instance ID.",
|
|
1853
|
+
"example": "mqtt-xxxx",
|
|
1854
|
+
"member": "string",
|
|
1855
|
+
"name": "InstanceId",
|
|
1856
|
+
"required": true,
|
|
1857
|
+
"type": "string"
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"disabled": false,
|
|
1861
|
+
"document": "Topic.",
|
|
1862
|
+
"example": "sample-topic-name",
|
|
1863
|
+
"member": "string",
|
|
1864
|
+
"name": "Topic",
|
|
1865
|
+
"required": true,
|
|
1866
|
+
"type": "string"
|
|
1867
|
+
}
|
|
1868
|
+
],
|
|
1869
|
+
"type": "object"
|
|
1870
|
+
},
|
|
1871
|
+
"DescribeTopicResponse": {
|
|
1872
|
+
"document": "DescribeTopic response structure.",
|
|
1873
|
+
"members": [
|
|
1874
|
+
{
|
|
1875
|
+
"disabled": false,
|
|
1876
|
+
"document": "Instance ID.",
|
|
1877
|
+
"example": "mqtt-mwmdg9dm",
|
|
1878
|
+
"member": "string",
|
|
1879
|
+
"name": "InstanceId",
|
|
1880
|
+
"output_required": true,
|
|
1881
|
+
"type": "string",
|
|
1882
|
+
"value_allowed_null": false
|
|
1883
|
+
},
|
|
1884
|
+
{
|
|
1885
|
+
"disabled": false,
|
|
1886
|
+
"document": "Topic name",
|
|
1887
|
+
"example": "sample-topic-name",
|
|
1888
|
+
"member": "string",
|
|
1889
|
+
"name": "Topic",
|
|
1890
|
+
"output_required": true,
|
|
1891
|
+
"type": "string",
|
|
1892
|
+
"value_allowed_null": false
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"disabled": false,
|
|
1896
|
+
"document": "Remarks",
|
|
1897
|
+
"example": "additional-remark",
|
|
1898
|
+
"member": "string",
|
|
1899
|
+
"name": "Remark",
|
|
1900
|
+
"output_required": true,
|
|
1901
|
+
"type": "string",
|
|
1902
|
+
"value_allowed_null": false
|
|
1903
|
+
},
|
|
1904
|
+
{
|
|
1905
|
+
"disabled": false,
|
|
1906
|
+
"document": "Creation time, in seconds",
|
|
1907
|
+
"example": "1712049671",
|
|
1908
|
+
"member": "int64",
|
|
1909
|
+
"name": "CreatedTime",
|
|
1910
|
+
"output_required": true,
|
|
1911
|
+
"type": "int",
|
|
1912
|
+
"value_allowed_null": false
|
|
1913
|
+
},
|
|
1914
|
+
{
|
|
1915
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1916
|
+
"member": "string",
|
|
1917
|
+
"name": "RequestId",
|
|
1918
|
+
"type": "string"
|
|
1919
|
+
}
|
|
1920
|
+
],
|
|
1921
|
+
"type": "object"
|
|
1922
|
+
},
|
|
1923
|
+
"DescribeUserListRequest": {
|
|
1924
|
+
"document": "DescribeUserList request structure.",
|
|
1925
|
+
"members": [
|
|
1926
|
+
{
|
|
1927
|
+
"disabled": false,
|
|
1928
|
+
"document": "Instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
1929
|
+
"example": "mqtt-xxxx",
|
|
1930
|
+
"member": "string",
|
|
1931
|
+
"name": "InstanceId",
|
|
1932
|
+
"required": true,
|
|
1933
|
+
"type": "string"
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"disabled": false,
|
|
1937
|
+
"document": "Specifies the supported fields in the query criteria list.\nUsername: specifies the Username for filtering, supports fuzzy filtering. type: String.",
|
|
1938
|
+
"example": "[{\"Name\":\"Username\",\"Values\":[\"user1\"]}]",
|
|
1939
|
+
"member": "Filter",
|
|
1940
|
+
"name": "Filters",
|
|
1941
|
+
"required": false,
|
|
1942
|
+
"type": "list"
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"disabled": false,
|
|
1946
|
+
"document": "Query start position. default value: 0.",
|
|
1947
|
+
"example": "0",
|
|
1948
|
+
"member": "int64",
|
|
1949
|
+
"name": "Offset",
|
|
1950
|
+
"required": false,
|
|
1951
|
+
"type": "int"
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"disabled": false,
|
|
1955
|
+
"document": "Specifies the query result limit count. default value: 20. maximum value: 100.",
|
|
1956
|
+
"example": "10",
|
|
1957
|
+
"member": "int64",
|
|
1958
|
+
"name": "Limit",
|
|
1959
|
+
"required": false,
|
|
1960
|
+
"type": "int"
|
|
1961
|
+
}
|
|
1962
|
+
],
|
|
1963
|
+
"type": "object"
|
|
1964
|
+
},
|
|
1965
|
+
"DescribeUserListResponse": {
|
|
1966
|
+
"document": "DescribeUserList response structure.",
|
|
1967
|
+
"members": [
|
|
1968
|
+
{
|
|
1969
|
+
"disabled": false,
|
|
1970
|
+
"document": "Total query count",
|
|
1971
|
+
"example": "10",
|
|
1972
|
+
"member": "int64",
|
|
1973
|
+
"name": "TotalCount",
|
|
1974
|
+
"output_required": false,
|
|
1975
|
+
"type": "int",
|
|
1976
|
+
"value_allowed_null": false
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
"disabled": false,
|
|
1980
|
+
"document": "Role information list",
|
|
1981
|
+
"example": "[ \t\t\t{ \t\t\t\t\"CreatedTime\": 1705392159000, \t\t\t\t\"ModifiedTime\": 1705392159000, \t\t\t\t\"Password\": \"pwd1\", \t\t\t\t\"PermRead\": true, \t\t\t\t\"PermWrite\": true, \t\t\t\t\"Remark\": \"\", \t\t\t\t\"Username\": \"user1\" \t\t\t} \t\t]",
|
|
1982
|
+
"member": "MQTTUserItem",
|
|
1983
|
+
"name": "Data",
|
|
1984
|
+
"output_required": true,
|
|
1985
|
+
"type": "list",
|
|
1986
|
+
"value_allowed_null": false
|
|
1987
|
+
},
|
|
1988
|
+
{
|
|
1989
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1990
|
+
"member": "string",
|
|
1991
|
+
"name": "RequestId",
|
|
1992
|
+
"type": "string"
|
|
1993
|
+
}
|
|
1994
|
+
],
|
|
1995
|
+
"type": "object"
|
|
1996
|
+
},
|
|
1997
|
+
"Filter": {
|
|
1998
|
+
"document": "Query filter.",
|
|
1999
|
+
"members": [
|
|
2000
|
+
{
|
|
2001
|
+
"disabled": false,
|
|
2002
|
+
"document": "Filter criterion name",
|
|
2003
|
+
"example": "key",
|
|
2004
|
+
"member": "string",
|
|
2005
|
+
"name": "Name",
|
|
2006
|
+
"required": true,
|
|
2007
|
+
"type": "string"
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
"disabled": false,
|
|
2011
|
+
"document": "Filter criterion value",
|
|
2012
|
+
"example": "value",
|
|
2013
|
+
"member": "string",
|
|
2014
|
+
"name": "Values",
|
|
2015
|
+
"required": true,
|
|
2016
|
+
"type": "list"
|
|
2017
|
+
}
|
|
2018
|
+
],
|
|
2019
|
+
"usage": "in"
|
|
2020
|
+
},
|
|
2021
|
+
"IpRule": {
|
|
2022
|
+
"document": "IP rules",
|
|
2023
|
+
"members": [
|
|
2024
|
+
{
|
|
2025
|
+
"disabled": false,
|
|
2026
|
+
"document": "IP address.",
|
|
2027
|
+
"example": "0.0.0.0",
|
|
2028
|
+
"member": "string",
|
|
2029
|
+
"name": "Ip",
|
|
2030
|
+
"output_required": true,
|
|
2031
|
+
"required": true,
|
|
2032
|
+
"type": "string",
|
|
2033
|
+
"value_allowed_null": false
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"disabled": false,
|
|
2037
|
+
"document": "Currently only support allowed by default.",
|
|
2038
|
+
"example": "true",
|
|
2039
|
+
"member": "bool",
|
|
2040
|
+
"name": "Allow",
|
|
2041
|
+
"output_required": true,
|
|
2042
|
+
"required": true,
|
|
2043
|
+
"type": "bool",
|
|
2044
|
+
"value_allowed_null": false
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"disabled": false,
|
|
2048
|
+
"document": "Remarks",
|
|
2049
|
+
"example": "remark1",
|
|
2050
|
+
"member": "string",
|
|
2051
|
+
"name": "Remark",
|
|
2052
|
+
"output_required": true,
|
|
2053
|
+
"required": true,
|
|
2054
|
+
"type": "string",
|
|
2055
|
+
"value_allowed_null": false
|
|
2056
|
+
}
|
|
2057
|
+
],
|
|
2058
|
+
"usage": "both"
|
|
2059
|
+
},
|
|
2060
|
+
"KickOutClientRequest": {
|
|
2061
|
+
"document": "KickOutClient request structure.",
|
|
2062
|
+
"members": [
|
|
2063
|
+
{
|
|
2064
|
+
"disabled": false,
|
|
2065
|
+
"document": "Cluster ID.",
|
|
2066
|
+
"example": "mqtt-12345",
|
|
2067
|
+
"member": "string",
|
|
2068
|
+
"name": "InstanceId",
|
|
2069
|
+
"required": true,
|
|
2070
|
+
"type": "string"
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"disabled": false,
|
|
2074
|
+
"document": "Client ID.",
|
|
2075
|
+
"example": "client1",
|
|
2076
|
+
"member": "string",
|
|
2077
|
+
"name": "ClientId",
|
|
2078
|
+
"required": true,
|
|
2079
|
+
"type": "string"
|
|
2080
|
+
}
|
|
2081
|
+
],
|
|
2082
|
+
"type": "object"
|
|
2083
|
+
},
|
|
2084
|
+
"KickOutClientResponse": {
|
|
2085
|
+
"document": "KickOutClient response structure.",
|
|
2086
|
+
"members": [
|
|
2087
|
+
{
|
|
2088
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2089
|
+
"member": "string",
|
|
2090
|
+
"name": "RequestId",
|
|
2091
|
+
"type": "string"
|
|
2092
|
+
}
|
|
2093
|
+
],
|
|
2094
|
+
"type": "object"
|
|
2095
|
+
},
|
|
2096
|
+
"MQTTClientInfo": {
|
|
2097
|
+
"document": "MQTT client information.",
|
|
2098
|
+
"members": [
|
|
2099
|
+
{
|
|
2100
|
+
"disabled": false,
|
|
2101
|
+
"document": "Client ID",
|
|
2102
|
+
"example": "ClientId",
|
|
2103
|
+
"member": "string",
|
|
2104
|
+
"name": "ClientId",
|
|
2105
|
+
"output_required": false,
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"value_allowed_null": false
|
|
2108
|
+
},
|
|
2109
|
+
{
|
|
2110
|
+
"disabled": false,
|
|
2111
|
+
"document": "Client network address.",
|
|
2112
|
+
"example": "127.0.0.1:10001",
|
|
2113
|
+
"member": "string",
|
|
2114
|
+
"name": "ClientAddress",
|
|
2115
|
+
"output_required": false,
|
|
2116
|
+
"type": "string",
|
|
2117
|
+
"value_allowed_null": false
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
"disabled": false,
|
|
2121
|
+
"document": "MQTT protocol version.\n3: indicates MQTT version 3.1.\n4: indicates MQTT 3.1.1.\n5: indicates the MQTT 5.0 protocol.",
|
|
2122
|
+
"example": "4",
|
|
2123
|
+
"member": "int64",
|
|
2124
|
+
"name": "ProtocolVersion",
|
|
2125
|
+
"output_required": false,
|
|
2126
|
+
"type": "int",
|
|
2127
|
+
"value_allowed_null": false
|
|
2128
|
+
},
|
|
2129
|
+
{
|
|
2130
|
+
"disabled": false,
|
|
2131
|
+
"document": "Keep-alive duration. Unit: second.",
|
|
2132
|
+
"example": "60",
|
|
2133
|
+
"member": "int64",
|
|
2134
|
+
"name": "Keepalive",
|
|
2135
|
+
"output_required": false,
|
|
2136
|
+
"type": "int",
|
|
2137
|
+
"value_allowed_null": false
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"disabled": false,
|
|
2141
|
+
"document": "Connection status. CONNECTED: connected; DISCONNECTED: not connected.",
|
|
2142
|
+
"example": "CONNECTED",
|
|
2143
|
+
"member": "string",
|
|
2144
|
+
"name": "ConnectionStatus",
|
|
2145
|
+
"output_required": false,
|
|
2146
|
+
"type": "string",
|
|
2147
|
+
"value_allowed_null": false
|
|
2148
|
+
},
|
|
2149
|
+
{
|
|
2150
|
+
"disabled": false,
|
|
2151
|
+
"document": "Client creation time. millisecond-level timestamp.",
|
|
2152
|
+
"example": "1701396000000",
|
|
2153
|
+
"member": "int64",
|
|
2154
|
+
"name": "CreateTime",
|
|
2155
|
+
"output_required": false,
|
|
2156
|
+
"type": "int",
|
|
2157
|
+
"value_allowed_null": false
|
|
2158
|
+
},
|
|
2159
|
+
{
|
|
2160
|
+
"disabled": false,
|
|
2161
|
+
"document": "Last connection establishment time. millisecond-level timestamp.",
|
|
2162
|
+
"example": "1701396000000",
|
|
2163
|
+
"member": "int64",
|
|
2164
|
+
"name": "ConnectTime",
|
|
2165
|
+
"output_required": false,
|
|
2166
|
+
"type": "int",
|
|
2167
|
+
"value_allowed_null": false
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"disabled": false,
|
|
2171
|
+
"document": "Last disconnection time, only applicable to persistent sessions (cleanSession=false) and when the client is currently disconnected, millisecond-level timestamp.",
|
|
2172
|
+
"example": "1701403200000",
|
|
2173
|
+
"member": "int64",
|
|
2174
|
+
"name": "DisconnectTime",
|
|
2175
|
+
"output_required": false,
|
|
2176
|
+
"type": "int",
|
|
2177
|
+
"value_allowed_null": false
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
"disabled": false,
|
|
2181
|
+
"document": "Client subscription list.",
|
|
2182
|
+
"example": "无",
|
|
2183
|
+
"member": "MQTTClientSubscription",
|
|
2184
|
+
"name": "MQTTClientSubscriptions",
|
|
2185
|
+
"output_required": false,
|
|
2186
|
+
"type": "list",
|
|
2187
|
+
"value_allowed_null": false
|
|
2188
|
+
}
|
|
2189
|
+
],
|
|
2190
|
+
"usage": "out"
|
|
2191
|
+
},
|
|
2192
|
+
"MQTTClientSubscription": {
|
|
2193
|
+
"document": "MQTT subscription relationship.",
|
|
2194
|
+
"members": [
|
|
2195
|
+
{
|
|
2196
|
+
"disabled": false,
|
|
2197
|
+
"document": "Subscribed topic.",
|
|
2198
|
+
"example": "mytopic/a/+",
|
|
2199
|
+
"member": "string",
|
|
2200
|
+
"name": "TopicFilter",
|
|
2201
|
+
"output_required": false,
|
|
2202
|
+
"type": "string",
|
|
2203
|
+
"value_allowed_null": false
|
|
2204
|
+
},
|
|
2205
|
+
{
|
|
2206
|
+
"disabled": false,
|
|
2207
|
+
"document": "Service quality grade.\nUp to once.\nAt least once.\nExactly once.",
|
|
2208
|
+
"example": "1",
|
|
2209
|
+
"member": "int64",
|
|
2210
|
+
"name": "Qos",
|
|
2211
|
+
"output_required": false,
|
|
2212
|
+
"type": "int",
|
|
2213
|
+
"value_allowed_null": false
|
|
2214
|
+
},
|
|
2215
|
+
{
|
|
2216
|
+
"disabled": false,
|
|
2217
|
+
"document": "Indicates the heaped messages.",
|
|
2218
|
+
"example": "0",
|
|
2219
|
+
"member": "int64",
|
|
2220
|
+
"name": "Lag",
|
|
2221
|
+
"output_required": false,
|
|
2222
|
+
"type": "int",
|
|
2223
|
+
"value_allowed_null": false
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
"disabled": false,
|
|
2227
|
+
"document": "Unconfirmed delivery count.",
|
|
2228
|
+
"example": "0",
|
|
2229
|
+
"member": "int64",
|
|
2230
|
+
"name": "Inflight",
|
|
2231
|
+
"output_required": false,
|
|
2232
|
+
"type": "int",
|
|
2233
|
+
"value_allowed_null": false
|
|
2234
|
+
},
|
|
2235
|
+
{
|
|
2236
|
+
"disabled": false,
|
|
2237
|
+
"document": "Describes the user attribute.",
|
|
2238
|
+
"example": "无",
|
|
2239
|
+
"member": "SubscriptionUserProperty",
|
|
2240
|
+
"name": "UserProperties",
|
|
2241
|
+
"output_required": false,
|
|
2242
|
+
"type": "list",
|
|
2243
|
+
"value_allowed_null": false
|
|
2244
|
+
}
|
|
2245
|
+
],
|
|
2246
|
+
"usage": "out"
|
|
2247
|
+
},
|
|
2248
|
+
"MQTTMessage": {
|
|
2249
|
+
"document": "MQTT message.",
|
|
2250
|
+
"members": [
|
|
2251
|
+
{
|
|
2252
|
+
"disabled": false,
|
|
2253
|
+
"document": "Message ID",
|
|
2254
|
+
"example": "15397032005D639FEE4879C38A130016",
|
|
2255
|
+
"member": "string",
|
|
2256
|
+
"name": "MessageId",
|
|
2257
|
+
"output_required": true,
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"value_allowed_null": false
|
|
2260
|
+
},
|
|
2261
|
+
{
|
|
2262
|
+
"disabled": false,
|
|
2263
|
+
"document": "Client Id of the message sender.",
|
|
2264
|
+
"example": "client-1",
|
|
2265
|
+
"member": "string",
|
|
2266
|
+
"name": "ClientId",
|
|
2267
|
+
"output_required": true,
|
|
2268
|
+
"type": "string",
|
|
2269
|
+
"value_allowed_null": false
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
"disabled": false,
|
|
2273
|
+
"document": "Message service quality grade.",
|
|
2274
|
+
"example": "1",
|
|
2275
|
+
"member": "string",
|
|
2276
|
+
"name": "Qos",
|
|
2277
|
+
"output_required": true,
|
|
2278
|
+
"type": "string",
|
|
2279
|
+
"value_allowed_null": false
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
"disabled": false,
|
|
2283
|
+
"document": "Message storage time on the server. millisecond-level timestamp.",
|
|
2284
|
+
"example": "1745828681259",
|
|
2285
|
+
"member": "int64",
|
|
2286
|
+
"name": "StoreTimestamp",
|
|
2287
|
+
"output_required": true,
|
|
2288
|
+
"type": "int",
|
|
2289
|
+
"value_allowed_null": false
|
|
2290
|
+
},
|
|
2291
|
+
{
|
|
2292
|
+
"disabled": false,
|
|
2293
|
+
"document": "Specifies the source topic.",
|
|
2294
|
+
"example": "home/room",
|
|
2295
|
+
"member": "string",
|
|
2296
|
+
"name": "OriginTopic",
|
|
2297
|
+
"output_required": true,
|
|
2298
|
+
"type": "string",
|
|
2299
|
+
"value_allowed_null": false
|
|
2300
|
+
}
|
|
2301
|
+
],
|
|
2302
|
+
"usage": "out"
|
|
2303
|
+
},
|
|
2304
|
+
"MQTTUserItem": {
|
|
2305
|
+
"document": "MQTT cluster user information.",
|
|
2306
|
+
"members": [
|
|
2307
|
+
{
|
|
2308
|
+
"disabled": false,
|
|
2309
|
+
"document": "Username.",
|
|
2310
|
+
"example": "user1",
|
|
2311
|
+
"member": "string",
|
|
2312
|
+
"name": "Username",
|
|
2313
|
+
"output_required": true,
|
|
2314
|
+
"type": "string",
|
|
2315
|
+
"value_allowed_null": false
|
|
2316
|
+
},
|
|
2317
|
+
{
|
|
2318
|
+
"disabled": false,
|
|
2319
|
+
"document": "Password.",
|
|
2320
|
+
"example": "pd",
|
|
2321
|
+
"member": "string",
|
|
2322
|
+
"name": "Password",
|
|
2323
|
+
"output_required": true,
|
|
2324
|
+
"type": "string",
|
|
2325
|
+
"value_allowed_null": false
|
|
2326
|
+
},
|
|
2327
|
+
{
|
|
2328
|
+
"disabled": false,
|
|
2329
|
+
"document": "Remarks",
|
|
2330
|
+
"example": "remark1",
|
|
2331
|
+
"member": "string",
|
|
2332
|
+
"name": "Remark",
|
|
2333
|
+
"output_required": true,
|
|
2334
|
+
"type": "string",
|
|
2335
|
+
"value_allowed_null": false
|
|
2336
|
+
},
|
|
2337
|
+
{
|
|
2338
|
+
"disabled": false,
|
|
2339
|
+
"document": "Creation time. millisecond-level timestamp.",
|
|
2340
|
+
"example": "1712739629775",
|
|
2341
|
+
"member": "int64",
|
|
2342
|
+
"name": "CreatedTime",
|
|
2343
|
+
"output_required": true,
|
|
2344
|
+
"type": "int",
|
|
2345
|
+
"value_allowed_null": false
|
|
2346
|
+
},
|
|
2347
|
+
{
|
|
2348
|
+
"disabled": false,
|
|
2349
|
+
"document": "Modification time. millisecond-level timestamp.",
|
|
2350
|
+
"example": "1712739629775",
|
|
2351
|
+
"member": "int64",
|
|
2352
|
+
"name": "ModifiedTime",
|
|
2353
|
+
"output_required": true,
|
|
2354
|
+
"type": "int",
|
|
2355
|
+
"value_allowed_null": false
|
|
2356
|
+
}
|
|
2357
|
+
],
|
|
2358
|
+
"usage": "out"
|
|
2359
|
+
},
|
|
2360
|
+
"MessageEnrichmentRuleItem": {
|
|
2361
|
+
"document": "MessageEnrichmentRuleItem",
|
|
2362
|
+
"members": [
|
|
2363
|
+
{
|
|
2364
|
+
"disabled": false,
|
|
2365
|
+
"document": "Rule ID.",
|
|
2366
|
+
"example": "1",
|
|
2367
|
+
"member": "int64",
|
|
2368
|
+
"name": "Id",
|
|
2369
|
+
"output_required": true,
|
|
2370
|
+
"type": "int",
|
|
2371
|
+
"value_allowed_null": false
|
|
2372
|
+
},
|
|
2373
|
+
{
|
|
2374
|
+
"disabled": false,
|
|
2375
|
+
"document": "MQTT cluster ID.",
|
|
2376
|
+
"example": "mqtt-xxx",
|
|
2377
|
+
"member": "string",
|
|
2378
|
+
"name": "InstanceId",
|
|
2379
|
+
"output_required": true,
|
|
2380
|
+
"type": "string",
|
|
2381
|
+
"value_allowed_null": false
|
|
2382
|
+
},
|
|
2383
|
+
{
|
|
2384
|
+
"disabled": false,
|
|
2385
|
+
"document": "Specifies the rule name.",
|
|
2386
|
+
"example": "rule1",
|
|
2387
|
+
"member": "string",
|
|
2388
|
+
"name": "RuleName",
|
|
2389
|
+
"output_required": true,
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"value_allowed_null": false
|
|
2392
|
+
},
|
|
2393
|
+
{
|
|
2394
|
+
"disabled": false,
|
|
2395
|
+
"document": "Rule matching conditions, in JSON format, must be Base64-encoded. \nSpecifies the client id, username, and topic. example: {\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"}.\nSpecifies the Base64-encoded string \"eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9\".",
|
|
2396
|
+
"example": "{\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"}",
|
|
2397
|
+
"member": "string",
|
|
2398
|
+
"name": "Condition",
|
|
2399
|
+
"output_required": false,
|
|
2400
|
+
"type": "string",
|
|
2401
|
+
"value_allowed_null": false
|
|
2402
|
+
},
|
|
2403
|
+
{
|
|
2404
|
+
"disabled": false,
|
|
2405
|
+
"document": "Specifies the action of rule execution in JSON format, which must be Base64 encoded.\n Creating a Billing Resource Order\n{\"messageExpiryInterval\":360,\"response Topic\":\"replies/devices/${clientid}\",\"correlationData\":\"${traceid}\",\"userProperty\":[{\"key\":\"trace-id\",\"value\":\"${traceid}\"},{\"key\":\"data-source\",\"value\":\"rule-engine\"}]}\nSpecifies the BASE64-encoded string \"eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2UgVG9waWMiOiJyZXBsaWVzL2RldmljZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9LHsia2V5IjoiZGF0YS1zb3VyY2UiLCJ2YWx1ZSI6InJ1bGUtZW5naW5lIn1dfQ==\".",
|
|
2406
|
+
"example": "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2UgVG9waWMiOiJyZXBsaWVzL2RldmljZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=",
|
|
2407
|
+
"member": "string",
|
|
2408
|
+
"name": "Actions",
|
|
2409
|
+
"output_required": false,
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"value_allowed_null": false
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
"disabled": false,
|
|
2415
|
+
"document": "Rule priority. a smaller number indicates a higher priority. high priority overrides low priority. the UserProperty field will be merged.",
|
|
2416
|
+
"example": "1",
|
|
2417
|
+
"member": "int64",
|
|
2418
|
+
"name": "Priority",
|
|
2419
|
+
"output_required": true,
|
|
2420
|
+
"type": "int",
|
|
2421
|
+
"value_allowed_null": false
|
|
2422
|
+
},
|
|
2423
|
+
{
|
|
2424
|
+
"disabled": false,
|
|
2425
|
+
"document": "Rule status. valid values: 0 (undefined), 1 (activate), 2 (deactivate). default: deactivate.",
|
|
2426
|
+
"example": "1",
|
|
2427
|
+
"member": "int64",
|
|
2428
|
+
"name": "Status",
|
|
2429
|
+
"output_required": true,
|
|
2430
|
+
"type": "int",
|
|
2431
|
+
"value_allowed_null": false
|
|
2432
|
+
},
|
|
2433
|
+
{
|
|
2434
|
+
"disabled": false,
|
|
2435
|
+
"document": "Remarks",
|
|
2436
|
+
"example": "remark",
|
|
2437
|
+
"member": "string",
|
|
2438
|
+
"name": "Remark",
|
|
2439
|
+
"output_required": true,
|
|
2440
|
+
"type": "string",
|
|
2441
|
+
"value_allowed_null": false
|
|
2442
|
+
},
|
|
2443
|
+
{
|
|
2444
|
+
"disabled": false,
|
|
2445
|
+
"document": "Creation time. millisecond-level timestamp.",
|
|
2446
|
+
"example": "1713164969433",
|
|
2447
|
+
"member": "int64",
|
|
2448
|
+
"name": "CreatedTime",
|
|
2449
|
+
"output_required": true,
|
|
2450
|
+
"type": "int",
|
|
2451
|
+
"value_allowed_null": false
|
|
2452
|
+
},
|
|
2453
|
+
{
|
|
2454
|
+
"disabled": false,
|
|
2455
|
+
"document": "Update time. millisecond-level timestamp.",
|
|
2456
|
+
"example": "1713164969433",
|
|
2457
|
+
"member": "int64",
|
|
2458
|
+
"name": "UpdateTime",
|
|
2459
|
+
"output_required": true,
|
|
2460
|
+
"type": "int",
|
|
2461
|
+
"value_allowed_null": false
|
|
2462
|
+
}
|
|
2463
|
+
],
|
|
2464
|
+
"usage": "out"
|
|
2465
|
+
},
|
|
2466
|
+
"MessageEnrichmentRulePriority": {
|
|
2467
|
+
"document": "Message enrichment rule priority.",
|
|
2468
|
+
"members": [
|
|
2469
|
+
{
|
|
2470
|
+
"disabled": false,
|
|
2471
|
+
"document": "Message enrichment rule id.",
|
|
2472
|
+
"example": "1",
|
|
2473
|
+
"member": "int64",
|
|
2474
|
+
"name": "Id",
|
|
2475
|
+
"required": true,
|
|
2476
|
+
"type": "int"
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"disabled": false,
|
|
2480
|
+
"document": "Priority",
|
|
2481
|
+
"example": "1",
|
|
2482
|
+
"member": "int64",
|
|
2483
|
+
"name": "Priority",
|
|
2484
|
+
"required": true,
|
|
2485
|
+
"type": "int"
|
|
2486
|
+
}
|
|
2487
|
+
],
|
|
2488
|
+
"usage": "in"
|
|
2489
|
+
},
|
|
2490
|
+
"ModifyAuthorizationPolicyRequest": {
|
|
2491
|
+
"document": "ModifyAuthorizationPolicy request structure.",
|
|
2492
|
+
"members": [
|
|
2493
|
+
{
|
|
2494
|
+
"disabled": false,
|
|
2495
|
+
"document": "Specifies the authorization policy ID, which can be obtained from the query authorization policy API (https://www.tencentcloud.com/document/product/1778/111074?from_cn_redirect=1).",
|
|
2496
|
+
"example": "1",
|
|
2497
|
+
"member": "int64",
|
|
2498
|
+
"name": "Id",
|
|
2499
|
+
"required": true,
|
|
2500
|
+
"type": "int"
|
|
2501
|
+
},
|
|
2502
|
+
{
|
|
2503
|
+
"disabled": false,
|
|
2504
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.\n",
|
|
2505
|
+
"example": "mqtt-xxxx",
|
|
2506
|
+
"member": "string",
|
|
2507
|
+
"name": "InstanceId",
|
|
2508
|
+
"required": true,
|
|
2509
|
+
"type": "string"
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"disabled": false,
|
|
2513
|
+
"document": "Policy name, which cannot be empty, contains 3 to 64 characters, and supports chinese, letters, digits, \"-\", and \"_\".",
|
|
2514
|
+
"example": "name",
|
|
2515
|
+
"member": "string",
|
|
2516
|
+
"name": "PolicyName",
|
|
2517
|
+
"required": false,
|
|
2518
|
+
"type": "string"
|
|
2519
|
+
},
|
|
2520
|
+
{
|
|
2521
|
+
"disabled": false,
|
|
2522
|
+
"document": "Policy version, defaults to 1. currently only support 1.",
|
|
2523
|
+
"example": "1",
|
|
2524
|
+
"member": "int64",
|
|
2525
|
+
"name": "PolicyVersion",
|
|
2526
|
+
"required": false,
|
|
2527
|
+
"type": "int"
|
|
2528
|
+
},
|
|
2529
|
+
{
|
|
2530
|
+
"disabled": false,
|
|
2531
|
+
"document": "Policy priority. a smaller value indicates a higher priority. must be unique.",
|
|
2532
|
+
"example": "1",
|
|
2533
|
+
"member": "int64",
|
|
2534
|
+
"name": "Priority",
|
|
2535
|
+
"required": false,
|
|
2536
|
+
"type": "int"
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
"disabled": false,
|
|
2540
|
+
"document": "Specifies the decision.\nallow. specifies the permission.\nDenies.",
|
|
2541
|
+
"example": "allow",
|
|
2542
|
+
"member": "string",
|
|
2543
|
+
"name": "Effect",
|
|
2544
|
+
"required": false,
|
|
2545
|
+
"type": "string"
|
|
2546
|
+
},
|
|
2547
|
+
{
|
|
2548
|
+
"disabled": false,
|
|
2549
|
+
"document": "Operation, supports multiple selections separated by commas. see the data plane policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\nSpecifies the connection.\nSpecifies the publish action.\nSub. specifies the subscription.",
|
|
2550
|
+
"example": "connect",
|
|
2551
|
+
"member": "string",
|
|
2552
|
+
"name": "Actions",
|
|
2553
|
+
"required": false,
|
|
2554
|
+
"type": "string"
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"disabled": false,
|
|
2558
|
+
"document": "Specifies the resource and subscription to match. supports configuration of multiple match rules, separated by commas. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).\n",
|
|
2559
|
+
"example": "topic1",
|
|
2560
|
+
"member": "string",
|
|
2561
|
+
"name": "Resources",
|
|
2562
|
+
"required": false,
|
|
2563
|
+
"type": "string"
|
|
2564
|
+
},
|
|
2565
|
+
{
|
|
2566
|
+
"disabled": false,
|
|
2567
|
+
"document": "Specifies the condition-username.",
|
|
2568
|
+
"example": "user1",
|
|
2569
|
+
"member": "string",
|
|
2570
|
+
"name": "Username",
|
|
2571
|
+
"required": false,
|
|
2572
|
+
"type": "string"
|
|
2573
|
+
},
|
|
2574
|
+
{
|
|
2575
|
+
"disabled": false,
|
|
2576
|
+
"document": "Condition - message retention.\nMatches message retention.\nMatches non-retention messages.\n3. match retained and non-retained messages.",
|
|
2577
|
+
"example": "1",
|
|
2578
|
+
"member": "int64",
|
|
2579
|
+
"name": "Retain",
|
|
2580
|
+
"required": false,
|
|
2581
|
+
"type": "int"
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
"disabled": false,
|
|
2585
|
+
"document": "Client ID. supports regular expressions.",
|
|
2586
|
+
"example": "client1",
|
|
2587
|
+
"member": "string",
|
|
2588
|
+
"name": "ClientId",
|
|
2589
|
+
"required": false,
|
|
2590
|
+
"type": "string"
|
|
2591
|
+
},
|
|
2592
|
+
{
|
|
2593
|
+
"disabled": false,
|
|
2594
|
+
"document": "Condition: client IP address. supports IP or CIDR.",
|
|
2595
|
+
"example": "127.0.0.1",
|
|
2596
|
+
"member": "string",
|
|
2597
|
+
"name": "Ip",
|
|
2598
|
+
"required": false,
|
|
2599
|
+
"type": "string"
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"disabled": false,
|
|
2603
|
+
"document": "Condition: specifies the service quality.\n0: at most once.\nMinimum once.\n2: exactly once.",
|
|
2604
|
+
"example": "1",
|
|
2605
|
+
"member": "string",
|
|
2606
|
+
"name": "Qos",
|
|
2607
|
+
"required": false,
|
|
2608
|
+
"type": "string"
|
|
2609
|
+
},
|
|
2610
|
+
{
|
|
2611
|
+
"disabled": false,
|
|
2612
|
+
"document": "Specifies the remark information with a maximum length of 128 characters.",
|
|
2613
|
+
"example": "remark",
|
|
2614
|
+
"member": "string",
|
|
2615
|
+
"name": "Remark",
|
|
2616
|
+
"required": false,
|
|
2617
|
+
"type": "string"
|
|
2618
|
+
}
|
|
2619
|
+
],
|
|
2620
|
+
"type": "object"
|
|
2621
|
+
},
|
|
2622
|
+
"ModifyAuthorizationPolicyResponse": {
|
|
2623
|
+
"document": "ModifyAuthorizationPolicy response structure.",
|
|
2624
|
+
"members": [
|
|
2625
|
+
{
|
|
2626
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2627
|
+
"member": "string",
|
|
2628
|
+
"name": "RequestId",
|
|
2629
|
+
"type": "string"
|
|
2630
|
+
}
|
|
2631
|
+
],
|
|
2632
|
+
"type": "object"
|
|
2633
|
+
},
|
|
2634
|
+
"ModifyInstanceRequest": {
|
|
2635
|
+
"document": "ModifyInstance request structure.",
|
|
2636
|
+
"members": [
|
|
2637
|
+
{
|
|
2638
|
+
"disabled": false,
|
|
2639
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
2640
|
+
"example": "mqtt-xxxx",
|
|
2641
|
+
"member": "string",
|
|
2642
|
+
"name": "InstanceId",
|
|
2643
|
+
"required": true,
|
|
2644
|
+
"type": "string"
|
|
2645
|
+
},
|
|
2646
|
+
{
|
|
2647
|
+
"disabled": false,
|
|
2648
|
+
"document": "Specifies the instance name to be modified, cannot be empty, 3-64 characters, only comprised of digits, letters, \"-\", and \"_\".",
|
|
2649
|
+
"example": "instance1",
|
|
2650
|
+
"member": "string",
|
|
2651
|
+
"name": "Name",
|
|
2652
|
+
"required": false,
|
|
2653
|
+
"type": "string"
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
"disabled": false,
|
|
2657
|
+
"document": "Specifies the remark information to be modified, with a maximum of 128 characters.",
|
|
2658
|
+
"example": "remark",
|
|
2659
|
+
"member": "string",
|
|
2660
|
+
"name": "Remark",
|
|
2661
|
+
"required": false,
|
|
2662
|
+
"type": "string"
|
|
2663
|
+
},
|
|
2664
|
+
{
|
|
2665
|
+
"disabled": false,
|
|
2666
|
+
"document": "Specifies the configuration specification to be changed.\nBasic version and professional edition clusters cannot be upgraded to platinum version specifications. platinum edition clusters cannot be downgraded to basic version and enhanced specifications.",
|
|
2667
|
+
"example": "pro_10k_1",
|
|
2668
|
+
"member": "string",
|
|
2669
|
+
"name": "SkuCode",
|
|
2670
|
+
"required": false,
|
|
2671
|
+
"type": "string"
|
|
2672
|
+
},
|
|
2673
|
+
{
|
|
2674
|
+
"disabled": true,
|
|
2675
|
+
"document": "Specifies the registration method for the client certificate.\nJITP: automatically register.\nAPI: register manually through api.",
|
|
2676
|
+
"example": "JITP",
|
|
2677
|
+
"member": "string",
|
|
2678
|
+
"name": "DeviceCertificateProvisionType",
|
|
2679
|
+
"required": false,
|
|
2680
|
+
"type": "string"
|
|
2681
|
+
},
|
|
2682
|
+
{
|
|
2683
|
+
"disabled": true,
|
|
2684
|
+
"document": "Specifies whether to automatically activate the cert after automatic registration.",
|
|
2685
|
+
"example": "false",
|
|
2686
|
+
"member": "bool",
|
|
2687
|
+
"name": "AutomaticActivation",
|
|
2688
|
+
"required": false,
|
|
2689
|
+
"type": "bool"
|
|
2690
|
+
},
|
|
2691
|
+
{
|
|
2692
|
+
"disabled": false,
|
|
2693
|
+
"document": "Authorization policy switch.",
|
|
2694
|
+
"example": "false",
|
|
2695
|
+
"member": "bool",
|
|
2696
|
+
"name": "AuthorizationPolicy",
|
|
2697
|
+
"required": false,
|
|
2698
|
+
"type": "bool"
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"disabled": false,
|
|
2702
|
+
"document": "Specifies whether to use the default server certificate.",
|
|
2703
|
+
"example": "false",
|
|
2704
|
+
"member": "bool",
|
|
2705
|
+
"name": "UseDefaultServerCert",
|
|
2706
|
+
"required": false,
|
|
2707
|
+
"type": "bool"
|
|
2708
|
+
},
|
|
2709
|
+
{
|
|
2710
|
+
"disabled": false,
|
|
2711
|
+
"document": "TLS: one-way authentication.\nmTLS. specifies mutual authentication.\nBYOC: one device, one certificate.",
|
|
2712
|
+
"example": "BYOC",
|
|
2713
|
+
"member": "string",
|
|
2714
|
+
"name": "X509Mode",
|
|
2715
|
+
"required": false,
|
|
2716
|
+
"type": "string"
|
|
2717
|
+
},
|
|
2718
|
+
{
|
|
2719
|
+
"disabled": false,
|
|
2720
|
+
"document": "Specifies the speed limit unit for client message send and receive in messages per second.",
|
|
2721
|
+
"example": "10",
|
|
2722
|
+
"member": "int64",
|
|
2723
|
+
"name": "MessageRate",
|
|
2724
|
+
"required": false,
|
|
2725
|
+
"type": "int"
|
|
2726
|
+
}
|
|
2727
|
+
],
|
|
2728
|
+
"type": "object"
|
|
2729
|
+
},
|
|
2730
|
+
"ModifyInstanceResponse": {
|
|
2731
|
+
"document": "ModifyInstance response structure.",
|
|
2732
|
+
"members": [
|
|
2733
|
+
{
|
|
2734
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2735
|
+
"member": "string",
|
|
2736
|
+
"name": "RequestId",
|
|
2737
|
+
"type": "string"
|
|
2738
|
+
}
|
|
2739
|
+
],
|
|
2740
|
+
"type": "object"
|
|
2741
|
+
},
|
|
2742
|
+
"ModifyMessageEnrichmentRuleRequest": {
|
|
2743
|
+
"document": "ModifyMessageEnrichmentRule request structure.",
|
|
2744
|
+
"members": [
|
|
2745
|
+
{
|
|
2746
|
+
"disabled": false,
|
|
2747
|
+
"document": "Message enrichment rule ID.",
|
|
2748
|
+
"example": "1",
|
|
2749
|
+
"member": "int64",
|
|
2750
|
+
"name": "Id",
|
|
2751
|
+
"required": true,
|
|
2752
|
+
"type": "int"
|
|
2753
|
+
},
|
|
2754
|
+
{
|
|
2755
|
+
"disabled": false,
|
|
2756
|
+
"document": "Tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.\n",
|
|
2757
|
+
"example": "mqtt-xxxx",
|
|
2758
|
+
"member": "string",
|
|
2759
|
+
"name": "InstanceId",
|
|
2760
|
+
"required": true,
|
|
2761
|
+
"type": "string"
|
|
2762
|
+
},
|
|
2763
|
+
{
|
|
2764
|
+
"disabled": false,
|
|
2765
|
+
"document": "Rule name, which cannot be empty, contains 3 to 64 characters, and supports chinese, letters, digits, \"-\", and \"_\".",
|
|
2766
|
+
"example": "rule1",
|
|
2767
|
+
"member": "string",
|
|
2768
|
+
"name": "RuleName",
|
|
2769
|
+
"required": false,
|
|
2770
|
+
"type": "string"
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"disabled": false,
|
|
2774
|
+
"document": "Rule matching conditions in JSON format, Base64 encoding is required.\nCreating a Billing Resource Order\n{\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"}\nSpecifies the Base64-encoded content.\neyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
|
|
2775
|
+
"example": "eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
|
|
2776
|
+
"member": "string",
|
|
2777
|
+
"name": "Condition",
|
|
2778
|
+
"required": false,
|
|
2779
|
+
"type": "string"
|
|
2780
|
+
},
|
|
2781
|
+
{
|
|
2782
|
+
"disabled": false,
|
|
2783
|
+
"document": "Specifies the action of rule execution in JSON format, which must be Base64 encoded. \nCreating a Billing Resource Order\n{\"messageExpiryInterval\":360,\"responseTopic\":\"replies/${clientid}\",\"correlationData\":\"${traceid}\",\"userProperty\":[{\"key\":\"trace-id\",\"value\":\"${traceid}\"}]}\nSpecifies the BASE64-encoded string eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=.",
|
|
2784
|
+
"example": "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=",
|
|
2785
|
+
"member": "string",
|
|
2786
|
+
"name": "Actions",
|
|
2787
|
+
"required": false,
|
|
2788
|
+
"type": "string"
|
|
2789
|
+
},
|
|
2790
|
+
{
|
|
2791
|
+
"disabled": false,
|
|
2792
|
+
"document": "Rule priority. a smaller number indicates a higher priority. high priority overrides low priority. the UserProperty field will be merged.",
|
|
2793
|
+
"example": "1",
|
|
2794
|
+
"member": "int64",
|
|
2795
|
+
"name": "Priority",
|
|
2796
|
+
"required": false,
|
|
2797
|
+
"type": "int"
|
|
2798
|
+
},
|
|
2799
|
+
{
|
|
2800
|
+
"disabled": false,
|
|
2801
|
+
"document": "Rule status. valid values: 0 (undefined), 1 (activate), 2 (deactivate). default: deactivate.",
|
|
2802
|
+
"example": "1",
|
|
2803
|
+
"member": "int64",
|
|
2804
|
+
"name": "Status",
|
|
2805
|
+
"required": false,
|
|
2806
|
+
"type": "int"
|
|
2807
|
+
},
|
|
2808
|
+
{
|
|
2809
|
+
"disabled": false,
|
|
2810
|
+
"document": "Specifies the remark information with a maximum length of 128 characters.",
|
|
2811
|
+
"example": "remark",
|
|
2812
|
+
"member": "string",
|
|
2813
|
+
"name": "Remark",
|
|
2814
|
+
"required": false,
|
|
2815
|
+
"type": "string"
|
|
2816
|
+
}
|
|
2817
|
+
],
|
|
2818
|
+
"type": "object"
|
|
2819
|
+
},
|
|
2820
|
+
"ModifyMessageEnrichmentRuleResponse": {
|
|
2821
|
+
"document": "ModifyMessageEnrichmentRule response structure.",
|
|
2822
|
+
"members": [
|
|
2823
|
+
{
|
|
2824
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2825
|
+
"member": "string",
|
|
2826
|
+
"name": "RequestId",
|
|
2827
|
+
"type": "string"
|
|
2828
|
+
}
|
|
2829
|
+
],
|
|
2830
|
+
"type": "object"
|
|
2831
|
+
},
|
|
2832
|
+
"ModifyUserRequest": {
|
|
2833
|
+
"document": "ModifyUser request structure.",
|
|
2834
|
+
"members": [
|
|
2835
|
+
{
|
|
2836
|
+
"disabled": false,
|
|
2837
|
+
"document": "Instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
2838
|
+
"example": "mqtt-xxxx",
|
|
2839
|
+
"member": "string",
|
|
2840
|
+
"name": "InstanceId",
|
|
2841
|
+
"required": true,
|
|
2842
|
+
"type": "string"
|
|
2843
|
+
},
|
|
2844
|
+
{
|
|
2845
|
+
"disabled": false,
|
|
2846
|
+
"document": "Username.",
|
|
2847
|
+
"example": "user",
|
|
2848
|
+
"member": "string",
|
|
2849
|
+
"name": "Username",
|
|
2850
|
+
"required": true,
|
|
2851
|
+
"type": "string"
|
|
2852
|
+
},
|
|
2853
|
+
{
|
|
2854
|
+
"disabled": false,
|
|
2855
|
+
"document": "Specifies the remark with length not exceeding 128 characters.",
|
|
2856
|
+
"example": "remark",
|
|
2857
|
+
"member": "string",
|
|
2858
|
+
"name": "Remark",
|
|
2859
|
+
"required": false,
|
|
2860
|
+
"type": "string"
|
|
2861
|
+
}
|
|
2862
|
+
],
|
|
2863
|
+
"type": "object"
|
|
2864
|
+
},
|
|
2865
|
+
"ModifyUserResponse": {
|
|
2866
|
+
"document": "ModifyUser response structure.",
|
|
2867
|
+
"members": [
|
|
2868
|
+
{
|
|
2869
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2870
|
+
"member": "string",
|
|
2871
|
+
"name": "RequestId",
|
|
2872
|
+
"type": "string"
|
|
2873
|
+
}
|
|
2874
|
+
],
|
|
2875
|
+
"type": "object"
|
|
2876
|
+
},
|
|
2877
|
+
"SubscriptionUserProperty": {
|
|
2878
|
+
"document": "Subscribed UserProperty structure.",
|
|
2879
|
+
"members": [
|
|
2880
|
+
{
|
|
2881
|
+
"disabled": false,
|
|
2882
|
+
"document": "Specifies the key of the UserProperty for subscription.",
|
|
2883
|
+
"example": "UserProperty-key",
|
|
2884
|
+
"member": "string",
|
|
2885
|
+
"name": "Key",
|
|
2886
|
+
"output_required": false,
|
|
2887
|
+
"type": "string",
|
|
2888
|
+
"value_allowed_null": false
|
|
2889
|
+
},
|
|
2890
|
+
{
|
|
2891
|
+
"disabled": false,
|
|
2892
|
+
"document": "Specifies the value of the UserProperty for subscription.",
|
|
2893
|
+
"example": "UserProperty-value",
|
|
2894
|
+
"member": "string",
|
|
2895
|
+
"name": "Value",
|
|
2896
|
+
"output_required": false,
|
|
2897
|
+
"type": "string",
|
|
2898
|
+
"value_allowed_null": false
|
|
2899
|
+
}
|
|
2900
|
+
],
|
|
2901
|
+
"usage": "out"
|
|
2902
|
+
},
|
|
2903
|
+
"Tag": {
|
|
2904
|
+
"document": "Tag data",
|
|
2905
|
+
"members": [
|
|
2906
|
+
{
|
|
2907
|
+
"disabled": false,
|
|
2908
|
+
"document": "Tag name.",
|
|
2909
|
+
"example": "tag-key",
|
|
2910
|
+
"member": "string",
|
|
2911
|
+
"name": "TagKey",
|
|
2912
|
+
"output_required": true,
|
|
2913
|
+
"required": true,
|
|
2914
|
+
"type": "string",
|
|
2915
|
+
"value_allowed_null": false
|
|
2916
|
+
},
|
|
2917
|
+
{
|
|
2918
|
+
"disabled": false,
|
|
2919
|
+
"document": "Tag value",
|
|
2920
|
+
"example": "tag-value",
|
|
2921
|
+
"member": "string",
|
|
2922
|
+
"name": "TagValue",
|
|
2923
|
+
"output_required": true,
|
|
2924
|
+
"required": true,
|
|
2925
|
+
"type": "string",
|
|
2926
|
+
"value_allowed_null": false
|
|
2927
|
+
}
|
|
2928
|
+
],
|
|
2929
|
+
"usage": "both"
|
|
2930
|
+
},
|
|
2931
|
+
"UpdateAuthorizationPolicyPriorityRequest": {
|
|
2932
|
+
"document": "UpdateAuthorizationPolicyPriority request structure.",
|
|
2933
|
+
"members": [
|
|
2934
|
+
{
|
|
2935
|
+
"disabled": false,
|
|
2936
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
2937
|
+
"example": "mqtt-xxxx",
|
|
2938
|
+
"member": "string",
|
|
2939
|
+
"name": "InstanceId",
|
|
2940
|
+
"required": true,
|
|
2941
|
+
"type": "string"
|
|
2942
|
+
},
|
|
2943
|
+
{
|
|
2944
|
+
"disabled": false,
|
|
2945
|
+
"document": "Policy ID and priority.",
|
|
2946
|
+
"example": "[ \t\t{ \t\t\t\"Id\": 1, \t\t\t\"Priority\": 3 \t\t}, \t\t{ \t\t\t\"Id\": 6, \t\t\t\"Priority\": 1 \t\t}, \t\t{ \t\t\t\"Id\": 7, \t\t\t\"Priority\": 2 \t\t} \t]",
|
|
2947
|
+
"member": "AuthorizationPolicyPriority",
|
|
2948
|
+
"name": "Priorities",
|
|
2949
|
+
"required": false,
|
|
2950
|
+
"type": "list"
|
|
2951
|
+
}
|
|
2952
|
+
],
|
|
2953
|
+
"type": "object"
|
|
2954
|
+
},
|
|
2955
|
+
"UpdateAuthorizationPolicyPriorityResponse": {
|
|
2956
|
+
"document": "UpdateAuthorizationPolicyPriority response structure.",
|
|
2957
|
+
"members": [
|
|
2958
|
+
{
|
|
2959
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2960
|
+
"member": "string",
|
|
2961
|
+
"name": "RequestId",
|
|
2962
|
+
"type": "string"
|
|
2963
|
+
}
|
|
2964
|
+
],
|
|
2965
|
+
"type": "object"
|
|
2966
|
+
},
|
|
2967
|
+
"UpdateMessageEnrichmentRulePriorityRequest": {
|
|
2968
|
+
"document": "UpdateMessageEnrichmentRulePriority request structure.",
|
|
2969
|
+
"members": [
|
|
2970
|
+
{
|
|
2971
|
+
"disabled": false,
|
|
2972
|
+
"document": "tencent cloud MQTT instance ID, obtained from the [DescribeInstanceList](https://www.tencentcloud.com/document/api/1778/111029?from_cn_redirect=1) api or console.",
|
|
2973
|
+
"example": "mqtt-x",
|
|
2974
|
+
"member": "string",
|
|
2975
|
+
"name": "InstanceId",
|
|
2976
|
+
"required": true,
|
|
2977
|
+
"type": "string"
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"disabled": false,
|
|
2981
|
+
"document": "Policy ID and priority.",
|
|
2982
|
+
"example": "无",
|
|
2983
|
+
"member": "MessageEnrichmentRulePriority",
|
|
2984
|
+
"name": "Priorities",
|
|
2985
|
+
"required": false,
|
|
2986
|
+
"type": "list"
|
|
2987
|
+
}
|
|
2988
|
+
],
|
|
2989
|
+
"type": "object"
|
|
2990
|
+
},
|
|
2991
|
+
"UpdateMessageEnrichmentRulePriorityResponse": {
|
|
2992
|
+
"document": "UpdateMessageEnrichmentRulePriority response structure.",
|
|
2993
|
+
"members": [
|
|
2994
|
+
{
|
|
2995
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2996
|
+
"member": "string",
|
|
2997
|
+
"name": "RequestId",
|
|
2998
|
+
"type": "string"
|
|
2999
|
+
}
|
|
3000
|
+
],
|
|
3001
|
+
"type": "object"
|
|
3002
|
+
},
|
|
3003
|
+
"UserProperty": {
|
|
3004
|
+
"document": "Returned mapping structure.",
|
|
3005
|
+
"members": [
|
|
3006
|
+
{
|
|
3007
|
+
"disabled": false,
|
|
3008
|
+
"document": "key",
|
|
3009
|
+
"example": "key1",
|
|
3010
|
+
"member": "string",
|
|
3011
|
+
"name": "Key",
|
|
3012
|
+
"output_required": false,
|
|
3013
|
+
"required": false,
|
|
3014
|
+
"type": "string",
|
|
3015
|
+
"value_allowed_null": false
|
|
3016
|
+
},
|
|
3017
|
+
{
|
|
3018
|
+
"disabled": false,
|
|
3019
|
+
"document": "value",
|
|
3020
|
+
"example": "value1",
|
|
3021
|
+
"member": "string",
|
|
3022
|
+
"name": "Value",
|
|
3023
|
+
"output_required": false,
|
|
3024
|
+
"required": false,
|
|
3025
|
+
"type": "string",
|
|
3026
|
+
"value_allowed_null": false
|
|
3027
|
+
}
|
|
3028
|
+
],
|
|
3029
|
+
"usage": "both"
|
|
3030
|
+
},
|
|
3031
|
+
"VpcInfo": {
|
|
3032
|
+
"document": "VPC information.",
|
|
3033
|
+
"members": [
|
|
3034
|
+
{
|
|
3035
|
+
"disabled": false,
|
|
3036
|
+
"document": "VPC ID",
|
|
3037
|
+
"example": "vpc-xxxx",
|
|
3038
|
+
"member": "string",
|
|
3039
|
+
"name": "VpcId",
|
|
3040
|
+
"required": false,
|
|
3041
|
+
"type": "string"
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
"disabled": false,
|
|
3045
|
+
"document": "Subnet ID.",
|
|
3046
|
+
"example": "subnet-xxxx",
|
|
3047
|
+
"member": "string",
|
|
3048
|
+
"name": "SubnetId",
|
|
3049
|
+
"required": false,
|
|
3050
|
+
"type": "string"
|
|
3051
|
+
}
|
|
3052
|
+
],
|
|
3053
|
+
"usage": "in"
|
|
3054
|
+
}
|
|
3055
|
+
},
|
|
3056
|
+
"version": "1.0"
|
|
3057
|
+
}
|