tccli-intl-en 3.1.13.1__py2.py3-none-any.whl → 3.1.39.1__py2.py3-none-any.whl

tccli/services/mqtt/v20240516/examples.json

@@ -0,0 +1,213 @@
+{
+  "actions": {
+    "AddClientSubscription": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddMQTTClientSubscription\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-2vnk55xv\",\n    \"ClientId\": \"sub_client1\",\n    \"TopicFilter\": \"home/lyx\",\n    \"Qos\": \"2\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"e6ce51ed-bc8e-4cc7-9cf0-f6bfcf5003dc\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "CreateAuthorizationPolicy": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuthorizationPolicy\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-xxx\",\n    \"PolicyName\": \"name1\",\n    \"PolicyVersion\": 1,\n    \"Priority\": 4,\n    \"Effect\": \"allow\",\n    \"Actions\": \"pub\",\n    \"Retain\": 1,\n    \"Qos\": \"2\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Id\": 6,\n        \"InstanceId\": \"mqtt-xxx\",\n        \"RequestId\": \"2e477c8c-abef-46e2-bde3-29433b34f309\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "CreateInstance": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMQTTInstance\n<Common request parameters>\n\n{\n    \"InstanceType\": \"BASIC\",\n    \"Name\": \"instance-1\",\n    \"SkuCode\": \"basic_1k\",\n    \"Remark\": \"this is remark\",\n    \"VpcList\": [\n        {\n            \"VpcId\": \"vpc-9a5wnirv\",\n            \"SubnetId\": \"subnet-0tw6tlfi\"\n        }\n    ],\n    \"IpRules\": [\n        {\n            \"Ip\": \"1.1.1.1\",\n            \"Allow\": true,\n            \"Remark\": \"remark\"\n        }\n    ]\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"InstanceId\": \"mqtt-7pnqmkrx\",\n        \"RequestId\": \"request-id\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "CreateMessageEnrichmentRule": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMessageEnrichmentRule\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4wpne\",\n    \"RuleName\": \"rule1\",\n    \"Condition\": \"eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9\",\n    \"Actions\": \"eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvZGV2aWNlcy8ke2NsaWVudGlkfSIsImNvcnJlbGF0aW9uRGF0YSI6IiR7dHJhY2VpZH0iLCJ1c2VyUHJvcGVydHkiOlt7ImtleSI6InRyYWNlLWlkIiwidmFsdWUiOiIke3RyYWNlaWR9In1dfQ==\",\n    \"Priority\": 2,\n    \"Status\": 1,\n    \"Remark\": \"remark\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Id\": 6,\n        \"InstanceId\": \"mqtt-g4r4wpne\",\n        \"RequestId\": \"63e5ecf1-3d79-4f28-aef3-6e7396f78dcd\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "CreateUser": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMQTTUser\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-12345\",\n    \"Remark\": \"remark\",\n    \"Username\": \"user1\",\n    \"Password\": \"user1-pd\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"25cb77a7-2add-4086-8fd2-a05b5bd34776\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteAuthorizationPolicy": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAuthorizationPolicy\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4x85z\",\n    \"Id\": 8\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"ed018161-ce7a-4ccc-bf9e-b85f4dbf2e2a\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteClientSubscription": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMQTTClientSubscription\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-2vnk55xv\",\n    \"ClientId\": \"sub_client1\",\n    \"TopicFilter\": \"home/lyx\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"8f068485-7252-481d-bdf9-62fdda0229f2\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteInstance": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMQTTInstance\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-wjgxr8jg\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"84afeb76-9175-47ec-a6f1-8d0af0c0aae6\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteMessageEnrichmentRule": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMessageEnrichmentRule\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4wpne\",\n    \"Id\": 6\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"718a230c-f185-4d53-9cf7-2b2a324a2216\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteTopic": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMQTTTopic\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-rvb5xxrn\",\n    \"Topic\": \"home\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"f3a081b8-dc97-4d62-bb1a-d1aa9fe80da8\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DeleteUser": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMQTTUser\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-7pnqmkrx\",\n    \"Username\": \"user1\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"74625f9b-ce92-43d5-ba0b-9a85ddb99041\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeAuthorizationPolicies": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuthorizationPolicies\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-mzd7ewkr\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Actions\": \"connect,pub,sub\",\n                \"ClientId\": \"client1\",\n                \"CreatedTime\": 1742387322000,\n                \"Effect\": \"allow\",\n                \"Id\": 3867,\n                \"InstanceId\": \"mqtt-mzd7ewkr\",\n                \"Ip\": \"0.0.0.0/0\",\n                \"PolicyName\": \"default_policy\",\n                \"Priority\": 1,\n                \"Qos\": \"0,1,2\",\n                \"Remark\": \"\",\n                \"Resources\": \"topic1\",\n                \"Retain\": 3,\n                \"UpdateTime\": 1742458867000,\n                \"Username\": \"default_user\",\n                \"Version\": 1\n            }\n        ],\n        \"RequestId\": \"9c44531d-37bd-4c8f-ab9f-b35589fa5b4d\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeClientList": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMQTTClientList\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-2vnk55xv\",\n    \"ClientId\": \"sub\",\n    \"Number\": \"10\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Clients\": [\n            {\n                \"ClientAddress\": \"11.176.16.153:63066\",\n                \"ClientId\": \"sub_client1\",\n                \"ConnectTime\": 1710314923557,\n                \"ConnectionStatus\": \"CONNECTED\",\n                \"CreateTime\": 1710314923554,\n                \"DisconnectTime\": 0,\n                \"Keepalive\": 60,\n                \"MQTTClientSubscriptions\": [\n                    {\n                        \"Qos\": 1,\n                        \"TopicFilter\": \"home/temp/+/\"\n                    },\n                    {\n                        \"Qos\": 0,\n                        \"TopicFilter\": \"home/humidity/+/\"\n                    },\n                    {\n                        \"Qos\": 2,\n                        \"TopicFilter\": \"home/person/+/\"\n                    }\n                ],\n                \"ProtocolVersion\": 4\n            },\n            {\n                \"ClientAddress\": \"11.176.16.153:62048\",\n                \"ClientId\": \"sub_client2\",\n                \"ConnectTime\": 1710314912143,\n                \"ConnectionStatus\": \"CONNECTED\",\n                \"CreateTime\": 1710314912140,\n                \"DisconnectTime\": 0,\n                \"Keepalive\": 60,\n                \"MQTTClientSubscriptions\": [\n                    {\n                        \"Qos\": 1,\n                        \"TopicFilter\": \"home/sun/+/\"\n                    },\n                    {\n                        \"Qos\": 1,\n                        \"TopicFilter\": \"home/temp/+/\"\n                    },\n                    {\n                        \"Qos\": 0,\n                        \"TopicFilter\": \"home/humidity/+/\"\n                    },\n                    {\n                        \"Qos\": 2,\n                        \"TopicFilter\": \"home/person/+/\"\n                    }\n                ],\n                \"ProtocolVersion\": 4\n            }\n        ],\n        \"RequestId\": \"9f81924f-41e8-4f24-aaf2-61da7da9c713\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeInstance": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstance\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-7peanr83\"\n}",
+        "output": "{\n    \"Response\": {\n        \"AuthorizationPolicy\": false,\n        \"AuthorizationPolicyLimit\": 20,\n        \"AutoSubscriptionPolicyLimit\": 10,\n        \"AutomaticActivation\": true,\n        \"ClientNumLimit\": 4000,\n        \"CreatedTime\": 1756879989,\n        \"DestroyTime\": 0,\n        \"DeviceCertificateProvisionType\": \"API\",\n        \"ExpiryTime\": 1759471988911,\n        \"InstanceId\": \"mqtt-7peanr83\",\n        \"InstanceName\": \"instance-1\",\n        \"InstanceStatus\": \"RUNNING\",\n        \"InstanceType\": \"PRO\",\n        \"MaxCaNum\": 20,\n        \"MaxSubscription\": 120000,\n        \"MaxSubscriptionPerClient\": 30,\n        \"MaxTopicFilterPerAutoSubscriptionPolicy\": 20,\n        \"MaxTopicFilterPerSharedSubscriptionGroup\": 10,\n        \"MessageRate\": -1,\n        \"PayMode\": \"PREPAID\",\n        \"RegistrationCode\": \"client-test\",\n        \"Remark\": \"\",\n        \"RenewFlag\": 1,\n        \"ServerCertLimit\": 3,\n        \"SharedSubscriptionGroupLimit\": 20,\n        \"SkuCode\": \"pro_2k_2\",\n        \"TopicNum\": 0,\n        \"TopicNumLimit\": 300,\n        \"TopicPrefixSlashLimit\": 2,\n        \"TpsLimit\": 2000,\n        \"TransportLayerSecurity\": \"TLSv1.3,TLSv1.2,TLSv1.1,TLSv1\",\n        \"TrustedCaLimit\": 3,\n        \"UseDefaultServerCert\": true,\n        \"X509Mode\": \"BYOC\",\n        \"RequestId\": \"8a95a551-ca77-45f6-aa00-77a090cac898\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeMessageByTopic": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageByTopic\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g839agr2\",\n    \"Topic\": \"home/room3\",\n    \"StartTime\": 1745828681259\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Data\": [\n            {\n                \"ClientId\": \"mqttxxxxxx\",\n                \"MessageId\": \"15397032005D639FEE48935F932F004D\",\n                \"OriginTopic\": \"home/room3\",\n                \"Qos\": \"1\",\n                \"StoreTimestamp\": \"2025-04-29 14:48:34\"\n            },\n            {\n                \"ClientId\": \"mqttxxxxxx\",\n                \"MessageId\": \"15397032005D639FEE48935FA6B80050\",\n                \"OriginTopic\": \"home/room3\",\n                \"Qos\": \"1\",\n                \"StoreTimestamp\": \"2025-04-29 14:48:39\"\n            },\n            {\n                \"ClientId\": \"mqttxxxxxx\",\n                \"MessageId\": \"15397032005D639FEE48935FBA410057\",\n                \"OriginTopic\": \"home/room3\",\n                \"Qos\": \"1\",\n                \"StoreTimestamp\": \"2025-04-29 14:48:44\"\n            },\n            {\n                \"ClientId\": \"mqttxxxxxx\",\n                \"MessageId\": \"15397032005D639FEE4893603732005C\",\n                \"OriginTopic\": \"home/room3\",\n                \"Qos\": \"1\",\n                \"StoreTimestamp\": \"2025-04-29 14:49:16\"\n            }\n        ],\n        \"RequestId\": \"6af56edc-5085-4583-8366-7f125c973603\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeMessageDetails": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageDetails\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g839agr2\",\n    \"MessageId\": \"15397032005D639FEE4893603732005C\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Body\": \"this is body\",\n        \"ClientId\": \"client1\",\n        \"MessageId\": \"15397032005D639FEE4893603732005C\",\n        \"OriginTopic\": \"home/room3\",\n        \"Qos\": \"1\",\n        \"RequestId\": \"ba5d5d6a-64c9-40cf-8889-21efed76389d\",\n        \"StoreTimestamp\": \"1745828681259\",\n        \"UserProperties\": [\n            {\n                \"Key\": \"key1\",\n                \"Value\": \"value-1\"\n            },\n            {\n                \"Key\": \"key2\",\n                \"Value\": \"value-2\"\n            }\n        ]\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeMessageEnrichmentRules": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageEnrichmentRules\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4wpne\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Actions\": \"eyJ1c2VyUHJvcGVydHkiOiBbeyJrZXkiOiAidHJhY2UtaWQiLCAidmFsdWUiOiAiJHt0cmFjZWlkfSJ9XSwgInJlc3BvbnNlVG9waWMiOiAicmVwbGllcy9kZXZpY2VzLyR7Y2xpZW50aWR9IiwgImNvcnJlbGF0aW9uRGF0YSI6ICIke3RyYWNlaWR9IiwgIm1lc3NhZ2VFeHBpcnlJbnRlcnZhbCI6IDM2MH0=\",\n                \"Condition\": \"eyJ0b3BpYyI6ICJob21lL3Jvb20xIiwgImNsaWVudElkIjogImNsaWVudC0xIiwgInVzZXJuYW1lIjogImNsaWVudC0xIn0=\",\n                \"CreatedTime\": 1763347106093,\n                \"Id\": 5,\n                \"InstanceId\": \"mqtt-g4r4wpne\",\n                \"Priority\": 1,\n                \"Remark\": \"remark\",\n                \"RuleName\": \"rule1\",\n                \"Status\": 1,\n                \"UpdateTime\": 1763347106093\n            },\n            {\n                \"Actions\": \"eyJ1c2VyUHJvcGVydHkiOiBbeyJrZXkiOiAidHJhY2UtaWQiLCAidmFsdWUiOiAiJHt0cmFjZWlkfSJ9XSwgInJlc3BvbnNlVG9waWMiOiAicmVwbGllcy9kZXZpY2VzLyR7Y2xpZW50aWR9IiwgImNvcnJlbGF0aW9uRGF0YSI6ICIke3RyYWNlaWR9IiwgIm1lc3NhZ2VFeHBpcnlJbnRlcnZhbCI6IDM2MH0=\",\n                \"Condition\": \"eyJ0b3BpYyI6ICJob21lL3Jvb20xIiwgImNsaWVudElkIjogImNsaWVudC0xIiwgInVzZXJuYW1lIjogImNsaWVudC0xIn0=\",\n                \"CreatedTime\": 1763347249927,\n                \"Id\": 6,\n                \"InstanceId\": \"mqtt-g4r4wpne\",\n                \"Priority\": 2,\n                \"Remark\": \"remark\",\n                \"RuleName\": \"rule2\",\n                \"Status\": 1,\n                \"UpdateTime\": 1763347388148\n            }\n        ],\n        \"RequestId\": \"6e898343-e911-49de-8491-f23108edd157\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeTopic": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMQTTTopic\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-7pnqmkrx\",\n    \"Topic\": \"topic1\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"CreatedTime\": 1705567642,\n        \"InstanceId\": \"mqtt-7pnqmkrx\",\n        \"Remark\": \"\",\n        \"RequestId\": \"acf7faf2-b2a9-431c-96b9-f589262da8f7\",\n        \"Topic\": \"topic1\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "DescribeUserList": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMQTTUserList\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-47ka4rdr\",\n    \"Offset\": 0,\n    \"Limit\": 10\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"Data\": [\n            {\n                \"CreatedTime\": 1705392159000,\n                \"ModifiedTime\": 1705392159000,\n                \"Password\": \"pwd1\",\n                \"Remark\": \"remark\",\n                \"Username\": \"user1\"\n            }\n        ],\n        \"RequestId\": \"8e86117c-a56c-4598-9e1f-4a039eed6e3a\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "KickOutClient": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: KickOutClient\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-pjn3nqdm\",\n    \"ClientId\": \"mqtt_chongfu\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"902a374b-fe13-4078-837a-9fde320acf6c\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "ModifyAuthorizationPolicy": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAuthorizationPolicy\n<Common request parameters>\n\n{\n    \"Id\": 18,\n    \"InstanceId\": \"mqtt-jeredv33\",\n    \"PolicyName\": \"policy-1\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"657a771d-a70e-4c0d-a70a-eb7f82471000\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "ModifyInstance": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMQTTInstance\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-47ka4rdr\",\n    \"Name\": \"instance-2\",\n    \"Remark\": \"ramark2\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"9955522b-ac27-46c1-8a16-3ed6f98f9c5c\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "ModifyMessageEnrichmentRule": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMessageEnrichmentRule\n<Common request parameters>\n\n{\n    \"Id\": 6,\n    \"InstanceId\": \"mqtt-g4r4wpne\",\n    \"RuleName\": \"rule2\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"018d5c6a-33bb-41b5-aa38-98cd4e226546\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "ModifyUser": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMQTTUser\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-7pnqmkrx\",\n    \"Username\": \"user2\",\n    \"Remark\": \"remark2\"\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"85d3aeee-ba25-47cc-8c17-7ad837b877ba\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "UpdateAuthorizationPolicyPriority": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateAuthorizationPolicyPriority\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4x85z\",\n    \"Priorities\": [\n        {\n            \"Id\": 1,\n            \"Priority\": 3\n        },\n        {\n            \"Id\": 6,\n            \"Priority\": 1\n        },\n        {\n            \"Id\": 7,\n            \"Priority\": 2\n        }\n    ]\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"1186da0d-931d-47a3-80a1-885ea2c00067\"\n    }\n}",
+        "title": "Example"
+      }
+    ],
+    "UpdateMessageEnrichmentRulePriority": [
+      {
+        "document": "This example shows you the example.",
+        "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateMessageEnrichmentRulePriority\n<Common request parameters>\n\n{\n    \"InstanceId\": \"mqtt-g4r4wpne\",\n    \"Priorities\": [\n        {\n            \"Id\": 6,\n            \"Priority\": 10\n        }\n    ]\n}",
+        "output": "{\n    \"Error\": null,\n    \"RequestId\": null,\n    \"Response\": {\n        \"RequestId\": \"cf686c8f-edb9-46e5-9a4d-d45296e377f9\"\n    }\n}",
+        "title": "Example"
+      }
+    ]
+  },
+  "version": "1.0"
+}

