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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

DescribeLogMonitorAttribute

Operação a ser executada. Defina o valor como DescribeLogMonitorAttribute.

MetricName

String

Sim

cpu_total

Nome da métrica de monitoramento de log. Aceita correspondência exata.

Para mais informações, consulte Apêndice 1: Métricas.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	Código de status HTTP. Nota O código 200 indica que a chamada foi bem-sucedida.
LogMonitor	Struct	N/A	Detalhes da métrica de monitoramento de log.
Aggregates	Array of Aggregate	N/A	Funções de agregação.
Alias	String	HostName	Alias da função de agregação.
FieldName	String	hostName	Nome do campo nos logs.
Function	String	count	Função usada para agregar dados de monitoramento de logs em um período de agregação. Valores válidos: count: conta a quantidade. sum: calcula o valor total. avg: calcula a média. max: seleciona o valor máximo. min: seleciona o valor mínimo. countps: divide a contagem do campo especificado pelo total de segundos do período de agregação. sumps: divide o valor total do campo especificado pelo total de segundos do período de agregação. distinct: conta quantos logs contêm o campo especificado no período de agregação.
Max	String	10	Valor máximo.
Min	String	0	Valor mínimo.
GmtCreate	Long	1547431398000	Momento de criação da métrica de monitoramento de log. Este valor é um timestamp UNIX que representa os milissegundos decorridos desde a época (epoch time) de 1º de janeiro de 1970, 00:00:00 UTC.
GroupId	Long	12345	ID do grupo de aplicativos.
Groupbys	List	value	Dimensão de agrupamento dos dados. Equivale à cláusula GROUP BY em instruções SQL. Sem essa dimensão, o sistema agrega todos os dados conforme a função de agregação.
LogId	Long	1234	ID retornado pelo Log Service.
MetricExpress	String	{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}	Campo estendido. Permite executar operações básicas nos resultados da agregação. Por exemplo, após agregar os dados para obter TotalNumber e 5XXNumber, onde TotalNumber é o total de solicitações HTTP e 5XXNumber são aquelas com código de status superior a 499, calcule a taxa de erro do servidor adicionando a fórmula 5XXNumber/TotalNumber*100 ao campo estendido.
MetricName	String	cpu_total	Nome da métrica de monitoramento de log. Para mais informações, consulte Apêndice 1: Métricas.
SlsLogstore	String	test-logstore	Nome do Logstore do Log Service.
SlsProject	String	test-project	Nome do projeto do Log Service.
SlsRegionId	String	cn-hangzhou	ID da região onde reside o Logstore do Log Service.
Tumblingwindows	List	60	Tamanho da janela deslizante para cálculo. Unidade: segundos. O sistema realiza uma agregação por janela deslizante.
ValueFilter	Array of ValueFilterObject	N/A	Condição para filtrar logs. Use os parâmetros ValueFilter e ValueFilterRelation em conjunto. Essa condição equivale à cláusula WHERE em instruções SQL. Sem condição de filtro, o sistema processa todos os logs. Por exemplo, se os logs tiverem o campo Level definido como Error e você precisar calcular a frequência desse nível por minuto, defina a condição como Level=Error e conte os registros correspondentes.
Key	String	hostName	Nome do campo de log usado na correspondência da condição de filtro.
Operator	String	contain	Método de correspondência do valor do campo. Valores válidos: `contain` `notContain` `>`: maior que `<`: menor que `>=`: maior ou igual a `<=`: menor ou igual a
Value	String	portal	Valor do campo a ser correspondido na condição de filtro.
ValueFilterRelation	String	and	Operador lógico entre as condições de filtro de log. Use os parâmetros ValueFilter e ValueFilterRelation em conjunto. Valores válidos: and or
Message	String	successful	Mensagem retornada. Retorna "success" em caso de êxito ou uma mensagem de erro em caso de falha.
RequestId	String	C6718537-E673-4A58-8EE1-24B8B38C7AAE	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: chamada bem-sucedida. false: falha na chamada.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeLogMonitorAttribute
&MetricName=cpu_total
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<DescribeLogMonitorAttributeResponse>
          <Message>successful</Message>
          <RequestId>BBD7B294-1325-46D1-BD08-848D6A6B9AC6</RequestId>
          <LogMonitor>
                <SlsProject>slsProject</SlsProject>
                <Tumblingwindows>60</Tumblingwindows>
                <SlsLogstore>slsLogstore</SlsLogstore>
                <MetricExpress>{"extend":{}}</MetricExpress>
                <GroupId>12345</GroupId>
                <MetricName>cpu_total</MetricName>
                <GmtCreate>1577766395000</GmtCreate>
                <Aggregates>
                      <Function>count</Function>
                      <Min></Min>
                      <Max></Max>
                      <Alias>lh_source_count</Alias>
                      <FieldName>lh_source</FieldName>
                </Aggregates>
                <ValueFilterRelation>and</ValueFilterRelation>
                <ValueFilter>
                      <Operator>contais</Operator>
                      <Value>test</Value>
                      <Key>hostName</Key>
                </ValueFilter>
                <LogId>1234</LogId>
                <SlsRegionId>cn-hangzhou</SlsRegionId>
          </LogMonitor>
          <Code>200</Code>
          <Success>true</Success>
</DescribeLogMonitorAttributeResponse>

Formato JSON

{
  "Message": "successful",
  "RequestId": "BBD7B294-1325-46D1-BD08-848D6A6B9AC6",
  "LogMonitor": {
    "SlsProject": "slsProject",
    "Tumblingwindows": [
      60
    ],
    "SlsLogstore": "slsLogstore",
    "MetricExpress": "{\"extend\":{}}",
    "GroupId": 12345,
    "MetricName": "cpu_total",
    "GmtCreate": 1577766395000,
    "Aggregates": [
      {
        "Function": "count",
        "Min": "",
        "Max": "",
        "Alias": "lh_source_count",
        "FieldName": "lh_source"
      }
    ],
    "Groupbys": [],
    "ValueFilterRelation": "and",
    "ValueFilter": [
      {
        "Operator": "contais",
        "Value": "test",
        "Key": "hostName"
      }
    ],
    "LogId": 1234,
    "SlsRegionId": "cn-hangzhou"
  },
  "Code": 200,
  "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.