GetRule - EventBridge: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma regra de evento.

Descrição da operação

Obtém os detalhes de uma regra de evento.

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

eventbridge:GetRule

get

*Rule.

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EventBusName	string	Sim	O nome do barramento de eventos.	default
RuleName	string	Sim	O nome da regra.	ram-changes

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de erro.	The event rule not existed!
RequestId	string	O identificador exclusivo gerado pelo Alibaba Cloud para a solicitação.	2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Data	object	O resultado retornado.
Status	string	O status da regra. Valores válidos: ENABLE: A regra está ativada. Este é o status padrão. DISABLE: A regra está desativada.	ENABLE
EventBusName	string	O nome do barramento de eventos.	Housekeeping-Bus
RuleARN	string	O ARN da regra.	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Description	string	A descrição da regra.	test
Targets	array<object>	A lista de destinos de evento.
	array<object>	O destino do evento.
DetailMap	object	As informações detalhadas.
Type	string	O tipo do destino do evento. Para mais informações, consulte Parâmetros do destino do evento.	acs.mns.queue
Endpoint	string	A URL do endpoint para entrega.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamList	array<object>	A lista de parâmetros do destino do evento.
	object	O parâmetro do destino do evento.
Value	string	O valor do parâmetro do destino do evento.	{\"key\"=\"value\"}
Template	string	O estilo do modelo de parâmetro do destino do evento.	The value of ${key} is ${value}!
Form	string	O formato do parâmetro do destino do evento. Para mais informações, consulte Limites.	TEMPLATE
ResourceKey	string	O parâmetro de recurso do destino do evento. Para mais informações, consulte Limites.	body
PushSelector	string	O seletor de push.	PARAM_TRANSFORMER
Id	string	O ID do destino de evento personalizado.	Mlm123456JHd2RsRoKw
DeadLetterQueue	object	A fila de mensagens mortas.
Arn	string	O Alibaba Cloud Resource Name (ARN) da fila de mensagens mortas consultada.	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Network	string	O tipo de rede da fila de mensagens mortas.	PrivateNetwork
VpcId	string	O ID da VPC na qual a fila de mensagens mortas reside.	vpc-2z****
VSwitchIds	string	Os IDs dos vSwitches.	vsw-m5e****
SecurityGroupId	string	O ID do grupo de segurança.	sg-2v****
PushRetryStrategy	string	A política de nova tentativa de push. Valores válidos: BACKOFF_RETRY: A política de nova tentativa com backoff. O sistema faz três novas tentativas. O intervalo entre duas tentativas consecutivas é um valor aleatório entre 10 e 20 segundos. EXPONENTIAL_DECAY_RETRY: A nova tentativa com decaimento exponencial. O sistema faz 176 novas tentativas. O intervalo entre duas tentativas consecutivas aumenta exponencialmente até 512 segundos. O tempo total de nova tentativa é de um dia. Os intervalos específicos são 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 e 512 segundos (167 intervalos de 512 segundos).	BACKOFF_RETRY
ConcurrentConfig	object	A configuração de concorrência.
Concurrency	integer	A concorrência.	2
ErrorsTolerance	string	A estratégia de tolerância a falhas. Valores válidos: ALL: Permite a tolerância a falhas. Quando ocorre uma exceção, a execução não é bloqueada. Se a estratégia de nova tentativa se esgotar, a mensagem será entregue à fila de mensagens mortas ou descartada com base na configuração. NONE: Desativa a tolerância a falhas. Quando ocorre uma exceção e a estratégia de nova tentativa se esgota, a execução é bloqueada.	ALL
FilterPattern	string	O padrão de evento no formato JSON. As seguintes regras se aplicam: modo stringEqual: São permitidas no máximo cinco expressões para cada campo (estrutura de mapa). modo stringExpression: São permitidas no máximo cinco expressões para cada campo (estrutura de mapa).	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	O timestamp de criação.	1607071602000
RuleName	string	O nome da regra.	ramrolechange-fc
Code	string	O código de resposta. Valores válidos: Success: A solicitação foi bem-sucedida. Outros valores: O código de erro. Para mais informações, consulte Códigos de erro.	Success
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "The event rule not existed!",
  "RequestId": "2BC1857D-E633-5E79-B2C2-43EF5F7730D8",
  "Data": {
    "Status": "ENABLE",
    "EventBusName": "Housekeeping-Bus",
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
    "Description": "test",
    "Targets": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Type": "acs.mns.queue",
        "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
        "ParamList": [
          {
            "Value": "{\\\"key\\\"=\\\"value\\\"}",
            "Template": "The value of ${key} is ${value}!",
            "Form": "TEMPLATE",
            "ResourceKey": "body"
          }
        ],
        "PushSelector": "PARAM_TRANSFORMER",
        "Id": "Mlm123456JHd2RsRoKw\n",
        "DeadLetterQueue": {
          "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
          "Network": "PrivateNetwork",
          "VpcId": "vpc-2z****",
          "VSwitchIds": "vsw-m5e****",
          "SecurityGroupId": "sg-2v****"
        },
        "PushRetryStrategy": "BACKOFF_RETRY",
        "ConcurrentConfig": {
          "Concurrency": 2
        },
        "ErrorsTolerance": "ALL"
      }
    ],
    "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}",
    "CreatedTimestamp": 1607071602000,
    "RuleName": "ramrolechange-fc"
  },
  "Code": "Success",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	ServiceNotEnable	Service not enable

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.