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

Obtém 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 ID de solicitação exclusivo gerado pelo Alibaba Cloud.	2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Data	object	Os dados da resposta.
Status	string	O status da regra. Valores válidos: ENABLE: A regra está ativada. Este é o 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>	Um destino de evento.
DetailMap	object	The details of the event target.
Type	string	The type of the event target. For more information, see Event target parameters.	acs.mns.queue
Endpoint	string	The delivery endpoint for the event.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamList	array<object>	The list of parameters for the event target.
	object	A parameter for the event target.
Value	string	The value of the event target parameter.	{\"key\"=\"value\"}
Template	string	The template of the event target parameter.	The value of ${key} is ${value}!
Form	string	The format of the event target parameter. For more information, see Limits.	TEMPLATE
ResourceKey	string	The resource key of the event target. For more information, see Limits.	body
PushSelector	string	The push selector.	PARAM_TRANSFORMER
Id	string	The custom ID of the event target.	Mlm123456JHd2RsRoKw
DeadLetterQueue	object	The dead-letter queue.
Arn	string	The Alibaba Cloud Resource Name (ARN) of the dead-letter queue.	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Network	string	The network type of the dead-letter queue.
VpcId	string	The VPC ID.
VSwitchIds	string	The vSwitch IDs.
SecurityGroupId	string	The security group ID.
PushRetryStrategy	string	The retry policy for pushing events. Valid values: BACKOFF_RETRY: A backoff retry policy. The event is retried 3 times at a random interval between 10 and 20 seconds. EXPONENTIAL_DECAY_RETRY: An exponential decay retry policy. The event is retried 176 times over one day. The retry interval starts at 1 second and exponentially increases to a maximum of 512 seconds. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, and then 512 for the remaining 167 retries.	BACKOFF_RETRY
ConcurrentConfig	object	The concurrency settings.
Concurrency	integer	The maximum number of concurrent pushes.	2
ErrorsTolerance	string	The fault tolerance policy. Valid values: ALL: Enables fault tolerance. Errors do not block event delivery. If all retries fail, the system sends the event to the specified dead-letter queue or discards it. NONE: Disables fault tolerance. If an error persists after all retries, the system blocks event delivery.	ALL
FilterPattern	string	O padrão de evento no formato JSON. Os seguintes modos são suportados: Modo stringEqual: Na estrutura de mapa, cada campo pode conter até cinco expressões. Modo stringExpression: Na estrutura de mapa, cada campo pode conter até cinco expressões.	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	O timestamp de criação da regra.	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: A solicitação retornou um código de erro. Para mais informações, consulte Códigos de erro.	Success
Success	boolean	Indica se a operação foi bem-sucedida. Um valor `true` indica sucesso.	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": "",
          "VpcId": "",
          "VSwitchIds": "",
          "SecurityGroupId": ""
        },
        "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.