Registers an access credential for a device. In unique-certificate-per-device authentication mode, an application server applies a unique access credential for each device from the corresponding ApsaraMQ for MQTT broker. The access credential of a device consists of the client ID, AccessKey ID, and AccessKey secret of the device. When you connect a device to ApsaraMQ for MQTT, you must configure Username and Password based on the access credential of the device for authentication. You can activate the device and transfer data between the device and ApsaraMQ for MQTT only after the authentication is passed.
Operation description
- You can call this operation up to 500 times per second per account. If the limit is exceeded, throttling is triggered. This may affect your business. We recommend that you take note of this limit when you call this operation. For more information, see Limits on QPS.
- Each successful call to the RegisterDeviceCredential operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| mq:RegisterDeviceCredential | create | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientId | string | Yes | The client ID of the device for which you want to create an access credential. | GID_test@@@test |
| InstanceId | string | Yes | The ID of the ApsaraMQ for MQTT instance. The ID must be consistent with the ID of the instance that the ApsaraMQ for MQTT client uses. You can obtain the instance ID on the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console. | post-cn-0pp12gl**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBDC0E****",
"DeviceCredential": {
"UpdateTime": 1605541382000,
"DeviceAccessKeyId": "DC.Z5fXh9sRRVufyLi6wo****",
"CreateTime": 1605541382000,
"InstanceId": "post-cn-0pp12gl****",
"DeviceAccessKeySecret": "DC.BJMkn4eMQJK2vaApTS****",
"ClientId": "GID_test@@@test"
}
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | ApplyTokenOverFlow | You have applied for tokens too many times. Please try again later. |
| 400 | CheckAccountInfoFailed | An error occurred while checking the account information by the STS token. |
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. |
| 400 | ParameterCheckFailed | An error occurred while validating the parameters. The parameters may be missing or invalid. |
| 400 | PermissionCheckFailed | An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings. |
| 400 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. |
| 400 | DeviceCredentialNumExceed | The number of device credentia exceeds the limit. Please revoke unused device certificates |
| 400 | DeviceCredentialExsit | Device Credential Exsit |
| 400 | DeviceCredentialNotFound | Device Credential Not Found. Check if the device certificate is registered |
| 404 | ApiNotSupport | The specified API is not supported. |
| 500 | InternalError | An error occurred while processing your request. Try again later. |
| 500 | SystemOverFlow | An error occurred while processing your request. Please try again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-04-06 | The Error code has changed | View Change Details |