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

Consulta tarefas de importação de métricas.

Descrição da operação

Este tópico fornece um exemplo de como consultar todas as tarefas de importação de métricas que pertencem à conta atual do Alibaba Cloud. O resultado retornado indica que a conta atual possui apenas uma tarefa de importação de métricas. A tarefa de importação de métricas é denominada aliyun_task.

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:DescribeHybridMonitorTaskList

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Keyword	string	Não	A palavra-chave usada para a pesquisa.	task
TaskId	string	Não	O ID da tarefa de importação de métricas.	36****
GroupId	string	Não	O ID do grupo de aplicações. Para obter informações sobre como obter o ID de um grupo de aplicações, consulte DescribeMonitorGroups.	3607****
Namespace	string	Não	O nome do namespace. Para obter informações sobre como obter o nome de um namespace, consulte DescribeHybridMonitorNamespaceList.	aliyun
PageSize	integer	Não	O número de entradas por página. As páginas começam a partir da página 1. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. As páginas começam a partir da página 1. Valor padrão: 1.	1
IncludeAliyunTask	boolean	Não	Especifica se o resultado retornado inclui tarefas de importação de métricas para serviços do Alibaba Cloud. Valores válidos: true (padrão): O resultado retornado inclui tarefas de importação de métricas para serviços do Alibaba Cloud. false: O resultado retornado exclui tarefas de importação de métricas para serviços do Alibaba Cloud.	true
TaskType	string	Não	O tipo da tarefa de importação de métricas. Valores válidos: aliyun_fc: tarefas de importação de métricas para serviços do Alibaba Cloud aliyun_sls: métricas de logs importados do Log Service Valores válidos: aliyun_sls : aliyun_sls.	aliyun_fc
TargetUserId	integer	Não	O ID da conta de membro. Nota Este parâmetro é obrigatório apenas se você usar uma conta de gerenciamento para chamar esta operação para excluir as tarefas de importação de métricas que pertencem a um membro em um diretório de recursos. Nesse caso, o parâmetro `TaskType` é definido como `aliyun_fc`.	120886317861****

Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
RequestId	string	O ID da solicitação.	11145B76-566A-5D80-A8A3-FAD98D310079
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Code	string	O código de status. Nota O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação foi bem-sucedida, o valor `successful` é retornado. Se a solicitação falhou, uma mensagem de erro é retornada.	success
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1
Total	integer	O número total de entradas retornadas.	1
TaskList	array<object>	As tarefas de importação de métricas.
	array<object>	Nenhum.
YARMConfig	string	O arquivo de configuração do serviço do Alibaba Cloud que você deseja monitorar usando o Hybrid Cloud Monitoring. namespace: o namespace do serviço do Alibaba Cloud. metric_list: as métricas do serviço do Alibaba Cloud.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
CreateTime	string	O timestamp de quando a tarefa de importação de métricas foi criada. Unidade: milissegundos.	1639382496000
TaskName	string	O nome da tarefa de importação de métricas.	aliyun_task
Namespace	string	O namespace ao qual o host pertence.	aliyun
UploadRegion	string	A região onde o host reside.	cn-hangzhou
NetworkType	string	O tipo de rede do host. Valores válidos: `vpc` `Internet`	vpc
CollectTimout	integer	O período de timeout durante o qual o agente do CloudMonitor coleta dados de monitoramento do host. Valores válidos: 0 15 30 60 Unidade: segundos.	15
CollectTargetEndpoint	string	A URL do destino do qual o agente do CloudMonitor coleta dados de monitoramento do host.	http://localhost
TaskType	string	O tipo da tarefa de importação de métricas. Valores válidos: aliyun_fc: tarefas de importação de métricas para serviços do Alibaba Cloud aliyun_sls: métricas de logs importados do Log Service	aliyun_sls
MatchExpressRelation	string	O relacionamento entre as condições usadas para filtrar tarefas de importação de métricas. Valores válidos: or and	or
Description	string	A descrição da tarefa de importação de métricas.	aliyun
GroupId	string	O ID do grupo de aplicações.	3607****
CollectInterval	integer	O intervalo no qual o agente do CloudMonitor coleta dados de monitoramento do host. Valores válidos: 15 30 60 Unidade: segundos.	60
TargetUserId	string	O ID da conta de membro. Nota Este parâmetro é exibido apenas quando você chama esta operação usando uma conta de gerenciamento.	120886317861****
CollectTargetPath	string	O caminho relativo do qual o agente do CloudMonitor coleta dados de monitoramento.	/metrics
CollectTargetType	string	O tipo dos dados de monitoramento. Valores válidos: Spring, Tomcat, Nginx, Tengine, JVM, Redis e MySQL.	nginx
TaskId	string	O ID da tarefa de importação de métricas.	36****
AttachLabels	array<object>	As tags da tarefa de importação de métricas.
	object	Nenhum.
