RegisterDeviceCredential - - Centre de documentation Alibaba Cloud

Limites

Vous pouvez appeler cette opération d'API jusqu'à 500 fois par seconde et par compte. Les requêtes dépassant cette limite sont rejetées, ce qui entraîne des interruptions de service. Tenez compte de cette limite lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Limites QPS.

Remarque

Les appels réussis à l'opération

RegisterDeviceCredential

sont facturés. Chaque appel réussi augmente le nombre de transactions par seconde (TPS) d'une unité. Pour plus d'informations, consultez la rubrique

Facturation

.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de simplicité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

L'opération que vous souhaitez effectuer. Définissez la valeur sur RegisterDeviceCredential.

|

ID client de l'appareil pour lequel vous souhaitez créer un identifiant d'accès.

|

ID de l'instance ApsaraMQ forMQTT. La valeur doit correspondre à l'ID d'instance utilisé par le client ApsaraMQ forMQTT. Vous pouvez obtenir l'ID d'instance sur la page Instance Details de la console ApsaraMQ forMQTT.

|

ID de région de l'instance ApsaraMQ forMQTT.

|

Remarque

Pour plus d'informations sur les paramètres, consultez les rubriques

Paramètres communs

et

Endpoints

.

Paramètres de réponse

Paramètre

Type

Exemple

Description

| DeviceCredential | Struct | |

Identifiant d'accès de l'appareil.

|

| ClientId | String | GID_test@@@test |

ID client de l'appareil.

|

| CreateTime | Long | 1605541382000 |

Horodatage de création de l'identifiant d'accès de l'appareil. Unité : millisecondes.

|

| DeviceAccessKeyId | String | DC.Z5fXh9sRRVufyLi6wo**** |

ID AccessKey de l'appareil.

|

| DeviceAccessKeySecret | String | DC.BJMkn4eMQJK2vaApTS**** |

Clé secrète AccessKey de l'appareil.

|

| InstanceId | String | post-cn-0pp12gl**** |

ID de l'instance ApsaraMQ forMQTT.

|

| UpdateTime | Long | 1605541382000 |

Horodatage de la dernière mise à jour de l'identifiant d'accès de l'appareil. Unité : millisecondes.

|

| RequestId | String | E4581CCF-62AF-44D9-B5B4-D1DBDC0E**** |

ID de la requête.

|

Exemples

Exemples de requêtes

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=RegisterDeviceCredential
&ClientId=GID_test@@@test
&InstanceId=post-cn-0pp12gl****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemples de réponses réussies

XML format

<RegisterDeviceCredentialResponse>
  <RequestId>E4581CCF-62AF-44D9-B5B4-D1DBDC0E****</RequestId>
  <DeviceCredential>
        <InstanceId>post-cn-0pp12gl****</InstanceId>
        <DeviceAccessKeySecret>DC.BJMkn4eMQJK2vaApTS****</DeviceAccessKeySecret>
        <CreateTime>1605541382000</CreateTime>
        <UpdateTime>1605541382000</UpdateTime>
        <DeviceAccessKeyId>DC.Z5fXh9sRRVufyLi6wo****</DeviceAccessKeyId>
        <ClientId>GID_test@@@test</ClientId>
  </DeviceCredential>
</RegisterDeviceCredentialResponse>

JSON format

{
    "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBDC0E****",
    "DeviceCredential": {
        "InstanceId": "post-cn-0pp12gl****",
        "DeviceAccessKeySecret": "DC.BJMkn4eMQJK2vaApTS****",
        "CreateTime": 1605541382000,
        "UpdateTime": 1605541382000,
        "DeviceAccessKeyId": "DC.Z5fXh9sRRVufyLi6wo****",
        "ClientId": "GID_test@@@test"
    }
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
404	ApiNotSupport	The specified API is not supported.	Le message d'erreur indique que l'opération n'est pas prise en charge.
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.	Le message d'erreur indique que des jetons sont fréquemment demandés et que la limitation du débit est déclenchée. Réessayez ultérieurement.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	Le message d'erreur indique que les informations de compte du jeton Security Token Service (STS) n'ont pas pu être analysées.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	Le message d'erreur indique que votre compte a échoué à la vérification des autorisations sur l'instance ApsaraMQ forMQTT. Vérifiez la propriété et la politique d'autorisation de l'instance.
500	InternalError	An error occurred while processing your request. Try again later.	Le message d'erreur indique que le service principal de l'instance ApsaraMQ forMQTT est anormal. Réessayez.
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.	Le message d'erreur indique que le paramètre n'a pas pu être vérifié. Le paramètre peut être manquant ou invalide.
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.	Le message d'erreur indique que votre compte a échoué à la vérification des autorisations sur les ressources spécifiées. Vérifiez la propriété et les politiques d'autorisation de l'instance, du sujet (topic) et du groupe spécifiés.
500	SystemOverFlow	An error occurred while processing your request. Please try again.	Le message d'erreur indique que la limitation du débit est déclenchée. Réessayez.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	Le message d'erreur indique que le paramètre n'a pas pu être vérifié. Le paramètre peut être manquant ou invalide.

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.