Esta página de ajuda lista os códigos de erro comuns encontrados ao trabalhar com as APIs REST do OpManager. Cada entrada de erro inclui o código de erro, a descrição e uma resposta de exemplo.
Descrição: Disparado quando o tipo do parâmetro fornecido não corresponde ao tipo esperado.
{
"error": {
"message": "O parâmetro 'deviceId' deve ser do tipo inteiro.",
"errorcode": "DATATYPE_NOT_MATCHED"
}
}Descrição: Ocorre quando um parâmetro obrigatório está ausente ou aparece menos vezes do que o exigido.
{
"error": {
"message": "O parâmetro 'deviceIds' é obrigatório e deve ter pelo menos 1 ocorrência.",
"errorcode": "LESS_THAN_MIN_OCCURANCE"
}
}Descrição: Ocorre quando um parâmetro aparece mais vezes do que o permitido.
{
"error": {
"message": "O parâmetro 'deviceIds' deve ter no máximo apenas 5 ocorrências.",
"errorcode": "MORE_THAN_MAX_OCCURANCE"
}
}Descrição: Ocorre quando o valor de entrada é menor do que o tamanho mínimo exigido.
{
"error": {
"message": "O parâmetro 'username' deve ter um tamanho mínimo de 3.",
"errorcode": "LESS_THAN_MIN_LENGTH"
}
}Descrição: Ocorre quando o valor de entrada excede o tamanho máximo permitido.
{
"error": {
"message": "O parâmetro 'description' deve ter um tamanho máximo de 200.",
"errorcode": "MORE_THAN_MAX_LENGTH"
}
}Descrição: Ocorre quando a entrada contém conteúdo potencialmente malicioso ou inseguro (XSS).
{
"error": {
"message": "Entrada ilegal detectada no parâmetro 'comments'.",
"errorcode": "XSS_DETECTED"
}
}Descrição: Ocorre quando o valor do parâmetro não corresponde ao padrão regex definido.
{
"error": {
"message": "A entrada especificada para o parâmetro 'email' não corresponde ao padrão exigido.",
"errorcode": "PATTERN_NOT_MATCHED"
}
}Descrição: Ocorre quando o sistema falha ao converter um parâmetro para o tipo de dado esperado.
{
"error": {
"message": "O parâmetro 'port' deve ser do tipo inteiro.",
"errorcode": "UNABLE_TO_PARSE_DATA_TYPE"
}
}Descrição: Ocorre quando o valor do parâmetro está fora da faixa numérica ou lógica definida.
{
"error": {
"message": "O valor do parâmetro 'age' não está dentro da faixa esperada.",
"errorcode": "OUT_OF_RANGE"
}
}Descrição: Ocorre quando um parâmetro é fornecido, mas seu valor está vazio.
{
"error": {
"message": "O parâmetro 'deviceName' não deve estar vazio.",
"errorcode": "EMPTY_VALUE_NOT_ALLOWED"
}
}Descrição: Ocorre quando uma requisição contém parâmetros não definidos ou não esperados pela API.
{
"error": {
"message": "Parâmetro irrelevante encontrado na requisição.",
"errorcode": "EXTRA_PARAM_FOUND"
}
}Descrição: Disparado quando a URL solicitada não corresponde a nenhum endpoint de API configurado.
{
"error": {
"message": "A URL especificada é inválida.",
"errorcode": "URL_RULE_NOT_CONFIGURED"
}
}Descrição: Ocorre quando o corpo JSON não pode ser processado devido a erros de sintaxe ou formato.
{
"error": {
"message": "Erro ao processar os dados JSON de 'deviceDetails'.",
"errorcode": "JSON_PARSE_ERROR"
}
}Descrição: Ocorre quando o tamanho de um parâmetro de array está fora da faixa permitida.
{
"error": {
"message": "O tamanho de 'deviceIds' deve estar na faixa de 1-10.",
"errorcode": "ARRAY_SIZE_OUT_OF_RANGE"
}
}Descrição: Ocorre quando um parâmetro de query ou formulário obrigatório está ausente na requisição.
{
"error": {
"message": "O parâmetro 'action' é obrigatório para processar a requisição.",
"errorcode": "URL_ACTION_PARAM_MISSING"
}
}Descrição: Ocorre quando a mesma API é acessada com muita frequência e excede o limite de throttling.
{
"error": {
"message": "O limite de throttling da API foi excedido. Tente novamente mais tarde.",
"errorcode": "URL_ROLLING_THROTTLES_LIMIT_EXCEEDED"
}
}Descrição: Ocorre quando a requisição usa um método HTTP não suportado (por exemplo, usar GET em vez de POST).
{
"error": {
"message": "Método de requisição inválido.",
"errorcode": "INVALID_METHOD"
}
}Descrição: Ocorre quando o valor de um parâmetro é inválido, como estar fora de uma lista de enum permitida.
{
"error": {
"message": "Valor inválido especificado para o parâmetro 'status'.",
"errorcode": "INVALID_VALUE_NOT_ALLOWED"
}
}Descrição: Ocorre quando o arquivo enviado possui uma extensão de arquivo não suportada.
{
"error": {
"message": "Extensão de arquivo inválida.",
"errorcode": "INVALID_FILE_EXTENSION"
}
}Descrição: Ocorre quando o tipo MIME do arquivo enviado não corresponde aos tipos esperados.
{
"error": {
"message": "Tipo de arquivo não suportado detectado.",
"errorcode": "UNMATCHED_FILE_CONTENT_TYPE"
}
}Descrição: Ocorre quando o arquivo enviado excede o limite máximo de tamanho permitido.
{
"error": {
"message": "O tamanho do arquivo é maior do que o tamanho máximo permitido (1024 KB).",
"errorcode": "FILE_SIZE_MORE_THAN_ALLOWED_SIZE"
}
}Descrição: Ocorre quando um arquivo enviado possui zero bytes.
{
"error": {
"message": "O arquivo enviado está vazio.",
"errorcode": "EMPTY_FILE_NOT_ALLOWED"
}
}Descrição: Disparado quando o token CSRF é inválido ou expirou. Aplica-se apenas a requisições baseadas em navegador.
{
"error": {
"message": "Problema ao processar a requisição. Recarregue a página e tente novamente.",
"errorcode": "INVALID_CSRF_TOKEN"
}
}Essas entradas representam objetos de erro da API XML retornados para várias condições. Status HTTP típico: 500.
{
"error": { "code": 5000, "message": "A URL especificada está incorreta." }
}{
"error": { "code": 5000, "message": "A apiKey especificada não é válida. Falha na autenticação." }
}{
"error": { "code": 5000, "message": "Erro interno do servidor ao processar esta requisição." }
}{
"error": { "code": 5000, "message": "Uma requisição HTTP {0} é necessária para executar esta operação." }
}{
"error": { "code": 5000, "message": "O parâmetro apiKey não está disponível na requisição." }
}Descrição: Indica que certas APIs ou operações estão desabilitadas na versão de demonstração.
{
"error": {
"message": "Este recurso está desabilitado na versão de demonstração.",
"errorcode": "DEMO_NOT_ALLOWED"
}
}Descrição: Indica que a URL solicitada é inválida ou restrita pelas configurações atuais.
{
"error": {
"message": "O endpoint de API solicitado não é válido.",
"errorcode": "URL_INVALID"
}
}Descrição: Indica que o uso da API REST foi desabilitado para o usuário ou configuração atual.
{
"error": {
"message": "O acesso à API REST está desabilitado para este usuário.",
"errorcode": "REST_API_NOT_ALLOWED"
}
}Descrição: Ocorre quando um usuário tenta executar uma ação não autorizada.
{
"error": {
"message": "O usuário não está autorizado a executar esta ação.",
"errorcode": "AUTHORIZATION_FAILED"
}
}Descrição: Ocorre quando as credenciais de autenticação (como chave de API ou token) são inválidas.
{
"error": {
"message": "Falha na autenticação. Credenciais inválidas ou sessão expirada.",
"errorcode": "AUTHENTICATION_FAILURE"
}
}Obrigado pelo seu feedback!