{
  "name": "mqtt",
  "display_name": "消息队列 MQTT 版",
  "description": "提供 TDMQ MQTT 版控制台的功能，如元数据的增删改查等",
  "domain": "other",
  "api_version": "2024-05-16",
  "endpoint": "mqtt.tencentcloudapi.com",
  "actions": [
    {
      "name": "ActivateCaCertificate",
      "description": "激活Ca证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "CaSn",
          "type": "string",
          "required": true,
          "description": "CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。",
          "example": "40597e878dc36d4dd13a25da70271f7b4ba6fe63"
        }
      ],
      "required": [
        "InstanceId",
        "CaSn"
      ]
    },
    {
      "name": "ActivateDeviceCertificate",
      "description": "生效设备证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "DeviceCertificateSn",
          "type": "string",
          "required": true,
          "description": "设备证书的SN序列号，可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。",
          "example": "2baf8d7bc23fc4566880d7da08a0c6b7f99d4727"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceCertificateSn"
      ]
    },
    {
      "name": "AddClientSubscription",
      "description": "为MQTT客户端增加一条订阅",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "mqtt-xxxx"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": true,
          "description": "客户端id",
          "example": "client1"
        },
        {
          "name": "TopicFilter",
          "type": "string",
          "required": true,
          "description": "订阅",
          "example": "humidity/+/"
        },
        {
          "name": "Qos",
          "type": "string",
          "required": false,
          "description": "服务质量:0,1,2",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId",
        "ClientId",
        "TopicFilter"
      ]
    },
    {
      "name": "ApplyRegistrationCode",
      "description": "申请ca注册码",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "CreateAuthorizationPolicy",
      "description": "创建MQTT实例的性能测试任务",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "PolicyName",
          "type": "string",
          "required": true,
          "description": "策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。",
          "example": "name"
        },
        {
          "name": "PolicyVersion",
          "type": "integer",
          "required": true,
          "description": "策略版本,默认为1，当前仅支持1",
          "example": "1"
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": true,
          "description": "策略优先级，越小越优先，不能重复，优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "1"
        },
        {
          "name": "Effect",
          "type": "string",
          "required": true,
          "description": "决策： allow：允许符合该策略的设备的访问请求。 deny：拒绝覆盖该策略的设备的访问请求。 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "allow"
        },
        {
          "name": "Actions",
          "type": "string",
          "required": true,
          "description": "操作,支持多选，多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。 connect：连接 pub：发布 sub：订阅",
          "example": "connect"
        },
        {
          "name": "Retain",
          "type": "integer",
          "required": true,
          "description": "条件-保留消息，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。 1,匹配保留消息； 2,匹配非保留消息， 3.匹配保留和非保留消息",
          "example": "1"
        },
        {
          "name": "Qos",
          "type": "string",
          "required": true,
          "description": "条件：服务质量 0：最多一次 1：最少一次 2：精确一次 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "1"
        },
        {
          "name": "Resources",
          "type": "string",
          "required": false,
          "description": "资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "topic1"
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "条件-用户名",
          "example": "user1"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "条件：客户端ID，支持正则",
          "example": "client1"
        },
        {
          "name": "Ip",
          "type": "string",
          "required": false,
          "description": "条件：客户端IP地址，支持IP或者CIDR，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "127.0.0.1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注信息，最长 128 字符",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId",
        "PolicyName",
        "PolicyVersion",
        "Priority",
        "Effect",
        "Actions",
        "Retain",
        "Qos"
      ]
    },
    {
      "name": "CreateDeviceIdentity",
      "description": "创建一机一密设备签名",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "device-1"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "1:ENABLED-可用（默认） 2:DISABLE-不可用",
          "example": "1"
        },
        {
          "name": "PrimaryKey",
          "type": "string",
          "required": false,
          "description": "主要签名key，不传则由系统自动生成，需要base64编码。",
          "example": "pk"
        },
        {
          "name": "SecondaryKey",
          "type": "string",
          "required": false,
          "description": "次要签名key，不传则由系统自动生成，需要base64编码。",
          "example": "sk"
        },
        {
          "name": "PropagatingProperties",
          "type": "array",
          "required": false,
          "description": "该设备id的传播属性设置",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "传播属性key",
              "example": "property-key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "传播属性value",
              "example": "property-value"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "DeviceId"
      ]
    },
    {
      "name": "CreateHttpAuthenticator",
      "description": "创建一个HTTP的认证器",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": true,
          "description": "jwks服务地址",
          "example": "http://127.0.0.1"
        },
        {
          "name": "Concurrency",
          "type": "integer",
          "required": false,
          "description": "最大并发连接数，默认8，范围：1-10",
          "example": "10"
        },
        {
          "name": "Method",
          "type": "string",
          "required": false,
          "description": "网络请求方法 GET 或 POST，默认POST",
          "example": "POST"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器是否开启：open-启用；close-关闭，默认open-启用",
          "example": "open"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，最多支持128个字符。",
          "example": "remark"
        },
        {
          "name": "ConnectTimeout",
          "type": "integer",
          "required": false,
          "description": "连接超时时间，单位：秒，范围：1-30",
          "example": "5"
        },
        {
          "name": "ReadTimeout",
          "type": "integer",
          "required": false,
          "description": "请求超时时间，单位：秒，范围：1-30",
          "example": "5"
        },
        {
          "name": "Header",
          "type": "array",
          "required": false,
          "description": "转发请求header",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "header key",
              "example": "Content-Type"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "header value",
              "example": "application/json"
            }
          ]
        },
        {
          "name": "Body",
          "type": "array",
          "required": false,
          "description": "转发请求body",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "body key",
              "example": "username"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "body key",
              "example": "${username}"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "Endpoint"
      ]
    },
    {
      "name": "CreateInsPublicEndpoint",
      "description": "为MQTT实例创建公网接入点，未开启公网的集群可调用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": true,
          "description": "带宽,单位Mbps",
          "example": "2"
        },
        {
          "name": "Rules",
          "type": "array",
          "required": false,
          "description": "公网访问规则",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "IpRule",
              "type": "string",
              "required": false,
              "description": "ip网段信息",
              "example": "0.0.0.0/0"
            },
            {
              "name": "Allow",
              "type": "boolean",
              "required": false,
              "description": "当前仅支持允许，默认允许（allow）",
              "example": "true"
            },
            {
              "name": "Remark",
              "type": "string",
              "required": false,
              "description": "备注信息，最多64个字符。",
              "example": "this is remark"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "Bandwidth"
      ]
    },
    {
      "name": "CreateInstance",
      "description": "购买新的MQTT实例",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceType",
          "type": "string",
          "required": true,
          "description": "实例类型，需要和SkuCode保持对应关系，可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。 BASIC 基础版 PRO 专业版 PLATINUM 铂金版",
          "example": "BASIC"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "集群名称不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。",
          "example": "instance-1"
        },
        {
          "name": "SkuCode",
          "type": "string",
          "required": true,
          "description": "商品规格，需要和InstanceType保持对应关系，可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。",
          "example": "pro_10k_1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注信息，最长 128 字符",
          "example": "remark"
        },
        {
          "name": "TagList",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "[{\"tag1-key\":\"tag1-value\",\"tag2-key\":\"tag2-value\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签名称",
              "example": "tag-key"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "tag-value"
            }
          ]
        },
        {
          "name": "VpcList",
          "type": "array",
          "required": false,
          "description": "实例绑定的VPC信息，需要传当前用户下可用的VPC和SUBNET",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "VpcId",
              "type": "string",
              "required": false,
              "description": "VPC ID",
              "example": "vpc-xxxx"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "子网ID",
              "example": "subnet-xxxx"
            }
          ]
        },
        {
          "name": "EnablePublic",
          "type": "boolean",
          "required": false,
          "description": "是否开启公网，默认false（关闭）",
          "example": "true"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": false,
          "description": "公网带宽（单位：Mbps），EnablePublic 为True时，该字段必须填写且大于0.",
          "example": "1"
        },
        {
          "name": "IpRules",
          "type": "array",
          "required": false,
          "description": "公网访问白名单，不传表示拒绝所有IP网络访问。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Ip",
              "type": "string",
              "required": true,
              "description": "IP地址",
              "example": "0.0.0.0"
            },
            {
              "name": "Allow",
              "type": "boolean",
              "required": true,
              "description": "当前仅支持允许，默认允许。",
              "example": "true"
            },
            {
              "name": "Remark",
              "type": "string",
              "required": true,
              "description": "备注信息",
              "example": "remark1"
            }
          ]
        },
        {
          "name": "RenewFlag",
          "type": "integer",
          "required": false,
          "description": "是否自动续费（0: 不自动续费；1: 自动续费），仅购买预付费集群时生效。默认1:自动续费",
          "example": "1"
        },
        {
          "name": "TimeSpan",
          "type": "integer",
          "required": false,
          "description": "购买时长（单位：月），购买预付费集群时生效，默认1m（月）。可选范围：1~12、24、36、48、60；",
          "example": "1"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": false,
          "description": "付费模式（0: 后付费；1: 预付费），默认0（后付费）。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceType",
        "Name",
        "SkuCode"
      ]
    },
    {
      "name": "CreateJWKSAuthenticator",
      "description": "创建一个jwks的认证",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "JWKS服务地址，（Text字段和Endpoint字段必须选择一个填写）",
          "example": "127.0.0.1"
        },
        {
          "name": "RefreshInterval",
          "type": "integer",
          "required": false,
          "description": "认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址（Endpoint）时生效。",
          "example": "100"
        },
        {
          "name": "Text",
          "type": "string",
          "required": false,
          "description": "jwks文本，（Text字段和Endpoint字段必须选择一个填写）",
          "example": "text"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器是否开启：open-启用；close-关闭，默认open-启用",
          "example": "open"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，不能超过 128 个字符",
          "example": "remark"
        },
        {
          "name": "From",
          "type": "string",
          "required": false,
          "description": "认证字段； username-对应 MQTT CONNECT Packet 中 username 字段， password-对应 MQTT CONNECT Packet 中 password 字段。 默认username",
          "example": "username"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "CreateJWTAuthenticator",
      "description": "创建一个jwks的认证",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Algorithm",
          "type": "string",
          "required": true,
          "description": "签名方式：hmac-based，public-key",
          "example": "hmac-based"
        },
        {
          "name": "From",
          "type": "string",
          "required": true,
          "description": "认证字段 password：对应 MQTT CONNECT Packet 中 password 字段， username：对应 MQTT CONNECT Packet 中 username 字段 默认username",
          "example": "username"
        },
        {
          "name": "Secret",
          "type": "string",
          "required": false,
          "description": "密钥，Algorithm为hmac-based需要传递该字段。",
          "example": "your-secret"
        },
        {
          "name": "PublicKey",
          "type": "string",
          "required": false,
          "description": "公钥，Algorithm为public-key时需要传递该字段。",
          "example": "text"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器是否开启：open-启用；close-关闭，默认：open-启用",
          "example": "open"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，不能超过 128 个字符。",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId",
        "Algorithm",
        "From"
      ]
    },
    {
      "name": "CreateMessageEnrichmentRule",
      "description": "创建一条消息属性增强规则",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名称",
          "example": "rule1"
        },
        {
          "name": "Condition",
          "type": "string",
          "required": true,
          "description": "规则匹配条件，JSON格式，需要Base64编码 样例 {\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"} Base64后 eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
          "example": "eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9"
        },
        {
          "name": "Actions",
          "type": "string",
          "required": true,
          "description": "规则执行的动作，JSON格式，需要Base64编码 样例 {\"messageExpiryInterval\":360,\"responseTopic\":\"replies/devices/${clientid}\",\"correlationData\":\"${traceid}\",\"userProperty\":[{\"key\":\"trace-id\",\"value\":\"${traceid}\"}]} BASE64后 eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvZGV2aWNlcy8ke2NsaWVudGlkfSIsImNvcnJlbGF0aW9uRGF0YSI6IiR7dHJhY2VpZH0iLCJ1c2VyUHJvcGVydHkiOlt7ImtleSI6InRyYWNlLWlkIiwidmFsdWUiOiIke3RyYWNlaWR9In1dfQ==",
          "example": "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvZGV2aWNlcy8ke2NsaWVudGlkfSIsImNvcnJlbGF0aW9uRGF0YSI6IiR7dHJhY2VpZH0iLCJ1c2VyUHJvcGVydHkiOlt7ImtleSI6InRyYWNlLWlkIiwidmFsdWUiOiIke3RyYWNlaWR9In1dfQ=="
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": true,
          "description": "规则优先级，数字越小，优先级越高，高优先级覆盖低低优先级。UserPropertiy字段会合并",
          "example": "1"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "策略状态。 0:未定义；1:激活；2:不激活；默认不激活",
          "example": "1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注，长度不超过128个字符。",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId",
        "RuleName",
        "Condition",
        "Actions",
        "Priority"
      ]
    },
    {
      "name": "CreateTopic",
      "description": "创建主题",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "主题，不能为空，只能包含字母、数字、“-”及“_”，3-100 字符。",
          "example": "sample-topic-name"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注，最长 128 字符",
          "example": "additional-remark"
        }
      ],
      "required": [
        "InstanceId",
        "Topic"
      ]
    },
    {
      "name": "CreateUser",
      "description": "添加mqtt角色",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Username",
          "type": "string",
          "required": true,
          "description": "用户名，不能为空，只支持数字 大小写字母 分隔符(\"_\",\"-\")，不能超过 32 个字符",
          "example": "user1"
        },
        {
          "name": "Password",
          "type": "string",
          "required": false,
          "description": "密码，该字段为空时候则后端会默认生成。用户自定义密码时，不能为空，只支持数字 大小写字母 分隔符(\"_\",\"-\")，不能超过 64 个字符。",
          "example": "pwd"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注，长度不超过128个字符。",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId",
        "Username"
      ]
    },
    {
      "name": "DeactivateCaCertificate",
      "description": "失效Ca证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "CaSn",
          "type": "string",
          "required": true,
          "description": "证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。",
          "example": "40597e878dc36d4dd13a25da70271f7b4ba6fe63"
        }
      ],
      "required": [
        "InstanceId",
        "CaSn"
      ]
    },
    {
      "name": "DeactivateDeviceCertificate",
      "description": "失效Ca证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "DeviceCertificateSn",
          "type": "string",
          "required": true,
          "description": "设备证书的SN序列号，可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。",
          "example": "2baf8d7bc23fc4566880d7da08a0c6b7f99d4727"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceCertificateSn"
      ]
    },
    {
      "name": "DeleteAuthenticator",
      "description": "根据认证器类型删除一个MQTT认证器",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "认证器类型: JWT：JWT认证器 JWKS：JWKS认证器 HTTP：HTTP认证器",
          "example": "JWKS"
        }
      ],
      "required": [
        "InstanceId",
        "Type"
      ]
    },
    {
      "name": "DeleteAuthorizationPolicy",
      "description": "删除策略规则",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "授权策略规则id，可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId",
        "Id"
      ]
    },
    {
      "name": "DeleteCaCertificate",
      "description": "删除Ca证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "CaSn",
          "type": "string",
          "required": true,
          "description": "CA证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。",
          "example": "40597e878dc36d4dd13a25da70271f7b4ba6fe63"
        }
      ],
      "required": [
        "InstanceId",
        "CaSn"
      ]
    },
    {
      "name": "DeleteClientSubscription",
      "description": "删除MQTT客户端下的一条订阅",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "mqtt-xxxx"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "客户端id",
          "example": "client1"
        },
        {
          "name": "TopicFilter",
          "type": "string",
          "required": false,
          "description": "订阅",
          "example": "humidity/+/"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DeleteDeviceCertificate",
      "description": "删除设备证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-1234567"
        },
        {
          "name": "DeviceCertificateSn",
          "type": "string",
          "required": true,
          "description": "设备证书序列号",
          "example": "37593"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceCertificateSn"
      ]
    },
    {
      "name": "DeleteDeviceIdentity",
      "description": "删除一机一密设备签名",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-1234"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "device-1"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceId"
      ]
    },
    {
      "name": "DeleteInsPublicEndpoint",
      "description": "删除MQTT实例的公网接入点",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DeleteInstance",
      "description": "删除MQTT实例",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DeleteMessageEnrichmentRule",
      "description": "删除消息属性增强规则",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "消息属性增强规则id",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId",
        "Id"
      ]
    },
    {
      "name": "DeleteTopic",
      "description": "删除MQTT主题",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "主题",
          "example": "sample-topic-name"
        }
      ],
      "required": [
        "InstanceId",
        "Topic"
      ]
    },
    {
      "name": "DeleteUser",
      "description": "删除MQTT访问用户",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Username",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "user1"
        }
      ],
      "required": [
        "InstanceId",
        "Username"
      ]
    },
    {
      "name": "DescribeAuthenticator",
      "description": "查询MQTT认证器",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "认证器类型: JWT：JWT认证器 JWKS：JWKS认证器 HTTP：HTTP认证器",
          "example": "JWKS"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeAuthorizationPolicies",
      "description": "查询授权规则",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeCaCertificate",
      "description": "查询Ca证书详情接口",
      "status": "online",
      "parameters": [
        {
          "name": "CaSn",
          "type": "string",
          "required": true,
          "description": "CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。",
          "example": "40597e878dc36d4dd13a25da70271f7b4ba6fe63"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "CaSn",
        "InstanceId"
      ]
    },
    {
      "name": "DescribeCaCertificates",
      "description": "查询集群下的ca证书信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeClientList",
      "description": "查询 MQTT 客户端详情",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "客户端ID",
          "example": "client1"
        },
        {
          "name": "Number",
          "type": "string",
          "required": false,
          "description": "客户端数量限制,最大1024，默认1024",
          "example": "1024"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDeviceCertificate",
      "description": "查询设备证书详情接口",
      "status": "online",
      "parameters": [
        {
          "name": "DeviceCertificateSn",
          "type": "string",
          "required": true,
          "description": "设备证书的SN序列号，用于唯一标识一个设备证书。",
          "example": "0eef68a582b94254296e54ce754f94d707a59913"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "DeviceCertificateSn",
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDeviceCertificates",
      "description": "分页查询设备证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "支持搜索参数 ClientId：客户端id，根据实际业务使用获取 CaSn：所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取 DeviceCertificateSn：设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取 DeviceCertificateCn：设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取 ...",
          "example": "[{\"Name\":\"ClientId\",\"Values\":[\"client-1\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤条件名",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤条件的值",
              "example": "value",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页limit，默认20，最大100",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认0",
          "example": "0"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序规则 CREATE_TIME_DESC, 创建时间降序 CREATE_TIME_ASC,创建时间升序 UPDATE_TIME_DESC,更新时间降序 UPDATE_TIME_ASC,更新时间升序",
          "example": "CREATE_TIME_DESC"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDeviceIdentities",
      "description": "查询集群下设备标识列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-1234"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询起始位置",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询结果限制数量",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDeviceIdentity",
      "description": "查询设备一机一密标识",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-1234"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "device-1"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceId"
      ]
    },
    {
      "name": "DescribeInsPublicEndpoints",
      "description": "查询MQTT实例公网接入点",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInsVPCEndpoints",
      "description": "查询MQTT实例公网接入点",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstance",
      "description": "查询实例信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceList",
      "description": "获取实例列表，Filters参数使用说明如下： 1. InstanceName, 名称模糊查询 2. InstanceId，实例ID查询 3. InstanceStatus，实例状态查询，支持多选 当使用TagFilters查询时，Filters参数失效。",
      "status": "online",
      "parameters": [
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询条件列表,支持以下字段 InstanceName：集群名模糊搜索 InstanceId：集群id精确搜索 InstanceStatus：集群状态搜索（RUNNING-运行中，CREATING-创建中，MODIFYING-变配中，DELETING-删除中） 注意：配置TagFilters时该查询条件不生效。",
          "example": "[{\"Name\":\"InstanceName\",\"Values\":[\"instance1\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤条件名",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤条件的值",
              "example": "value",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询起始位置，默认0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询结果限制数量，默认20，最大100",
          "example": "10"
        },
        {
          "name": "TagFilters",
          "type": "array",
          "required": false,
          "description": "标签过滤器",
          "example": "[{\"TagKey\":\"tag1-key\",\"TagValue\":[\"tag1-value\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键名称",
              "example": "key1"
            },
            {
              "name": "TagValues",
              "type": "array",
              "required": false,
              "description": "标签键名称",
              "example": "value1",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeMessageByTopic",
      "description": "根据订阅查询消息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "home/room",
          "example": "发送topic或者订阅表达式"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间，毫秒级时间戳 。",
          "example": "1712025623202"
        },
        {
          "name": "MaxNumber",
          "type": "integer",
          "required": false,
          "description": "查询消息条数，最大1024，默认100.",
          "example": "100"
        }
      ],
      "required": [
        "InstanceId",
        "Topic",
        "StartTime"
      ]
    },
    {
      "name": "DescribeMessageDetails",
      "description": "查询MQTT消息详情",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "MessageId",
          "type": "string",
          "required": true,
          "description": "消息ID",
          "example": "0B8D67D3003505C29BFD077EC65B0002"
        },
        {
          "name": "Subscription",
          "type": "string",
          "required": false,
          "description": "订阅表达式",
          "example": "home/room"
        }
      ],
      "required": [
        "InstanceId",
        "MessageId"
      ]
    },
    {
      "name": "DescribeMessageEnrichmentRules",
      "description": "查询消息属性增强规则",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。",
          "example": "mqtt-xxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeMessageList",
      "description": "根据一级Topic查询消息列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "要查询的一级Topic，可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。",
          "example": "home"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间，毫秒级时间戳 。",
          "example": "1712025623202"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间，毫秒级时间戳 。",
          "example": "1712112023202"
        },
        {
          "name": "TaskRequestId",
          "type": "string",
          "required": true,
          "description": "请求任务id，用于相同查询参数下查询加速，第一次查询时无需传递，第一次查询会根据本次查询参数生成查询任务ID，保留查询条件，查询下一页消息时可传递第一次查询返回的任务ID。",
          "example": "dcfefe36-829d-4dd8-a436-e622c6ecab8f"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询起始位置，默认0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询结果限制数量，默认20，最大50",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId",
        "Topic",
        "StartTime",
        "EndTime",
        "TaskRequestId"
      ]
    },
    {
      "name": "DescribeProductSKUList",
      "description": "获取产品售卖规格",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeSharedSubscriptionLag",
      "description": "查询共享订阅消息堆积量",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-sample"
        },
        {
          "name": "SharedSubscription",
          "type": "string",
          "required": true,
          "description": "共享订阅表达式",
          "example": "$share/example_group/home/#"
        }
      ],
      "required": [
        "InstanceId",
        "SharedSubscription"
      ]
    },
    {
      "name": "DescribeTopic",
      "description": "查询mqtt主题详情",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "主题",
          "example": "sample-topic-name"
        }
      ],
      "required": [
        "InstanceId",
        "Topic"
      ]
    },
    {
      "name": "DescribeTopicList",
      "description": "获取主题列表，Filter参数使用说明如下： 1. TopicName，主题名称模糊搜索 2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询条件列表: 支持TopicName模糊查询",
          "example": "[{\"Name\":\"TopicName\",\"Values\":[\"home\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤条件名",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤条件的值",
              "example": "value",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询起始位置，默认0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询结果限制数量，默认20，最大20",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeUserList",
      "description": "查询用户列表，Filter参数使用说明如下： 1. Username，用户名称模糊搜索",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询条件列表支持字段 Username：按照【用户名】进行过滤，支持模糊过滤，类型：String",
          "example": "[{\"Name\":\"Username\",\"Values\":[\"user1\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤条件名",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤条件的值",
              "example": "value",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询起始位置，默认值0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询结果限制数量，默认值20，最大值100",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "KickOutClient",
      "description": "踢出客户端",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-12345"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": true,
          "description": "客户端id",
          "example": "client1"
        }
      ],
      "required": [
        "InstanceId",
        "ClientId"
      ]
    },
    {
      "name": "ModifyAuthorizationPolicy",
      "description": "修改策略规则，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "授权策略ID，从 [查询授权策略](https://cloud.tencent.com/document/product/1778/111074) 接口获取",
          "example": "1"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "PolicyName",
          "type": "string",
          "required": false,
          "description": "策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。",
          "example": "name"
        },
        {
          "name": "PolicyVersion",
          "type": "integer",
          "required": false,
          "description": "策略版本,默认为1，当前仅支持1",
          "example": "1"
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": false,
          "description": "策略优先级，越小越优先，不能重复",
          "example": "1"
        },
        {
          "name": "Effect",
          "type": "string",
          "required": false,
          "description": "决策： allow 允许 deny 拒绝",
          "example": "allow"
        },
        {
          "name": "Actions",
          "type": "string",
          "required": false,
          "description": "操作,支持多选，多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。 connect：连接 pub：发布 sub：订阅",
          "example": "connect"
        },
        {
          "name": "Resources",
          "type": "string",
          "required": false,
          "description": "资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。",
          "example": "topic1"
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "条件-用户名",
          "example": "user1"
        },
        {
          "name": "Retain",
          "type": "integer",
          "required": false,
          "description": "条件-保留消息 1,匹配保留消息； 2,匹配非保留消息， 3.匹配保留和非保留消息",
          "example": "1"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "条件：客户端ID，支持正则",
          "example": "client1"
        },
        {
          "name": "Ip",
          "type": "string",
          "required": false,
          "description": "条件：客户端IP地址，支持IP或者CIDR",
          "example": "127.0.0.1"
        },
        {
          "name": "Qos",
          "type": "string",
          "required": false,
          "description": "条件：服务质量 0：最多一次 1：最少一次 2：精确一次",
          "example": "1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注信息，最长 128 字符",
          "example": "remark"
        }
      ],
      "required": [
        "Id",
        "InstanceId"
      ]
    },
    {
      "name": "ModifyDeviceIdentity",
      "description": "修改一机一密设备签名",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "device-1"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "1:ENABLED-可用 2:DISABLE-不可用",
          "example": "1"
        },
        {
          "name": "PrimaryKey",
          "type": "string",
          "required": false,
          "description": "主要签名key，需要Base64编码。",
          "example": "pk"
        },
        {
          "name": "SecondaryKey",
          "type": "string",
          "required": false,
          "description": "次要签名key，需要Base64编码。",
          "example": "sk"
        },
        {
          "name": "PropagatingProperties",
          "type": "array",
          "required": false,
          "description": "该设备id的传播属性设置",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "传播属性key",
              "example": "property-key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "传播属性value",
              "example": "property-value"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "DeviceId"
      ]
    },
    {
      "name": "ModifyHttpAuthenticator",
      "description": "修改MQTT HTTP 认证器",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "服务地址",
          "example": " http://127.0.0.1"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器状态：open-启用；close-关闭",
          "example": "open"
        },
        {
          "name": "Concurrency",
          "type": "integer",
          "required": false,
          "description": "最大并发连接数，默认8，范围：1-10",
          "example": "10"
        },
        {
          "name": "ConnectTimeout",
          "type": "integer",
          "required": false,
          "description": "连接超时时间，单位：秒，范围：1-30",
          "example": "5"
        },
        {
          "name": "ReadTimeout",
          "type": "integer",
          "required": false,
          "description": "请求超时时间，单位：秒，范围：1-30",
          "example": "5"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，最多支持128个字符。",
          "example": "remark"
        },
        {
          "name": "Method",
          "type": "string",
          "required": false,
          "description": "请求方法，GET 或者 POST",
          "example": "POST"
        },
        {
          "name": "Header",
          "type": "array",
          "required": false,
          "description": "请求header",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "header key",
              "example": "Content-Type"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "header value",
              "example": "application/json"
            }
          ]
        },
        {
          "name": "Body",
          "type": "array",
          "required": false,
          "description": "请求body",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "body key",
              "example": "username"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "body key",
              "example": "${username}"
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyInsPublicEndpoint",
      "description": "更新MQTT实例公网接入点",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": true,
          "description": "带宽，单位：Mbps",
          "example": "2"
        },
        {
          "name": "Rules",
          "type": "array",
          "required": true,
          "description": "公网访问规则",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "IpRule",
              "type": "string",
              "required": false,
              "description": "ip网段信息",
              "example": "0.0.0.0/0"
            },
            {
              "name": "Allow",
              "type": "boolean",
              "required": false,
              "description": "当前仅支持允许，默认允许（allow）",
              "example": "true"
            },
            {
              "name": "Remark",
              "type": "string",
              "required": false,
              "description": "备注信息，最多64个字符。",
              "example": "this is remark"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "Bandwidth",
        "Rules"
      ]
    },
    {
      "name": "ModifyInstance",
      "description": "修改实例属性，只有运行中的集群可以调用该接口进行变更配置。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "要修改实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。",
          "example": "instance1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "要修改的备注信息，最多128个字符。",
          "example": "remark"
        },
        {
          "name": "SkuCode",
          "type": "string",
          "required": false,
          "description": "需要变更的配置规格 基础版和专业版集群不能升配到铂金版规格，铂金版集群不能降配至基础版和增强版规格。",
          "example": "pro_10k_1"
        },
        {
          "name": "AuthorizationPolicy",
          "type": "boolean",
          "required": false,
          "description": "授权策略开关",
          "example": "false"
        },
        {
          "name": "UseDefaultServerCert",
          "type": "boolean",
          "required": false,
          "description": "是否使用默认的服务端证书",
          "example": "false"
        },
        {
          "name": "X509Mode",
          "type": "string",
          "required": false,
          "description": "TLS：单向认证 mTLS；双向认证 BYOC：一机一证",
          "example": "BYOC"
        },
        {
          "name": "MessageRate",
          "type": "integer",
          "required": false,
          "description": "单客户端消息收发限速单位 条/秒",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyInstanceCertBinding",
      "description": "更新MQTT集群绑定证书 参数传空，则为删除证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "X509Mode",
          "type": "string",
          "required": true,
          "description": "加密通信方式 TLS：单向证书认证 mTLS：双向证书认证 BYOC：一设备一证书认证",
          "example": "TLS"
        },
        {
          "name": "SSLServerCertId",
          "type": "string",
          "required": false,
          "description": "服务端证书id，从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS或BYOC时为必填。",
          "example": "N4XIbZic"
        },
        {
          "name": "SSLCaCertId",
          "type": "string",
          "required": false,
          "description": "CA证书id，从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS时为必填",
          "example": "N4idIbZiE"
        },
        {
          "name": "DeviceCertificateProvisionType",
          "type": "string",
          "required": false,
          "description": "设备证书注册类型： JITP：自动注册； API：手动注册 默认值：API",
          "example": "JITP"
        },
        {
          "name": "AutomaticActivation",
          "type": "boolean",
          "required": false,
          "description": "是否自动激活，默认为false",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId",
        "X509Mode"
      ]
    },
    {
      "name": "ModifyJWKSAuthenticator",
      "description": "修改MQTT JWKS 认证器，全量配置修改，需要提交完整的修改后配置。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Endpoint",
          "type": "string",
          "required": false,
          "description": "JWKS服务器地址，（Text字段和Endpoint字段必须选择一个填写）",
          "example": "127.0.0.1"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器状态：open-启用（默认）；close-关闭",
          "example": "open"
        },
        {
          "name": "RefreshInterval",
          "type": "integer",
          "required": false,
          "description": "认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址时生效。",
          "example": "60"
        },
        {
          "name": "Text",
          "type": "string",
          "required": false,
          "description": "JWKS文本，认证服务器地址为空时生效。（Text字段和Endpoint字段必须选择一个填写）",
          "example": "text"
        },
        {
          "name": "From",
          "type": "string",
          "required": false,
          "description": "认证字段； username-对应 MQTT CONNECT Packet 中 username 字段， password-对应 MQTT CONNECT Packet 中 password 字段。默认username",
          "example": "username"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，不能超过 128 个字符",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyJWTAuthenticator",
      "description": "修改MQTT JWKS 认证器",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Algorithm",
          "type": "string",
          "required": false,
          "description": "签名方式：hmac-based，public-key",
          "example": "hmac-based"
        },
        {
          "name": "From",
          "type": "string",
          "required": false,
          "description": "认证字段 password：对应 MQTT CONNECT Packet 中 password 字段， username：对应 MQTT CONNECT Packet 中 username 字段",
          "example": "username"
        },
        {
          "name": "Secret",
          "type": "string",
          "required": false,
          "description": "密钥，Algorithm为hmac-based需要传递该字段。",
          "example": "your-secret"
        },
        {
          "name": "PublicKey",
          "type": "string",
          "required": false,
          "description": "公钥，Algorithm为public-key时需要传递该字段。",
          "example": " -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "认证器是否开启：open-启用；close-关闭",
          "example": "open"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "说明，不能超过 128 个字符",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyMessageEnrichmentRule",
      "description": "修改消息属性增强规则 注意：需要提交当前规则的所有属性，即使某些字段没有修改。",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "消息属性增强规则ID",
          "example": "1"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "RuleName",
          "type": "string",
          "required": false,
          "description": "策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。",
          "example": "rule1"
        },
        {
          "name": "Condition",
          "type": "string",
          "required": false,
          "description": "规则匹配条件，JSON格式，需要Base64编码 样例 {\"clientId\":\"client-1\",\"username\":\"client-1\",\"topic\":\"home/room1\"} Base64后 eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9",
          "example": "eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9"
        },
        {
          "name": "Actions",
          "type": "string",
          "required": false,
          "description": "规则执行的动作，JSON格式，需要Base64编码 样例 {\"messageExpiryInterval\":360,\"responseTopic\":\"replies/${clientid}\",\"correlationData\":\"${traceid}\",\"userProperty\":[{\"key\":\"trace-id\",\"value\":\"${traceid}\"}]} BASE64后 eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0=",
          "example": "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2VUb3BpYyI6InJlcGxpZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9XX0="
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": false,
          "description": "规则优先级，数字越小，优先级越高，高优先级覆盖低优先级。UserProperty字段会合并",
          "example": "1"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "策略状态。 0:未定义；1:激活；2:不激活；默认不激活",
          "example": "1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注信息，最长 128 字符",
          "example": "remark"
        }
      ],
      "required": [
        "Id",
        "InstanceId"
      ]
    },
    {
      "name": "ModifyTopic",
      "description": "修改主题属性",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "主题，不能为空，只能包含字母、数字、“-”及“_”，3-100 字符。",
          "example": "sample-topic-name"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注信息，最长 128 字符",
          "example": "additional-remark"
        }
      ],
      "required": [
        "InstanceId",
        "Topic"
      ]
    },
    {
      "name": "ModifyUser",
      "description": "修改MQTT角色",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Username",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "user"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注，长度不超过128个字符。",
          "example": "remark"
        }
      ],
      "required": [
        "InstanceId",
        "Username"
      ]
    },
    {
      "name": "PublishMessage",
      "description": "发布 MQTT 消息到消息主题或客户端",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Payload",
          "type": "string",
          "required": true,
          "description": "消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码",
          "example": "Hello MQTT!"
        },
        {
          "name": "TargetTopic",
          "type": "string",
          "required": false,
          "description": "消息目的主题，该参数与 TargetClientId 二选一",
          "example": "test/a/b"
        },
        {
          "name": "TargetClientId",
          "type": "string",
          "required": false,
          "description": "消息目的客户端 ID，该参数与 TargetTopic 二选一",
          "example": "myclient0001"
        },
        {
          "name": "Encoding",
          "type": "string",
          "required": false,
          "description": "消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）",
          "example": "plain"
        },
        {
          "name": "Qos",
          "type": "integer",
          "required": false,
          "description": "消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。",
          "example": "1"
        },
        {
          "name": "Retain",
          "type": "boolean",
          "required": false,
          "description": "是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId",
        "Payload"
      ]
    },
    {
      "name": "RegisterCaCertificate",
      "description": "注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "CaCertificate",
          "type": "string",
          "required": true,
          "description": "CA证书内容，自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA",
          "example": "-----BEGIN CERTIFICATE-----\\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n"
        },
        {
          "name": "VerificationCertificate",
          "type": "string",
          "required": true,
          "description": "验证证书内容，可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节",
          "example": "-----BEGIN CERTIFICATE-----\\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n"
        },
        {
          "name": "Format",
          "type": "string",
          "required": false,
          "description": "证书格式，不传默认PEM格式，当前仅支持PEM格式",
          "example": "PEM"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "证书状态，不传默认ACTIVE状态 ACTIVE：激活 INACTIVE：未激活",
          "example": "ACTIVE"
        }
      ],
      "required": [
        "InstanceId",
        "CaCertificate",
        "VerificationCertificate"
      ]
    },
    {
      "name": "RegisterDeviceCertificate",
      "description": "注册设备证书（仅一机一证场景生效），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8)",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-12345"
        },
        {
          "name": "DeviceCertificate",
          "type": "string",
          "required": true,
          "description": "设备证书内容，可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成",
          "example": "-----BEGIN CERTIFICATE-----END CERTIFICATE-----"
        },
        {
          "name": "CaSn",
          "type": "string",
          "required": true,
          "description": "关联的CA证书SN",
          "example": "7439e17052ff2edbeda4f5db379a69fd8c5f48a5"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "客户端ID，需要关联该证书的客户端ID。根据实际业务使用填写",
          "example": "VIN0001"
        },
        {
          "name": "Format",
          "type": "string",
          "required": false,
          "description": "证书格式，默认为PEM，当前仅支持PEM格式",
          "example": "PEM"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "客户端证书状态，默认激活状态（ACTIVE） ACTIVE：激活 INACTIVE：未激活",
          "example": "ACTIVE"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceCertificate",
        "CaSn"
      ]
    },
    {
      "name": "RevokedDeviceCertificate",
      "description": "吊销设备证书",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "mqtt-1234567"
        },
        {
          "name": "DeviceCertificateSn",
          "type": "string",
          "required": true,
          "description": "设备证书序列号",
          "example": "eef68a582b94254296e54ce754f94d707a59912"
        }
      ],
      "required": [
        "InstanceId",
        "DeviceCertificateSn"
      ]
    },
    {
      "name": "UpdateAuthorizationPolicyPriority",
      "description": "修改策略规则优先级",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-xxxx"
        },
        {
          "name": "Priorities",
          "type": "array",
          "required": false,
          "description": "策略ID和优先级",
          "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]",
          "item_type": "object",
          "children": [
            {
              "name": "Id",
              "type": "integer",
              "required": true,
              "description": "授权策略规则id，可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。",
              "example": "1"
            },
            {
              "name": "Priority",
              "type": "integer",
              "required": true,
              "description": "优先级",
              "example": "1"
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "UpdateMessageEnrichmentRulePriority",
      "description": "修改消息属性增强规则优先级",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。",
          "example": "mqtt-x"
        },
        {
          "name": "Priorities",
          "type": "array",
          "required": false,
          "description": "策略ID和优先级",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Id",
              "type": "integer",
              "required": true,
              "description": "消息属性增强规则id",
              "example": "1"
            },
            {
              "name": "Priority",
              "type": "integer",
              "required": true,
              "description": "优先级",
              "example": "1"
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    }
  ]
}