GetDeviceCredential - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the access credential of a device. If unique-certificate-per-device authentication is used as the authentication method on an ApsaraMQ for MQTT broker, an access credential that you apply for in advance is required for authentication when you connect your device to the broker. The connection can be established 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. 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 GetDeviceCredential operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientId	string	Yes	The client ID of the device whose access credential you want to query.	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID. This parameter is a common parameter.	E4581CCF-62AF-44D9-B5B4-D1DQDC0E****
DeviceCredential	object	The information about the access credential of the device.
UpdateTime	long	The timestamp that indicates when the access credential of the device was last updated. The value of this parameter is a UNIX timestamp in milliseconds.	1605541382000
DeviceAccessKeyId	string	The AccessKey ID of the device.	DC.Z5fXh9sRRVufyLi6wo****
CreateTime	long	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

Sample success responses

JSONformat

{
  "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DQDC0E****",
  "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.
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
2024-04-25	The Error code has changed	View Change Details