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

Pré-requisitos

O Hybrid Cloud Monitoring deve estar ativado. Para mais informações, consulte Ativar o Hybrid Cloud Monitoring.
Para criar uma métrica para logs importados do Log Service, verifique se o Log Service está ativado e se você já criou um projeto e um Logstore. Para mais informações, consulte Guia de introdução.

Observações de uso

Este tópico apresenta um exemplo de criação de uma tarefa de importação de métricas chamada aliyun_task para o Elastic Compute Service (ECS). A tarefa importa a métrica cpu_total para o namespace aliyun. A resposta confirma a criação da tarefa de importação de métricas.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateHybridMonitorTask	A operação a ser executada. Defina o valor como CreateHybridMonitorTask.
Namespace	String	Sim	aliyun	O nome do namespace. Para obter informações sobre como conseguir o nome de um namespace, consulte DescribeHybridMonitorNamespaceList.
Description	String	Não	Tarefa de importação de métricas para um serviço da Alibaba Cloud	A descrição da tarefa de importação de métricas.
TaskName	String	Não	aliyun_task	O nome da tarefa de importação de métricas. Se o parâmetro `TaskType` estiver definido como `aliyun_fc`, insira o nome da tarefa de importação de métricas. Se o parâmetro `TaskType` estiver definido como `aliyun_sls`, insira o nome da métrica para logs importados do Log Service.
TaskType	String	Sim	aliyun_fc	Define se deve ser criada uma tarefa de importação de métricas para um serviço da Alibaba Cloud ou uma métrica para logs importados do Log Service. Valores válidos: aliyun_fc: cria uma tarefa de importação de métricas para um serviço da Alibaba Cloud. aliyun_sls: cria uma métrica para logs importados do Log Service.
CollectTargetType	String	Sim	aliyun_fc	O tipo do alvo de coleta. Quando o parâmetro `TaskType` for `aliyun_fc`, insira `aliyun_fc`. Quando o parâmetro `TaskType` for `aliyun_sls`, insira o nome do grupo de Logstores.
CollectInterval	String	Não	60	O intervalo de coleta das métricas. Valores válidos: 15 60 (valor padrão) Unidade: segundos. Nota Este parâmetro é obrigatório apenas se o parâmetro `TaskType` estiver definido como `aliyun_sls`.
GroupId	String	Não	3607****	O ID do grupo de aplicativos. Para saber como obter o ID de um grupo de aplicativos, consulte DescribeMonitorGroups. Nota Este parâmetro é necessário somente quando o parâmetro `TaskType` tem o valor `aliyun_sls`.
YARMConfig	String	Não	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total	O arquivo de configuração do serviço da Alibaba Cloud que você deseja monitorar usando o Hybrid Cloud Monitoring. namespace: o namespace do serviço da Alibaba Cloud. Para consultar o namespace de um serviço da Alibaba Cloud, veja DescribeMetricMetaList. metric_list: as métricas do serviço da Alibaba Cloud. Para consultar as métricas de um serviço da Alibaba Cloud, veja DescribeMetricMetaList. O código a seguir mostra um exemplo de 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 Use este parâmetro apenas se o `TaskType` for `aliyun_fc`.
TargetUserId	String	Não	120886317861****	O ID da conta membro. Ao chamar operações de API com uma conta de gerenciamento, é possível conectar ao Hybrid Cloud Monitoring os serviços da Alibaba Cloud ativados para uma conta membro em um diretório de recursos. Isso permite monitorar serviços da Alibaba Cloud em várias contas corporativas por meio do diretório de recursos. Nota Especifique este parâmetro somente se o `TaskType` estiver configurado como `aliyun_fc`.
AttachLabels.N.Value	String	Não	testValue	O valor da tag da métrica.
AttachLabels.N.Name	String	Não	app_service	A chave da tag da métrica.
TargetUserIdList	String	Não	120886317861****	Os IDs das contas membro. Separe vários IDs de contas membro com vírgulas (,). Nota Este campo é exigido apenas ao executar esta operação utilizando a conta de gerenciamento.
SLSProcessConfig	Object	Não		As configurações dos logs importados do Log Service. Nota Aplicável somente quando o `TaskType` for igual a `aliyun_sls`.
Filter	Object	Não		As condições usadas para filtrar logs importados do Log Service.
Relation	String	Não	and	A relação entre múltiplas condições de filtro. Valores válidos: and (valor padrão): Os logs são processados apenas se todas as condições de filtro forem atendidas. or: Os logs são processados se pelo menos uma das condições de filtro for atendida.
Filters	Array	Não		As condições utilizadas na filtragem de logs provenientes do Log Service.
SLSKeyName	String	Não	code	O nome da chave usada para filtrar logs importados do Log Service.
Operator	String	Não	=	O método de filtragem aplicado aos logs do Log Service. Opções disponíveis: `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	200	O valor da chave empregada na filtragem de logs do Log Service.
Statistics	Array	Não		O método de agregação dos logs importados do Log Service.
SLSKeyName	String	Não	name	O nome da chave utilizada para agregar logs do Log Service.
Function	String	Não	count	A função responsável por agregar dados de log dentro de um período estatístico. Valores aceitos: count: realiza a contagem. sum: calcula o valor total. avg: calcula a média. max: seleciona o valor máximo. min: seleciona o valor mínimo. value: coleta amostras durante o período estatístico. countps: divide a contagem do campo especificado pelo total de segundos do período estatístico. sumps: divide o valor total do campo especificado pelo total de segundos do período estatístico. distinct: conta quantos logs apresentam o campo especificado no período estatístico. distribution: conta os logs que satisfazem uma condição específica no período estatístico. percentile: ordena os valores do campo em ordem crescente e retorna o valor correspondente ao percentil indicado no período estatístico. Exemplo: P50.
Alias	String	Não	level_count	O alias do resultado da agregação.
Parameter1	String	Não	200	O valor da função usada para agregar logs do Log Service. Se o parâmetro `Function` for definido como `distribution`, este parâmetro indica o limite inferior do intervalo estatístico. Por exemplo, para calcular o número de requisições HTTP com código de status 2XX, defina este valor como 200. Se o parâmetro `Function` for definido como `percentile`, este parâmetro indica o percentil onde se encontra o valor esperado. Por exemplo, 0,5 representa P50.
Parameter2	String	Não	299	O valor da função utilizada na agregação de logs do Log Service. Nota Necessário apenas quando `Function` for `distribution`. Define o limite superior do intervalo estatístico. Por exemplo, para contar requisições HTTP com status 2XX, configure este parâmetro como 299.
GroupBy	Array	Não		A dimensão usada como base para agregação de dados. Equivale à cláusula GROUP BY em SQL.
SLSKeyName	String	Não	code	O nome da chave empregada para agregar logs importados do Log Service.
Alias	String	Não	ApiResult	O alias atribuído ao resultado da agregação.
Express	Array	Não		Os campos estendidos que definem os resultados de operações básicas realizadas sobre os resultados da agregação.
Express	String	Não	success_count	O campo estendido que especifica o resultado de operações básicas aplicadas aos resultados da agregação.
Alias	String	Não	SuccRate	O alias do campo estendido que determina o resultado de operações básicas executadas sobre os resultados da agregação.

Para mais detalhes sobre parâmetros comuns de solicitação, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	O código de status HTTP. Nota O código 200 indica que a chamada foi bem-sucedida.
Message	String	yamlConfigFail	A mensagem de erro.
RequestId	String	28CEA2E0-3E90-51B2-A7E8-B1ED75534E49	O ID da solicitação.
Success	String	true	Indica se a chamada teve êxito. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.
TaskId	Long	36****	O ID da tarefa de importação de métricas.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=CreateHybridMonitorTask
&Namespace=aliyun
&TaskName=aliyun_task
&TaskType=aliyun_fc
&YARMConfig=products:
- namespace: acs_ecs_dashboard
  metric_info:
  - metric_list:
    - cpu_total
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateHybridMonitorTaskResponse>
	<TaskId>36****</TaskId>
	<RequestId>28CEA2E0-3E90-51B2-A7E8-B1ED75534E49</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</CreateHybridMonitorTaskResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.