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

Cria uma tarefa de monitoramento para serviços da Alibaba Cloud ou logs do Simple Log Service (SLS) no Hybrid Cloud Monitoring.

Descrição da operação

Antes de chamar esta operação, certifique-se de que o Hybrid Cloud Monitoring esteja ativado.
Para criar uma métrica para logs do SLS, certifique-se de que o SLS esteja ativado e que um projeto e um Logstore tenham sido criados.
Dependendo do valor de TaskType, alguns parâmetros são obrigatórios. Por exemplo, se TaskType estiver definido como aliyun_fc, você deve configurar YARMConfig. Se TaskType estiver definido como aliyun_sls, você deve configurar parâmetros como CollectInterval.
Para operações entre contas, especifique TargetUserId ou TargetUserIdList para conectar recursos de outros membros ao Hybrid Cloud Monitoring.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Namespace	string	Sim	O nome do namespace. Para obter informações sobre como obter o nome do namespace, consulte DescribeHybridMonitorNamespaceList.	aliyun
Description	string	Não	A descrição da tarefa de monitoramento.	阿里云产品数据接入任务。
TaskName	string	Não	O nome da tarefa de monitoramento. Se `TaskType` estiver definido como `aliyun_fc`, insira o nome da tarefa de importação de dados para o serviço da Alibaba Cloud. Se `TaskType` estiver definido como `aliyun_sls`, insira o nome da métrica para logs do SLS.	aliyun_task
TaskType	string	Sim	O tipo da tarefa de monitoramento. Valores válidos: aliyun_fc: uma tarefa de importação de dados para serviços da Alibaba Cloud. aliyun_sls: uma métrica para logs do SLS. Valores válidos: aliyun_fc : aliyun_fc. aliyun_sls : aliyun_sls.	aliyun_fc
CollectTargetType	string	Sim	O tipo do destino de coleta para dados de monitoramento. Se `TaskType` estiver definido como `aliyun_fc`, insira `aliyun_fc`. Se `TaskType` estiver definido como `aliyun_sls`, insira o nome do grupo de Logstores para logs do SLS.	aliyun_fc
CollectInterval	string	Não	O período de coleta da métrica. Valores válidos: 15 60 (padrão) Unidade: segundos. Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_sls`. Valores válidos: 15 : 15 60 : 60	60
GroupId	string	Não	O ID do grupo de aplicativos. Para obter informações sobre como obter o ID do grupo de aplicativos, consulte DescribeMonitorGroups. Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_sls`.	3607****
YARMConfig	string	Não	O arquivo de configuração do serviço da Alibaba Cloud conectado ao Hybrid Cloud Monitoring. namespace: o namespace do serviço da Alibaba Cloud. Para obter informações sobre como consultar o namespace de um serviço da Alibaba Cloud, consulte DescribeMetricMetaList. metric_list: as métricas do serviço da Alibaba Cloud. Para obter informações sobre como consultar as métricas de um serviço da Alibaba Cloud, consulte DescribeMetricMetaList. O exemplo a seguir mostra o arquivo de configuração: `products: - namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total - cpu_idle - diskusage_utilization - CPUUtilization - DiskReadBPS - InternetOut - IntranetOut - cpu_system - namespace: acs_rds_dashboard metric_info: - metric_list: - MySQL_QPS - MySQL_TPS` Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_fc`.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
TargetUserId	string	Não	O ID do membro. Ao invocar esta operação usando uma conta de gerenciamento, você pode usar o modo nativo da nuvem para conectar serviços da Alibaba Cloud de qualquer membro na pasta de recursos ao Hybrid Cloud Monitoring. Isso permite implementar o monitoramento unificado entre contas de serviços da Alibaba Cloud por meio da pasta de recursos. Acesse Configurações para configurar esse recurso no console do CloudMonitor. Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_fc`.	120886317861****
AttachLabels	array<object>	Não	Os rótulos da métrica. Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_sls`.
	object	Não	Nenhum.
Value	string	Não	O valor do rótulo da métrica.	testValue
Name	string	Não	A chave do rótulo da métrica.	app_service
TargetUserIdList	string	Não	Os IDs dos membros. Separe vários IDs de membros com vírgulas (,). Nota Este parâmetro é obrigatório apenas quando você chama esta operação usando uma conta de gerenciamento.	120886317861****
SLSProcessConfig	object	Não	A configuração de log do SLS. Nota Este parâmetro é obrigatório apenas quando `TaskType` está definido como `aliyun_sls`.
Filter	object	Não	As condições de filtro para parâmetros em logs do SLS.
Relation	string	Não	A relação entre várias condições de filtro. Valores válidos: and (padrão): Os logs são processados apenas quando todas as condições de filtro são atendidas. or: Os logs são processados quando qualquer condição de filtro é atendida. Valores válidos: or : or and : and.	and
Filters	array<object>	Não	A lista de condições de filtro para parâmetros em logs do SLS.
	object	Não	Nenhum.
SLSKeyName	string	Não	O nome do parâmetro a ser filtrado nos logs do SLS.	code
Operator	string	Não	O método de filtro para valores de parâmetros em logs do SLS. Valores válidos: `contain`: contém. `notContain`: não contém. `>`: maior que. `<`: menor que. `=`: igual a. `!=`: diferente de. `>=`: maior ou igual a. `<=`: menor ou igual a.	=
Value	string	Não	O valor do filtro do parâmetro nos logs do SLS.	200
Statistics	array<object>	Não	O método estatístico para logs do SLS.
	object	Não	Nenhum.
SLSKeyName	string	Não	O nome do parâmetro para estatísticas de logs do SLS.	name
Function	string	Não	Agrega dados de log dentro do período estatístico com base no método estatístico selecionado. Valores válidos: count: conta o número de ocorrências. sum: calcula a soma. avg: calcula a média. max: retorna o valor máximo. min: retorna o valor mínimo. value: amostras dentro do período. countps: calcula a média por segundo da contagem para o campo especificado dentro do período estatístico. sumps: calcula a média por segundo da soma para o campo especificado dentro do período estatístico. distinct: calcula o número de ocorrências do campo especificado após a deduplicação dentro do período estatístico. distribution: calcula o número de ocorrências de valores de campo dentro de um intervalo especificado. percentile: calcula o valor de distribuição dos valores de campo, como P50.	count
Alias	string	Não	O alias do resultado estatístico do log do SLS.	level_count
Parameter1	string	Não	O valor estatístico dos logs do SLS. Se `Function` estiver definido como `distribution`, este parâmetro especifica o limite inferior do intervalo estatístico. Por exemplo, para contar o número de códigos de status HTTP 2XX, defina este parâmetro como 200. Se `Function` estiver definido como `percentile`, este parâmetro especifica o percentil da distribuição estatística. Por exemplo, 0,5 indica P50.	200
Parameter2	string	Não	O valor estatístico dos logs do SLS. Nota Este parâmetro é obrigatório apenas quando `Function` está definido como `distribution`. Este parâmetro especifica o limite superior do intervalo estatístico. Por exemplo, para contar o número de códigos de status HTTP 2XX, defina este parâmetro como 299.	299
GroupBy	array<object>	Não	Agrega dados por dimensão espacial, o que equivale a Group By em SQL.
	object	Não	Nenhum.
SLSKeyName	string	Não	O nome do parâmetro para estatísticas de logs do SLS.	code
Alias	string	Não	O alias do resultado estatístico do log do SLS.	ApiResult
Express	array<object>	Não	O resultado da operação aritmética do campo estendido para resultados estatísticos de logs do SLS.
	object	Não	Nenhum.
Express	string	Não	O resultado da operação aritmética do campo estendido para resultados estatísticos de logs do SLS.	success_count
Alias	string	Não	O alias do resultado da operação aritmética do campo estendido para resultados estatísticos de logs do SLS.	SuccRate
CloudAccessId	array	Não	A lista de IDs de conta primária de outros provedores de nuvem conectados ao CloudMonitor.
	string	Não	O ID da conta primária de outro provedor de nuvem conectado ao CloudMonitor.	n5n9ik1b****

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.
Code	string	O código de status. Nota 200 indica sucesso.	200
Message	string	A mensagem de erro.	yamlConfigFail
RequestId	string	O ID da solicitação.	28CEA2E0-3E90-51B2-A7E8-B1ED75534E49
Success	string	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedido. false: Falha.	true
TaskId	integer	O ID da tarefa de monitoramento.	36****

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "yamlConfigFail",
  "RequestId": "28CEA2E0-3E90-51B2-A7E8-B1ED75534E49",
  "Success": "true",
  "TaskId": 0
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s
409	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.