DescribeLogMonitorAttribute - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta uma tarefa de monitoramento de logs.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cms:DescribeLogMonitorAttribute

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
MetricName	string	Sim	O nome da métrica.	cpu_total_******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Nota Um código de status 200 indica uma solicitação bem-sucedida.	200
Message	string	A mensagem retornada.	The specified resource is not found.
RequestId	string	O ID da solicitação.	C6718537-E673-4A58-8EE1-24B8B38C7AAE
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true
LogMonitor	object	Os detalhes da tarefa de monitoramento de logs.
ValueFilterRelation	string	O operador lógico para as condições de filtro. Este parâmetro é usado com ValueFilter. Valores válidos: and: O operador lógico AND. or: O operador lógico OR.	and
SlsLogstore	string	O nome do Logstore do Simple Log Service.	logstore_******
MetricName	string	O nome da métrica.	cpu_total_******
GroupId	integer	O ID do grupo de aplicativos.	123******
LogId	integer	O ID da tarefa de monitoramento de logs.	123******
MetricExpress	string	A expressão da métrica.	{}
SlsRegionId	string	O ID da região onde o Simple Log Service está localizado.	cn-hangzhou
GmtCreate	integer	A hora em que a tarefa foi criada. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970.	1678440033000
SlsProject	string	O nome do projeto do Simple Log Service.	project_******
Aggregates	array<object>	As definições de agregações.
	object	A definição de uma agregação.
Max	string	The maximum value.	0
Min	string	The minimum value.	0
Function	string	The function that is used to aggregate log data in a statistical period. Valid values: count: Counts the number of logs. sum: Calculates the sum of values in a field. avg: Calculates the average of values in a field. max: Selects the maximum value in a field. min: Selects the minimum value in a field. countps: Calculates the average number of logs that are generated per second in a statistical period. sumps: Calculates the average sum of values in a field per second in a statistical period. distinct: Counts the number of unique values in a field in a statistical period.	count
Alias	string	The alias of the field.	alias_******
FieldName	string	The original name of the field in the log.	field_******
ValueFilter	array<object>	As condições de filtro. Este parâmetro é usado com ValueFilterRelation. Este parâmetro é equivalente à cláusula WHERE em uma instrução SQL. Se você não especificar este parâmetro, todos os dados serão processados. Por exemplo, se um log contiver um campo Level e você quiser contar o número de logs onde o valor de Level é Error, você pode definir a função de agregação como count e especificar uma condição de filtro onde Level seja igual a Error.
	object	A condição de filtro.
Key	string	The key.	key_******
Value	string	The value.	value_******
Operator	string	The operator that is used to match the field value. Valid values: `contain`: contains. `notContain`: does not contain. `>`: greater than. `<`: less than. `>=`: greater than or equal to. `<=`: less than or equal to.	contain
Tumblingwindows	array	A janela de pré-agregação. Unidade: segundos. O Cloud Monitor agrega dados na janela de pré-agregação especificada.
	string	A janela de pré-agregação. Unidade: segundos. O Cloud Monitor agrega dados na janela de pré-agregação especificada.	60
Groupbys	array	A dimensão com base na qual os dados de log são agregados. Este parâmetro é equivalente à cláusula GROUP BY em uma instrução SQL. Você pode especificar uma dimensão para agrupar dados de monitoramento. Se você não especificar este parâmetro, todos os dados de monitoramento serão agregados com base no método de agregação.
	string	A definição de group by.	userId

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "C6718537-E673-4A58-8EE1-24B8B38C7AAE",
  "Success": true,
  "LogMonitor": {
    "ValueFilterRelation": "and",
    "SlsLogstore": "logstore_******",
    "MetricName": "cpu_total_******",
    "GroupId": 0,
    "LogId": 0,
    "MetricExpress": "{}",
    "SlsRegionId": "cn-hangzhou",
    "GmtCreate": 1678440033000,
    "SlsProject": "project_******",
    "Aggregates": [
      {
        "Max": "0",
        "Min": "0",
        "Function": "count",
        "Alias": "alias_******",
        "FieldName": "field_******"
      }
    ],
    "ValueFilter": [
      {
        "Key": "key_******",
        "Value": "value_******",
        "Operator": "contain"
      }
    ],
    "Tumblingwindows": [
      "60"
    ],
    "Groupbys": [
      "userId"
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.