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

Cria uma regra de evento.

Descrição da operação

Cria 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:CreateRule

create

*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.	MyEventBus
Description	string	Não	A descrição do barramento de eventos.	Filter rule for Simple Message Queue (formerly MNS) (SMQ)
RuleName	string	Sim	O nome da regra de evento.	SMQRule
Status	string	Não	O status da regra. Valores válidos: ENABLE: A regra está ativada. Este é o status padrão. DISABLE: A regra está desativada.	ENABLE
FilterPattern	string	Sim	O padrão de evento no formato JSON. Os seguintes padrões são suportados: Padrão stringEqual Padrão stringExpression Cada campo suporta até cinco expressões em uma estrutura de mapa.	{ "source": [ { "prefix": "acs." } ], "type": [ { "prefix": "oss:ObjectReplication" } ], "subject": [ { "prefix": "acs:oss:cn-hangzhou:123456789098****:my-movie-bucket/", "suffix": ".txt" } ] }
EventTargets	array<object>	Não	A lista de destinos de evento.
	array<object>	Não	O destino do evento.
Id	string	Sim	O ID personalizado do destino do evento.	Mlm123456JHd2RsRoKw
Type	string	Sim	O tipo do destino do evento. Para mais informações, consulte Parâmetros do destino do evento.	acs.mns.queue
Endpoint	string	Não	A URL do endpoint para entrega.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
PushRetryStrategy	string	Não	A política de repetição para envio de eventos. Valores válidos: BACKOFF_RETRY: política de repetição com backoff. O sistema tenta 3 vezes, com um intervalo aleatório de 10 a 20 segundos entre cada tentativa. EXPONENTIAL_DECAY_RETRY: repetição com decaimento exponencial. O sistema tenta 176 vezes, com o intervalo aumentando exponencialmente até 512 segundos. O tempo total de repetição é de 1 dia. Os intervalos específicos são 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 e, em seguida, 512 segundos para as 167 tentativas restantes.	BACKOFF_RETRY
DeadLetterQueue	object	Não	A fila de mensagens mortas. Eventos não processados ou eventos que excedem a contagem de tentativas são gravados na fila de mensagens mortas. Os tipos de fila suportados incluem ApsaraMQ for RocketMQ, Simple Message Queue (anteriormente MNS), ApsaraMQ for Kafka e barramentos de eventos do EventBridge.
Arn	string	Não	O ARN da fila de mensagens mortas. Eventos não processados ou eventos que excedem a contagem de tentativas são gravados na fila de mensagens mortas. Simple Message Queue (anteriormente MNS) e ApsaraMQ for RocketMQ são suportados.	acs:mns:cn-hangzhou:123456789098****:/queues/deadletterqueue
Network	string	Não	O tipo de rede.	PrivateNetwork
VpcId	string	Não	O ID da VPC na qual a fila de mensagens mortas reside.	vpc-2z****
VSwitchIds	string	Não	O ID do vSwitch.	vsw-m12345****
SecurityGroupId	string	Não	O ID do grupo de segurança.	sg-2d****
ErrorsTolerance	string	Não	A estratégia de tolerância a falhas. Valores válidos: ALL: permite tolerância a falhas. As exceções não bloqueiam a execução. Se a estratégia de repetição se esgotar, as mensagens serão entregues à fila de mensagens mortas ou descartadas com base na configuração. NONE: desativa a tolerância a falhas. As exceções bloqueiam a execução quando a estratégia de repetição se esgota.	ALL
ParamList	array<object>	Não	Os parâmetros do destino do evento.
	object	Não	Os parâmetros do destino do evento.
ResourceKey	string	Não	O parâmetro de recurso do destino do evento. Para mais informações, consulte Limites.	body
Form	string	Não	O formato do parâmetro do destino do evento. Para mais informações, consulte Limites.	TEMPLATE
Value	string	Não	O valor do parâmetro do destino do evento.	{"key"="value"}
Template	string	Não	O estilo do modelo de parâmetro do destino do evento.	The value of ${key} is ${value}!
ConcurrentConfig	object	Não	A configuração de controle de simultaneidade.
Concurrency	integer	Não	O número de execuções simultâneas.	2

Exemplos de solicitações.

POST /openapi/createRule HTTP/1.1 Host: 123456789098****.eventbridge.cn-hangzhou.aliyuncs.com Date: Sat, 18 Apr 2020 05:30:41 GMT x-eventbridge-version: 2020-04-01 Authorization: acs vZ3VL0SuJdHi****:Jo2PbT******azYAYoYslKLvWzg= Content-Type: application/json;charset=UTF-8 Content-Length: 26

{ "EventBusName":"default", "RuleName":"MNSRule", "Description":"Filtering rule for MNS", "Status":"ENABLE", "filterPattern":"{"source": [{"prefix": "acs."}],"type": [{"prefix":"oss:ObjectReplication"}],"subject":[{"prefix":"acs:oss:cn-hangzhou:123456789098****:my-movie-bucket/", "suffix":".txt"}]}", "EventTargets":[ { "Id":"1", "Type":"acs.mns.queue", "Endpoint":"acs:mns:cn-hangzhou:123456789098****:queues/myqueue", "PushRetryStrategy":"BACKOFF_RETRY", "DeadLetterQueue":{ "Arn":"acs:mns:cn-hangzhou:123456789098****:/queues/rule-deadletterqueue" }, "ParamList":[ { "resourceKey":"queue", "form":"CONSTANT", "value":"myqueue" }, { "resourceKey":"body", "form":"TEMPLATE", "value":"{"key"="value"}", "template":"The value of ${key} is ${value}!" } ] } ] }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de erro.	Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx
RequestId	string	O ID da solicitação.	1AD6D598-7506-5D2C-81EA-30E3241A903A
Data	object	Os dados retornados.
RuleARN	string	O ARN da regra de evento, que é usado para autorização.	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/MNSRule
Code	string	O código de resposta. Um valor Success indica que a solicitação foi bem-sucedida. Outros valores indicam códigos de erro. Para mais informações, consulte Códigos de erro.	Success
Success	boolean	Indica se a operação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx",
  "RequestId": "1AD6D598-7506-5D2C-81EA-30E3241A903A",
  "Data": {
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/MNSRule"
  },
  "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.