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

Consulta modelos de alerta.

Descrição da operação

Este tópico fornece um exemplo de como consultar modelos de alerta. Neste exemplo, os seguintes modelos de alerta são retornados na resposta: ECS_Template1 e ECS_Template2.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Não	O nome do modelo de alerta.	ECS_Template1
Keyword	string	Não	A palavra-chave do nome do modelo de alerta.	ECS
TemplateId	integer	Não	O ID do modelo de alerta.	70****
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.	10
History	boolean	Não	Especifica se o histórico de aplicação dos modelos de alerta aos grupos de aplicações deve ser exibido. Valores válidos: true false (padrão)	false
Order	boolean	Não	A ordem de classificação. Valores válidos: true (padrão): ordem crescente false: ordem decrescente	true
OrderBy	string	Não	A base de classificação. Valores válidos: gmtMotified: classifica modelos de alerta por hora de modificação gmtCreate (padrão): classifica modelos de alerta por hora de criação	gmtCreate

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	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 de erro.	The Request is not authorization.
RequestId	string	O ID da solicitação.	659401C0-6214-5C02-972A-CFA929D717B7
Total	integer	O número total de entradas retornadas.	2
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Templates	object
Template	array<object>	Os modelos de alerta consultados.
	array<object>	Nenhum.
Description	string	The description of the alert template.	ECS的CPU使用率
GmtCreate	integer	The timestamp when the alert template was created. Unit: milliseconds.	1646018798000
Name	string	The name of the alert template.	ECS_Template1
RestVersion	integer	The version of the alert template. Default value: 0.	0
GmtModified	integer	The timestamp when the alert template was modified. Unit: milliseconds.	1646054798000
TemplateId	integer	The ID of the alert template.	70****
ApplyHistories	object
ApplyHistory	array<object>	The history of applying the alert templates to application groups.
	object	None
GroupId	integer	The ID of the application group.	3607****
GroupName	string	The name of the application group.	ECS_Group
ApplyTime	integer	The timestamp when the alert template was applied to the application group. Unit: milliseconds.	1646055898000

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Success": true,
  "Templates": {
    "Template": [
      {
        "Description": "ECS的CPU使用率",
        "GmtCreate": 1646018798000,
        "Name": "ECS_Template1",
        "RestVersion": 0,
        "GmtModified": 1646054798000,
        "TemplateId": 0,
        "ApplyHistories": {
          "ApplyHistory": [
            {
              "GroupId": 0,
              "GroupName": "ECS_Group",
              "ApplyTime": 1646055898000
            }
          ]
        }
      }
    ]
  }
}

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.