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

Consulta todas as regras de um barramento de eventos.

Descrição da operação

Você pode chamar esta operação de API para consultar todas as regras de um barramento de eventos.

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

get

*Rule

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RuleNamePrefix	string	Não	O prefixo do nome da regra.	test
Limit	integer	Não	O número máximo de entradas a serem retornadas em uma única chamada. Você pode usar este parâmetro e o parâmetro NextToken para implementar a paginação. No máximo 100 entradas podem ser retornadas em uma única chamada.	50
NextToken	string	Não	Se você definir o parâmetro Limit e houver entradas excedentes, este parâmetro será retornado.	1000
EventBusName	string	Sim	O nome do barramento de eventos.	default

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de erro retornada se a solicitação falhar.	Specified parameter Limit is not valid.
RequestId	string	O ID da solicitação.	C7043799-F4DA-5290-9249-97C359876D97
Data	object	Os dados retornados.
NextToken	string	Se houver entradas excedentes, este parâmetro será retornado.	1000
Total	integer	O número total de entradas.	6
Rules	array<object>	As regras de evento.
	array<object>	A regra de evento.
DetailMap	object	The details of the event rule.
Status	string	The status of the event rule. Valid values: ENABLE (default) DISABLE	ENABLE
EventBusName	string	The name of the event bus.	demo
RuleARN	string	The Alibaba Cloud Resource Name (ARN) of the rule.	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Description	string	The rule description.	demo
Targets	array<object>	The event targets.
	object	The event target.
Type	string	The type of the event target. For more information, see Event target parameters.	acs.mns.queue
Endpoint	string	The endpoint of the event target.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
Id	string	The ID of the custom event target.	177
PushSelector	string	The transformer that is used to push events.	MATCHED_EVENT
ErrorsTolerance	string	The fault tolerance policy. Valid values: ALL: Fault tolerance is allowed. If an error occurs in an event, event processing is not blocked. If the event fails to be sent after the maximum number of retries specified by the retry policy is reached, the event is delivered to the dead-letter queue or discarded based on your configurations. NONE: Fault tolerance is prohibited. If an error occurs in an event and the event fails to be sent after the maximum number of retries specified by the retry policy is reached, event processing is blocked.	ALL
FilterPattern	string	The event pattern, in JSON format. Valid values: stringEqual: Up to five expressions in the map data structure can be specified in each field. stringExpression: Up to five expressions in the map data structure can be specified in each field.	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	The creation timestamp.	1607071602000
RuleName	string	The name of the event rule.	tf-testacc-rule
Code	string	O código de resposta. Success: A solicitação foi bem-sucedida. Outros códigos: A solicitação falhou. Para mais informações sobre códigos de erro, consulte Códigos de erro.	Success
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true e false.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Specified parameter Limit is not valid.",
  "RequestId": "C7043799-F4DA-5290-9249-97C359876D97",
  "Data": {
    "NextToken": "1000",
    "Total": 6,
    "Rules": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Status": "ENABLE",
        "EventBusName": "demo",
        "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
        "Description": "demo",
        "Targets": [
          {
            "Type": "acs.mns.queue\n",
            "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
            "Id": "177",
            "PushSelector": "MATCHED_EVENT",
            "ErrorsTolerance": "ALL"
          }
        ],
        "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}\n",
        "CreatedTimestamp": 1607071602000,
        "RuleName": "tf-testacc-rule"
      }
    ]
  },
  "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.