RegisterDeviceCredential - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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****

Note

For information about other parameters, see Common parameters and Endpoints.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This parameter is a common parameter.	E4581CCF-62AF-44D9-B5B4-D1DBDC0E****
DeviceCredential	object	The access credential of the device.
UpdateTime	integer	The timestamp that indicates when the access credential of the device was last updated. Unit: milliseconds.	1605541382000
DeviceAccessKeyId	string	The AccessKey ID of the device.	DC.Z5fXh9sRRVufyLi6wo****
CreateTime	integer	The timestamp that indicates when the access credential of the device was created. Unit: milliseconds.	1605541382000
InstanceId	string	The ID of the ApsaraMQ for MQTT instance.	post-cn-0pp12gl****
DeviceAccessKeySecret	string	The AccessKey secret of the device.	DC.BJMkn4eMQJK2vaApTS****
ClientId	string	The client ID of the device.	GID_test@@@test

Examples

Success response

JSON format

{
  "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	DeviceCredentialNotFound	Device Credential Not Found.Check if the device certificate is registered.
400	DeviceCredentialExsit	Device Credential Exsit.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.