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

Consulta as tarefas de monitoramento de processos de um grupo de aplicativos.

Descrição da operação

Você pode criar uma tarefa de monitoramento de processos para monitorar todas ou as instâncias especificadas do Elastic Compute Service (ECS) em um grupo de aplicativos e configurar regras de alerta para a tarefa de monitoramento de processos.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de aplicativos.	12345
ProcessName	string	Não	O nome do processo.	sshd
PageNumber	integer	Não	O número da página. Valor padrão: 1	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	7985D471-3FA8-4EE9-8F4B-45C19DF3D36F
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true e false.	true
Code	string	Os códigos de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem de erro.	The Request is not authorization.
PageNumber	string	O número da página. Valor padrão: 1	1
PageSize	string	O número de entradas por página. Valor padrão: 10.	10
Total	string	O número total de entradas retornadas.	28
Processes	object
Process	array<object>	As tarefas de monitoramento de processos.
	array<object>	A tarefa de monitoramento de processos.
ProcessName	string	The process name.	sshd
MatchExpressFilterRelation	string	The logical operator used between conditional expressions that are used to match instances. Valid values: all and or	and
GroupId	string	The ID of the application group.	12345
Id	string	The ID of the process monitoring task.	3F6150F9-45C7-43F9-9578-A58B2E72****
MatchExpress	object
MatchExpress	array<object>	The matching conditions. Nota Only the instances that meet the conditional expressions are monitored by the process monitoring task.
	object
Value	string	The keyword used to match the instance name.	portalHost
Name	string	The criteria based on which the instances are matched. Nota Set the value to `name`. The value name indicates that the instances are matched based on the instance name.	name
Function	string	The matching condition. Valid values: all (default): matches all startWith: starts with a prefix endWith: ends with a suffix contains: contains notContains: excludes equals: equals Nota The matched instances are monitored by the process monitoring task.	all
AlertConfig	object
AlertConfig	array<object>	The alert rule configurations.
	array<object>	The alert rule configuration.
ComparisonOperator	string	The comparison operator that is used to compare the metric value with the threshold. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday. LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanOrEqualToThreshold
SilenceTime	string	The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day. Nota Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.	86400
Webhook	string	The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.	http://www.aliyun.com
Times	string	The number of times for which the threshold can be consecutively exceeded. Nota A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.	3
EscalationsLevel	string	The level of the alert. Valid values: critical warn Info	warn
NoEffectiveInterval	string	The time period during which the alert rule is ineffective.	00:00-23:59
EffectiveInterval	string	The time period during which the alert rule is effective.	00:00-23:59
Threshold	string	The alert threshold.	5
Statistics	string	The method used to calculate metric values that trigger alerts.	Average
TargetList	object
Target	array<object>	The resources for which alerts are triggered.
	object	The resource for which alerts are triggered.
Id	string	The ID of the resource for which alerts are triggered.	123
Arn	string	The Alibaba Cloud Resource Name (ARN) of the resource. Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861**:/queues/test123/message. Fields: {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ). {userId}: the ID of the Alibaba Cloud account. {regionId}: the region ID of the SMQ queue or topic. {Resource type}: the type of the resource for which alerts are triggered. Valid values: queues topics {Resource name}: the resource name. If the resource type is queues, the resource name is the queue name. If the resource type is topics**, the resource name is the topic name.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	The alert level. Valid values: INFO WARN CRITICAL	CRITICAL
JsonParmas	string	The parameters of the alert callback. The parameters are in the JSON format.	{"customField1":"value1","customField2":"$.name"}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7985D471-3FA8-4EE9-8F4B-45C19DF3D36F",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": "1",
  "PageSize": "10",
  "Total": "28",
  "Processes": {
    "Process": [
      {
        "ProcessName": "sshd",
        "MatchExpressFilterRelation": "and",
        "GroupId": "12345",
        "Id": "3F6150F9-45C7-43F9-9578-A58B2E72****",
        "MatchExpress": {
          "MatchExpress": [
            {
              "Value": "portalHost",
              "Name": "name",
              "Function": "all"
            }
          ]
        },
        "AlertConfig": {
          "AlertConfig": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "SilenceTime": "86400",
              "Webhook": "http://www.aliyun.com",
              "Times": "3",
              "EscalationsLevel": "warn",
              "NoEffectiveInterval": "00:00-23:59",
              "EffectiveInterval": "00:00-23:59",
              "Threshold": "5",
              "Statistics": "Average",
              "TargetList": {
                "Target": [
                  {
                    "Id": "123",
                    "Arn": "acs:mns:cn-hangzhou:120886317861****:/queues/test/message",
                    "Level": "CRITICAL",
                    "JsonParmas": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

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.