Adiciona informações de autenticação de conta, que podem ser especificadas no nível do cliente.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceId |
string |
Sim |
O ID da instância do ApsaraMQ for MQTT. |
mqtt-cn-xxxx |
| Username |
string |
Sim |
O nome de usuário. |
test |
| Secret |
string |
Sim |
O segredo. |
xxxxx |
| IdentityType |
string |
Sim |
O tipo de identidade.\n\n- USER: Apenas nome de usuário.\n\n- CLIENT: Específico para um cliente. |
USER |
| ClientId |
string |
Não |
O ID de cliente do dispositivo. Especifique este parâmetro quando o tipo de identidade for CLIENT. |
GID_test@@@test |
| SignMode |
string |
Sim |
O método de verificação de assinatura. Valores válidos:\n- ORIGIN: Comparação de valor original. A senha é comparada com o segredo.\n- SIGNED: Verificação de assinatura. Uma assinatura HmacSHA1 é gerada para o clientId usando o segredo e, em seguida, a assinatura é comparada com a senha. |
SIGNED |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| RequestId |
string |
O ID da solicitação. |
020F6A43-19E6-4B6E-B846-44EB31DF**** |
| Code |
integer |
O código de status. O valor 200 indica sucesso. |
200 |
| Success |
boolean |
Indica se a operação é bem-sucedida. O valor true indica sucesso e o valor false indica falha. |
True |
| Message |
string |
A mensagem retornada. |
operation success. |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Code": 200,
"Success": true,
"Message": "operation success."
}Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. | A verificação de permissão da instância falhou. Verifique a propriedade e a política de acesso da instância MQTT. |
| 400 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. | A verificação de parâmetros falhou. Um parâmetro pode estar ausente ou conter um valor inválido. |
| 400 | Customauth.over.capacity | Over custom auth capacity. | O número de permissões personalizadas excede o limite. |
| 404 | ApiNotSupport | The specified API is not supported. | A operação atual não é suportada. Verifique a solicitação. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.