Release Notes
Domain name for API request: mqtt.intl.tencentcloudapi.com.
This API is used to create a performance test task for an MQTT instance.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAuthorizationPolicy. |
| Version | Yes | String | Common Params. The value used for this API: 2024-05-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | tencent cloud MQTT instance ID, obtained from the DescribeInstanceList api or console. |
| PolicyName | Yes | String | Policy name, which cannot be empty, contains 3 to 64 characters, and supports chinese, letters, digits, "-", and "_". |
| PolicyVersion | Yes | Integer | Policy version, defaults to 1. currently only support 1. |
| Priority | Yes | Integer | Policy priority. a smaller value indicates higher priority and must be unique. a smaller priority ID means the policy takes effect with higher priority. see data plane authorization policy description. |
| Effect | Yes | String | Specifies the decision. allow specifies permission for access requests from devices that match this policy. deny: denies access requests to the device that override the policy. Refer to the data plane authorization policy description. |
| Actions | Yes | String | Operation, supports multiple selections separated by commas. see the data plane policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1). Specifies the connection. Specifies the publish action. Sub. specifies the subscription. |
| Retain | Yes | Integer | Condition - message retention. refer to the data plane authorization policy description. Matches message retention. Matches non-retention messages. 3. match retained and non-retained messages. |
| Qos | Yes | String | Condition: specifies the service quality. 0: at most once. Minimum once. 2: exactly once. Refer to the data plane authorization policy description. |
| Resources | No | String | Specifies the resource and subscription to match. supports configuration of multiple match rules, separated by commas. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1). |
| Username | No | String | Specifies the condition-username. |
| ClientId | No | String | Client ID. supports regular expressions. |
| Ip | No | String | Specifies the client IP address, supporting IP or CIDR. refer to the data plane authorization policy description. |
| Remark | No | String | Specifies the remark information with a maximum length of 128 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Cluster ID |
| Id | Integer | Policy ID |
| RequestId | String | 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. |
POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAuthorizationPolicy
<Common request parameters>
{
"InstanceId": "mqtt-xxx",
"PolicyName": "name1",
"PolicyVersion": 1,
"Priority": 4,
"Effect": "allow",
"Actions": "pub",
"Retain": 1,
"Qos": "2"
}{
"Error": null,
"RequestId": null,
"Response": {
"Id": 6,
"InstanceId": "mqtt-xxx",
"RequestId": "2e477c8c-abef-46e2-bde3-29433b34f309"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DuplicatePolicy | DuplicatePolicy |
| FailedOperation.DuplicatePriority | DuplicatePriority |
| FailedOperation.InstanceNotReady | FailedOperation.InstanceNotReady |
| ResourceNotFound.Instance | ResourceNotFound.Instance |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback