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

Consulta a lista de políticas de lista negra de alertas.

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

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Namespace	string	Não	O namespace do serviço da Alibaba Cloud. Para obter informações sobre os namespaces dos serviços da Alibaba Cloud, consulte Métricas de serviços em nuvem.	acs_ecs_dashboard.
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.	100
Order	integer	Não	A ordem na qual os resultados da consulta são classificados por tempo. Valores válidos: 0: ordem crescente (ASC). 1: ordem decrescente (DESC). Este é o valor padrão.	1
Category	string	Não	A categoria do serviço da Alibaba Cloud. Por exemplo, o ApsaraDB for Redis possui `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition) e `kvstore_splitrw` (edição com divisão de leitura/gravação).	ecs.
Ids	array	Não	Os IDs das políticas de lista negra de alertas.
	string	Não	O ID da política de lista negra de alertas.	a9ad2ac2-3ed9-11ed-b878-0242ac12****
Name	string	Não	O nome da política de lista negra de alertas. Este parâmetro suporta correspondência difusa.	Blacklist-01
ScopeType	string	Não	O escopo efetivo da política de lista negra de alertas. Valores válidos: USER: A política de lista negra de alertas entra em vigor apenas na conta atual da Alibaba Cloud. GROUP: A política de lista negra de alertas entra em vigor nos grupos de aplicativos especificados.	USER.
IsEnable	boolean	Não	O status da política de lista negra de alertas. Valores válidos: true: Ativado. false: Desativado.	true.
InstanceIds	array	Não	A lista de IDs de instâncias na política de lista negra de alertas. Valores válidos de N: 0 a 10.
	string	Não	O ID da instância na política de lista negra de alertas.	i-2ze2d6j5uhg20x47****

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 O valor 200 indica sucesso.	200
Message	string	A mensagem de erro.	The Request is not authorization.
RequestId	string	O ID da solicitação.	D63E76CB-29AA-5B9F-88CE-400A6F28D428
Total	integer	O número total de políticas de lista negra de alertas.	1
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedido. false: Falha.	true.
DescribeMetricRuleBlackList	array<object>	A lista de políticas de lista negra de alertas.
	array<object>	A lista de políticas de lista negra de alertas.
EffectiveTime	string	O período efetivo da política de lista negra de alertas. O valor está no formato HH:mm-HH:mm (relógio de 24 horas). O fuso horário padrão é UTC+8. Por exemplo, "00:00-23:59" indica que a política entra em vigor durante todo o dia.	00:00-23:59
UpdateTime	string	O timestamp em que a política de lista negra de alertas foi modificada pela última vez. Unidade: milissegundos.	1665718373000
CreateTime	string	O timestamp em que a política de lista negra de alertas foi criada. Unidade: milissegundos.	1665714561000
ScopeType	string	O escopo efetivo da política de lista negra de alertas. Valores válidos: USER: A política de lista negra de alertas entra em vigor apenas na conta atual da Alibaba Cloud. GROUP: A política de lista negra de alertas entra em vigor nos grupos de aplicativos especificados.	USER.
IsEnable	boolean	O status da política de lista negra de alertas. Valores válidos: true: Ativado. false: Desativado.	true.
Namespace	string	O namespace do serviço da Alibaba Cloud.	acs_ecs_dashboard.
Category	string	A categoria do serviço da Alibaba Cloud. Por exemplo, o ApsaraDB for Redis possui `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition) e `kvstore_splitrw` (edição com divisão de leitura/gravação).	ecs.
EnableEndTime	integer	O timestamp de início da política de lista negra de alertas. Unidade: milissegundos.	1640608200000
Name	string	O nome da política de lista negra de alertas.	Blacklist-01
EnableStartTime	integer	O timestamp de término da política de lista negra de alertas. Unidade: milissegundos.	1640237400000
Id	string	O ID da política de lista negra de alertas.	93514c96-ceb8-47d8-8ee3-93b6d98b****
Metrics	array<object>	As métricas de monitoramento das instâncias.
	object	As métricas de monitoramento das instâncias.
Resource	string	As informações de dimensão de extensão da instância. Por exemplo, `{"device":"C:"}` indica que a política de lista negra de alertas é aplicada a todas as unidades C da instância ECS no serviço da Alibaba Cloud.	[{"device":"C:"}]
MetricName	string	O nome da métrica de monitoramento.	disk_utilization
Instances	array	As instâncias do serviço da Alibaba Cloud especificado na política de lista negra de alertas.
	string	As instâncias do serviço da Alibaba Cloud especificado na política de lista negra de alertas.	i-rj99xc6cptkk64ml****
ScopeValue	array	Os IDs dos grupos de aplicativos.
	string	Os IDs dos grupos de aplicativos. O valor está no formato JSON Array. Nota Este parâmetro é retornado apenas quando `ScopeType` está definido como `GROUP`.	["67**","78**"]

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

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.	O recurso especificado %s não existe.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.