Name	string	The tag key.	key1
Value	string	The tag value.	value1
MatchExpress	array<object>	As condições usadas para corresponder às instâncias no grupo de aplicações.
	object	Nenhum.
Value	string	The keyword that corresponds to the instance name.	ECS_instance1
Name	string	The instance name.	name
Function	string	The method that is used to match the instance name. Valid values: startWith: starts with a prefix endWith: ends with a suffix all: matches all equals: equals contains: contains notContains: does not contain	all
Instances	array	As instâncias onde os dados de monitoramento são coletados em lotes.
	string	O ID da instância.	i-hp368focau7dp0hw****
ExtraInfo	string	As informações adicionais da instância.	test
LogFilePath	string	O caminho onde os dados de log locais são armazenados. Os dados de log locais são armazenados no caminho especificado do host onde o CloudMonitor está implantado. Windows: O caminho do log deve começar com uma letra de unidade. Exemplo: `C:\UserData\log\\.Log`. Não é possível especificar caracteres curinga em um caminho de log. Linux: O caminho do log deve começar com uma barra (/). Exemplo: `/home/appdata/log//.log`. Neste exemplo, `/**/` é usado para corresponder a todos os arquivos no diretório appdata.	C:\UserData\log\*.Log
LogSplit	string	O resultado retornado após os dados de log locais serem divididos com base no modo de correspondência especificado. Nota Os modos de correspondência de dados de log locais incluem modo de regex completo, modo de delimitador e modo JSON.	{"type": "regex","regex": "\\d+\\.\\d+\\.\\d+\\.\\d+\\s+(\\d+)\\s+\\S+\\s+\\[\\d+/\\S+/\\d+:\\d+:\\d+:\\d+\\s+\\+\\d+\\]\\s+(\\S+)\\s+\\S+\\s+/\\S+/\\S+/\\S+\\s+(\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100,300)","to": "true","type": "function"}]}}]}
LogProcess	string	O método usado para agregar dados de log locais.	[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]
LogSample	string	O log local de exemplo.	{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \"-\" \"127.0.0.1:7001\" \"Go-http-client/1.1\" \"-\" \"-\" \"0a98a21a15656865460656276e\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}
SLSProcess	string	As configurações dos logs importados do Log Service.	{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}
SLSProcessConfig	object	As configurações dos logs importados do Log Service. Nota Este parâmetro é retornado apenas se o parâmetro `TaskType` estiver definido como `aliyun_sls`.
Filter	object	The conditions that are used to filter logs imported from Log Service.
Relation	string	The relationship between multiple filter conditions. Valid values: and (default): Logs are processed only if all filter conditions are met. or: Logs are processed if one of the filter conditions is met.	and
Filters	array<object>	The conditions that are used to filter logs imported from Log Service.
	object	The conditions that are used to filter logs imported from Log Service.
SLSKeyName	string	The name of the key that is used to filter logs imported from Log Service.	host
Operator	string	The method that is used to filter logs imported from Log Service. Valid values: `contain`: contains `notContain`: does not contain `>`: greater than `<`: less than `=`: equal to `! =`: not equal to `>=`: greater than or equal to `<=`: less than or equal to	=
Value	string	The value of the key that is used to filter logs imported from Log Service.	200
Statistics	array<object>	The methods that are used to aggregate logs imported from Log Service.
	object	The method that is used to aggregate logs imported from Log Service.
SLSKeyName	string	The name of the key that is used to aggregate logs imported from Log Service.	name
Function	string	The function that is used to aggregate log data within a statistical period. Valid values: count: counts the number. sum: calculates the total value. avg: calculates the average value. max: calculates the maximum value. min: calculates the minimum value. value: collects samples within the statistical period. countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period. sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period. distinct: counts the number of logs where the specified field appears within the statistical period. distribution: counts the number of logs that meet a specified condition within the statistical period. percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.	count
Alias	string	The alias of the aggregation result.	level_count
Parameter1	string	The value of the function that is used to aggregate logs imported from Log Service. If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated. If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.	200
Parameter2	string	The value of the function that is used to aggregate logs imported from Log Service. Nota This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.	299
GroupBy	array<object>	The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
	object	The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
SLSKeyName	string	The name of the key that is used to aggregate logs imported from Log Service.	code
Alias	string	The alias of the aggregation result.	ApiResult
Express	array<object>	The extended fields that indicate the results of basic operations that are performed on aggregation results.
	object	The extended field that indicates the result of basic operations that are performed on aggregation results.
Express	string	The extended field that indicates the result of basic operations that are performed on aggregation results.	success_count
Alias	string	The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.	SuccRate

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "11145B76-566A-5D80-A8A3-FAD98D310079",
  "Success": "true",
  "Code": "200",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 1,
  "TaskList": [
    {
      "YARMConfig": "products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total",
      "CreateTime": "1639382496000",
      "TaskName": "aliyun_task",
      "Namespace": "aliyun",
      "UploadRegion": "cn-hangzhou",
      "NetworkType": "vpc",
      "CollectTimout": 15,
      "CollectTargetEndpoint": "http://localhost",
      "TaskType": "aliyun_sls",
      "MatchExpressRelation": "or",
      "Description": "aliyun",
      "GroupId": "3607****",
      "CollectInterval": 60,
      "TargetUserId": "120886317861****",
      "CollectTargetPath": "/metrics",
      "CollectTargetType": "nginx",
      "TaskId": "36****",
      "AttachLabels": [
        {
          "Name": "key1",
          "Value": "value1"
        }
      ],
      "MatchExpress": [
        {
          "Value": "ECS_instance1",
          "Name": "name",
          "Function": "all"
        }
      ],
      "Instances": [
        "i-hp368focau7dp0hw****"
      ],
      "ExtraInfo": "test",
      "LogFilePath": "C:\\UserData\\log\\*.Log",
      "LogSplit": "{\"type\": \"regex\",\"regex\": \"\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\s+(\\\\d+)\\\\s+\\\\S+\\\\s+\\\\[\\\\d+/\\\\S+/\\\\d+:\\\\d+:\\\\d+:\\\\d+\\\\s+\\\\+\\\\d+\\\\]\\\\s+(\\\\S+)\\\\s+\\\\S+\\\\s+/\\\\S+/\\\\S+/\\\\S+\\\\s+(\\\\d+)\",\"columns\": [{\"name\": \"field1\"},{\"name\": \"filed2\",\"translate\": {\"default\": \"-\",\"mappings\": [{\"from\": \"(\\\\w+)\",\"to\": \"$1x\",\"type\": \"regex\"}]}},{\"name\": \"filed3\",\"translate\": {\"default\": \"-\",\"mappings\": [{\"from\": \"NumberRange(100,300)\",\"to\": \"true\",\"type\": \"function\"}]}}]}",
      "LogProcess": "[{\"metric\": \"metric1\",\"filters\": [{\"column\": \"filed2\",\"type\": \"include\",\"values\": [\"222222\"]}],\"groupBys\": [{\"column\": \"filed3\",\"name\": \"filed3\"}],\"calculates\": [{\"column\": \"field1\",\"name\": \"avg\",\"type\": \"avg\"}]},{\"metric\": \"metric2\",\"filters\": [{\"column\": \"field1\",\"type\": \"include\",\"values\": [\"11111\"]}],\"groupBys\": [{\"column\": \"filed2\",\"name\": \"filed2\"}],\"calculates\": [{\"column\": \"field1\",\"name\": \"avg\",\"type\": \"avg\"}]}]",
      "LogSample": "{\"logContent\":\"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\\"-\\\" \\\"127.0.0.1:7001\\\" \\\"Go-http-client/1.1\\\" \\\"-\\\" \\\"-\\\" \\\"0a98a21a15656865460656276e\\\"\",\"addData\":{\"field1\":[\"1119\",\"1119\"],\"filed2\":[\"POSTx\",\"POST\"],\"filed3\":[\"true\",\"200\"]}}",
      "SLSProcess": "{\"express\": [],\"filter\": {\"filters\": [{\"key\": \"task_type\",\"operator\": \"=\",\"value\": \"1\"}]},\"groupby\": [{\"alias\": \"isp\",\"key\": \"isp\",\"sqlKey\": \"t.`isp`\",\"valueKey\": \"isp\"}],\"interval\": 60,\"labels\": [{\"name\": \"__cms_app__\",\"type\": 0,\"value\": \"sitemonitor\"}],\"statistics\": [{\"alias\": \"http_dns_time_avg\",\"function\": \"avg\",\"key\": \"http_dns_time\"}]}",
      "SLSProcessConfig": {
        "Filter": {
          "Relation": "and",
          "Filters": [
            {
              "SLSKeyName": "host",
              "Operator": "=",
              "Value": "200"
            }
          ]
        },
        "Statistics": [
          {
            "SLSKeyName": "name",
            "Function": "count",
            "Alias": "level_count",
            "Parameter1": "200",
            "Parameter2": "299"
          }
        ],
        "GroupBy": [
          {
            "SLSKeyName": "code",
            "Alias": "ApiResult"
          }
        ],
        "Express": [
          {
            "Express": "success_count",
            "Alias": "SuccRate"
          }
        ]
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
500	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.