tccli/services/ocr/v20181119/api.json

@@ -3872,7 +3872,7 @@
         {
           "disabled": false,
           "document": "Date of birth",
-          "example": "20230414",
+          "example": "20230415",
           "member": "string",
           "name": "DateOfBirth",
           "output_required": true,
@@ -3962,7 +3962,7 @@
         {
           "disabled": false,
           "document": "The second row of the MRZ at the bottom",
-          "example": "`JK123488<3CAN8510168M2603298<<<<<<<<<<<<<<04`",
+          "example": "1357",
           "member": "string",
           "name": "CodeCrc",
           "output_required": true,
@@ -4002,7 +4002,7 @@
         {
           "disabled": false,
           "document": "Document content in Information Zone",
-          "example": "{\"DateOfBirth\":\"11 Apr 1990\"}",
+          "example": "无",
           "member": "PassportRecognizeInfos",
           "name": "PassportRecognizeInfos",
           "output_required": true,
@@ -4029,6 +4029,16 @@
           "type": "int",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "complete or not",
+          "example": "true",
+          "member": "bool",
+          "name": "IsComplete",
+          "output_required": false,
+          "type": "bool",
+          "value_allowed_null": false
+        },
         {
           "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.",
           "member": "string",
@@ -9219,6 +9229,16 @@
           "type": "int",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "The card information field complete or not\ntrue: complete; false: incomplete",
+          "example": "false",
+          "member": "bool",
+          "name": "IsComplete",
+          "output_required": false,
+          "type": "bool",
+          "value_allowed_null": false
+        },
         {
           "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.",
           "member": "string",

tccli/services/ocr/v20181119/examples.json

@@ -120,10 +120,10 @@
     ],
     "MLIDPassportOCR": [
       {
-        "document": "",
-        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: MLIDPassportOCR\n<common request parameters>\n\n{\n    \"ImageBase64\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/MLIDPassportOCR/MLIDPassportOCR1.png\"\n}",
+        "document": "Passport recognition (multiple countries and regions)",
+        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: MLIDPassportOCR\n<Common Request Parameters>\n\n{\n    \"ImageBase64\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/MLIDPassportOCR/MLIDPassportOCR1.png\"\n}",
         "output": "{\n    \"Response\": {\n        \"AdvancedInfo\": \"\",\n        \"CodeCrc\": \"4567123452USA9004117F2107268713843748<708026\",\n        \"CodeSet\": \"P<USACARTER<<ESTHER<<<<<<<<<<<<<<<<<<<<<<<<<\",\n        \"DateOfBirth\": \"19900411\",\n        \"DateOfExpiration\": \"20210726\",\n        \"GivenName\": \"ESTHER\",\n        \"ID\": \"456712345\",\n        \"Image\": \"\",\n        \"IssuingCountry\": \"USA\",\n        \"Name\": \"CARTER ESTHER\",\n        \"Nationality\": \"USA\",\n        \"PassportRecognizeInfos\": {\n            \"DateOfBirth\": \"11 Apr 1990\",\n            \"DateOfExpiration\": \"26 Jul 2021\",\n            \"DateOfIssuance\": \"27 Jul 2011\",\n            \"GivenName\": \"ESTHER\",\n            \"IssuePlace\": \"\",\n            \"IssuingAuthority\": \"\",\n            \"IssuingCountry\": \"USA\",\n            \"Name\": \"\",\n            \"Nationality\": \"UNITED STATES OF AMERICA\",\n            \"PassportID\": \"456712345\",\n            \"Sex\": \"F\",\n            \"Signature\": \"\",\n            \"Surname\": \"CARTER\",\n            \"Type\": \"P\"\n        },\n        \"RequestId\": \"dad946b2-1288-4df9-a0b4-6abfaba1e170\",\n        \"Sex\": \"F\",\n        \"Surname\": \"CARTER\",\n        \"Type\": \"P\",\n        \"Warn\": [\n            -9108,\n            -9102\n        ],\n        \"WarnCardInfos\": [\n            -9109\n        ]\n    }\n}",
-        "title": ""
+        "title": "Passport Recognition (Multiple Countries and Regions) Example Code"
       }
     ],
     "MainlandPermitOCR": [
@@ -305,9 +305,9 @@
     "RecognizeThaiIDCardOCR": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecognizeThaiIDCardOCR\n<common request parameters>\n\n{\n    \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg\"\n}",
-        "output": "{\n    \"Response\": {\n        \"Address\": \"ที่อยู่ 21/19 หมู่ที่ 3 ต.บางคูรัด อ.บางบัวทอง จ.นนทบุรี\",\n        \"AdvancedInfo\": \"{\\\"ID\\\":0.9995814561843872,\\\"ThaiName\\\":0.9961479902267456,\\\"EnFirstName\\\":0.9232422113418579,\\\"EnLastName\\\":0.943652331829071,\\\"Birthday\\\":0.9828404188156128,\\\"EnBirthday\\\":0.92333984375,\\\"Religion\\\":1,\\\"ExpirationDate\\\":0.9919084906578064,\\\"IssueDate\\\":0.9893275499343872,\\\"EnExpirationDate\\\":0.9890950322151184,\\\"EnIssueDate\\\":0.9800618290901184,\\\"SerialNumber\\\":0.9995659589767456}\",\n        \"Birthday\": \"14 ธ.ค. 2509\",\n        \"EnBirthday\": \"14 Dec. 1966\",\n        \"EnExpirationDate\": \"13 Dec. 2024\",\n        \"EnFirstName\": \"Mr. Thanakit\",\n        \"EnIssueDate\": \"9 Dec. 2016\",\n        \"EnLastName\": \"Boonyopakron\",\n        \"ExpirationDate\": \"13 ธ.ค. 2567\",\n        \"ID\": \"3 1020 01968 75 6\",\n        \"IssueDate\": \"9 ธ.ค. 2559\",\n        \"PortraitImage\": \"\",\n        \"Religion\": \"พุทธ\",\n        \"RequestId\": \"d4af8019-08e0-4d8d-a986-e1f45efb4a6c\",\n        \"SerialNumber\": \"1204-03-12091012\",\n        \"ThaiName\": \"นาย ธนกฤต บุญโญปกรณ์\",\n        \"WarnCardInfos\": [\n            -9109\n        ]\n    }\n}",
-        "title": ""
+        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecognizeThaiIDCardOCR\n<Common Request Parameters>\n\n{\n    \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Address\": \"\",\n        \"AdvancedInfo\": \"{\\\"ID\\\":0.9995814561843872,\\\"ThaiName\\\":0.9961479902267456,\\\"EnFirstName\\\":0.9232422113418579,\\\"EnLastName\\\":0.943652331829071,\\\"Birthday\\\":0.9828404188156128,\\\"EnBirthday\\\":0.92333984375,\\\"Religion\\\":1,\\\"ExpirationDate\\\":0.9919084906578064,\\\"IssueDate\\\":0.9893275499343872,\\\"EnExpirationDate\\\":0.9890950322151184,\\\"EnIssueDate\\\":0.9800618290901184,\\\"SerialNumber\\\":0.9995659589767456}\",\n        \"Birthday\": \"\",\n        \"EnBirthday\": \"14 Dec. 1966\",\n        \"EnExpirationDate\": \"13 Dec. 2024\",\n        \"EnFirstName\": \"Mr. Thanakit\",\n        \"EnIssueDate\": \"9 Dec. 2016\",\n        \"EnLastName\": \"Boonyopakron\",\n        \"ExpirationDate\": \"\",\n        \"ID\": \"3 1020 01968 75 6\",\n        \"IssueDate\": \"\",\n        \"PortraitImage\": \"\",\n        \"Religion\": \"\",\n        \"RequestId\": \"d4af8019-08e0-4d8d-a986-e1f45efb4a6c\",\n        \"SerialNumber\": \"1204-03-12091012\",\n        \"ThaiName\": \"\",\n        \"WarnCardInfos\": [\n            -9109\n        ]\n    }\n}",
+        "title": "RecognizeThaiIDCardOCR call"
       }
     ],
     "RecognizeThaiPinkCard": [

tccli/services/redis/v20180412/api.json

@@ -860,7 +860,7 @@
         },
         {
           "disabled": false,
-          "document": "Instance ID.\n- There are region and AZ limitations for adding a replication group instance. For detailed information, see [Use Limits](https://www.tencentcloud.comom/document/product/239/71934?from_cn_redirect=1).\n- Currently, only Redis 4.0 and 5.0 cluster architecture instances support being added to the replication groups.\n- Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the ID of the instance that needs to be added to the replication group in the instance list.",
+          "document": "Instance ID.\n- There are region and AZ limitations for adding a replication group instance. For detailed information, see [Use Limits](https://www.tencentcloud.com/document/product/239/71934?from_cn_redirect=1).\n- Currently, only Redis 4.0 and 5.0 cluster architecture instances support being added to the replication groups.\n- Log in to the [Redis console](https://console.cloud.tencent.com/redis/instance/list), and copy the ID of the instance that needs to be added to the replication group in the instance list.",
           "example": "crs-deindi7de",
           "member": "string",
           "name": "InstanceId",
@@ -962,7 +962,7 @@
         },
         {
           "disabled": false,
-          "document": "ID of the applied parameter template.\n- The parameter template ID can be obtained through the response parameter **TemplateId** of the API [DescribeParamTemplateInfo](https://www.tencentcloud.comom/document/product/239/58748?from_cn_redirect=1).\n- The operation can only be successfully performed when the parameter template version matches the architecture version of the target instance. A version mismatch will trigger an execution error.",
+          "document": "ID of the applied parameter template.\n- The parameter template ID can be obtained through the response parameter **TemplateId** of the API [DescribeParamTemplateInfo](https://www.tencentcloud.com/document/product/239/58748?from_cn_redirect=1).\n- The operation can only be successfully performed when the parameter template version matches the architecture version of the target instance. A version mismatch will trigger an execution error.",
           "example": "crs-cfg-rhlppeye",
           "member": "string",
           "name": "TemplateId",
@@ -1682,7 +1682,7 @@
         },
         {
           "disabled": false,
-          "document": "Security group ID. Call the [DescribeInstanceSecurityGroup](https://www.tencentcloud.comom/document/product/239/34447?from_cn_redirect=1) API to obtain the security group ID for the instance.",
+          "document": "Security group ID. Call the [DescribeInstanceSecurityGroup](https://www.tencentcloud.com/document/product/239/34447?from_cn_redirect=1) API to obtain the security group ID for the instance.",
           "example": "[\"sg-bmadczm1\"]",
           "member": "string",
           "name": "SecurityGroupIdList",
@@ -6794,7 +6794,7 @@
         },
         {
           "disabled": false,
-          "document": "ID of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.comom/document/product/239/4106?from_cn_redirect=1).\n**Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.",
+          "document": "ID of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.com/document/product/239/4106?from_cn_redirect=1).\n**Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.",
           "example": "100002",
           "member": "uint64",
           "name": "ZoneId",
@@ -6830,7 +6830,7 @@
         },
         {
           "disabled": false,
-          "document": "Name of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.comom/document/product/239/4106?from_cn_redirect=1).\n**Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.",
+          "document": "Name of the AZ to which the instance belongs. See [Regions and AZs](https://www.tencentcloud.com/document/product/239/4106?from_cn_redirect=1).\n**Note**: Specify at least one parameter from **ZoneId** and **ZoneName**.",
           "example": "ap-guangzhou",
           "member": "string",
           "name": "ZoneName",
@@ -9196,7 +9196,7 @@
         },
         {
           "disabled": false,
-          "document": "Replaces with the new security group ID list, which is an array of one or more security group IDs.\n- To configure a security group for an instance for the first time, call the API [AssociateSecurityGroups](https://www.tencentcloud.comom/document/product/239/41260?from_cn_redirect=1) to bind a security group first.\n- To replace the security group, obtain the security group ID on the [security group](https://console.tencentcloud.com/vpc/security-group) page of the console.\n\n**Note:** This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.",
+          "document": "Replaces with the new security group ID list, which is an array of one or more security group IDs.\n- To configure a security group for an instance for the first time, call the API [AssociateSecurityGroups](https://www.tencentcloud.com/document/product/239/41260?from_cn_redirect=1) to bind a security group first.\n- To replace the security group, obtain the security group ID on the [security group](https://console.tencentcloud.com/vpc/security-group) page of the console.\n\n**Note:** This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.",
           "example": "[\"sg-ajr1jzgj\"]",
           "member": "string",
           "name": "SecurityGroupIds",
@@ -9442,7 +9442,7 @@
         },
         {
           "disabled": false,
-          "document": "Event ID. Call the [DescribeInstanceEvents](https://www.tencentcloud.comom/document/product/239/104779?from_cn_redirect=1) API to obtain the ID of the event to be modified.",
+          "document": "Event ID. Call the [DescribeInstanceEvents](https://www.tencentcloud.com/document/product/239/104779?from_cn_redirect=1) API to obtain the ID of the event to be modified.",
           "example": "89",
           "member": "int64",
           "name": "EventId",
@@ -11607,7 +11607,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "ID of the instance to be operated, which can be obtained through the response parameter InstanceId of the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API.",
+          "document": "ID of the instance to be operated, which can be obtained through the response parameter InstanceId of the [DescribeInstances](https://www.tencentcloud.com/document/product/239/20018?from_cn_redirect=1) API.",
           "example": "crs-5a4py64p",
           "member": "string",
           "name": "InstanceId",
@@ -11616,7 +11616,7 @@
         },
         {
           "disabled": false,
-          "document": "Backup ID, which can be obtained through the response parameter RedisBackupSet of the [DescribeInstanceBackups](https://www.tencentcloud.comom/document/product/239/20011?from_cn_redirect=1) API.",
+          "document": "Backup ID, which can be obtained through the response parameter RedisBackupSet of the [DescribeInstanceBackups](https://www.tencentcloud.com/document/product/239/20011?from_cn_redirect=1) API.",
           "example": "\"154572601-1165734321-153731245\"",
           "member": "string",
           "name": "BackupId",
@@ -12103,7 +12103,7 @@
         },
         {
           "disabled": false,
-          "document": "Instance proxy ID list. Call the API [DescribeInstanceNodeInfo](https://www.tencentcloud.comom/document/product/239/48603?from_cn_redirect=1) to obtain IDs from **NodeId** in the **Proxy** response parameter.",
+          "document": "Instance proxy ID list. Call the API [DescribeInstanceNodeInfo](https://www.tencentcloud.com/document/product/239/48603?from_cn_redirect=1) to obtain IDs from **NodeId** in the **Proxy** response parameter.",
           "example": "[\"896873be5805ebacae5042311237e6d2d78be00b\"]",
           "member": "string",
           "name": "ProxyIDList",
@@ -12600,7 +12600,7 @@
         },
         {
           "disabled": false,
-          "document": "Current proxy version. Call the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API to obtain the current proxy version for the instance.",
+          "document": "Current proxy version. Call the [DescribeInstances](https://www.tencentcloud.com/document/product/239/20018?from_cn_redirect=1) API to obtain the current proxy version for the instance.",
           "example": "5.0.0",
           "member": "string",
           "name": "CurrentProxyVersion",
@@ -12609,7 +12609,7 @@
         },
         {
           "disabled": false,
-          "document": "Upgradable Redis version. Call the [DescribeInstances](https://www.tencentcloud.comom/document/product/239/20018?from_cn_redirect=1) API to obtain the upgradable Redis version for the instance.",
+          "document": "Upgradable Redis version. Call the [DescribeInstances](https://www.tencentcloud.com/document/product/239/20018?from_cn_redirect=1) API to obtain the upgradable Redis version for the instance.",
           "example": "5.0.1",
           "member": "string",
           "name": "UpgradeProxyVersion",