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

Cria uma origem de evento externa.

Descrição da operação

Cria uma origem de evento externa.

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

create

*EventSource.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EventSourceName	string	Sim	O nome da origem de evento.	myrabbitmq.sourc
Description	string	Não	A descrição da origem de evento.	Event source of the RabbitMQ type
LinkedExternalSource	boolean	Não	Especifica se deve conectar a uma origem de dados externa.	true
ExternalSourceType	string	Não	O tipo da origem de dados externa.	RabbitMQ
ExternalSourceConfig	object	Não	A configuração da origem de dados externa.	{\"Schedule\":\"0 /10 * * *\",\"TimeZone\":\"GMT+0:00\"}
EventBusName	string	Sim	O nome do barramento de eventos associado à origem de evento.	my-event-bus
SourceMNSParameters	object	Não	Os parâmetros para uma origem de evento do Simple Message Queue (anteriormente MNS). Se você selecionar o Simple Message Queue (anteriormente MNS) como a origem de evento, os parâmetros RegionId, IsBase64Decode e QueueName serão obrigatórios.
RegionId	string	Não	A região onde a fila do Simple Message Queue (anteriormente MNS) reside. Valores válidos: cn-qingdao, cn-beijing, cn-zhangjiakou, cn-huhehaote, cn-wulanchabu, cn-hangzhou, cn-shanghai, cn-shenzhen, cn-guangzhou, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, us-west-1, us-east-1, ap-south-1, me-east-1 e cn-north-2-gov-1.	cn-hangzhou
QueueName	string	Não	O nome da fila do Simple Message Queue (anteriormente MNS).	MyQueue
IsBase64Decode	boolean	Não	Especifica se a decodificação Base64 deve ser ativada. O valor true indica que a decodificação Base64 está ativada. Valores válidos: true e false.	true
SourceRocketMQParameters	object	Não	O parâmetro de solicitação SourceRocketMQParameters.
RegionId	string	Não	A região onde a instância do ApsaraMQ for RocketMQ reside.	cn-hangzhou
InstanceId	string	Não	O ID da instância do ApsaraMQ for RocketMQ. Para mais informações, consulte Limites.	MQ_INST_164901546557**_BAAN**
Topic	string	Não	O nome do tópico da instância do ApsaraMQ for RocketMQ. Para mais informações, consulte Limites.	mytopic
Tag	string	Não	A tag de filtro da mensagem.	test
Offset	string	Não	O offset de consumo da mensagem. Valores válidos: CONSUME_FROM_LAST_OFFSET: Consome mensagens a partir do offset mais recente. CONSUME_FROM_FIRST_OFFSET: Consome mensagens a partir do offset mais antigo. CONSUME_FROM_TIMESTAMP: Consome mensagens a partir do offset em um ponto no tempo especificado. Valor padrão: CONSUME_FROM_LAST_OFFSET.	CONSUME_FROM_LAST_OFFSET
Timestamp	integer	Não	O carimbo de data/hora. Este parâmetro só entra em vigor quando o parâmetro Offset é definido como CONSUME_FROM_TIMESTAMP.	1636597951964
GroupID	string	Não	O ID do grupo da instância do ApsaraMQ for RocketMQ.	GID-test
InstanceType	string	Não	O tipo de instância. Valores válidos: Cloud_4: Instância da versão 4.0. Cloud_5: Instância da versão 5.0.	Cloud_4
InstanceNetwork	string	Não	O tipo de rede.	PublicNetwork
InstanceVpcId	string	Não	O ID da nuvem privada virtual (VPC). Obrigatório para VPCs.	vpc-bp1a4gmlk31hyg6pt****
InstanceVSwitchIds	string	Não	O ID do vSwitch. Obrigatório para VPCs.	vsw-bp10rbrt6rb6vrd89****
InstanceSecurityGroupId	string	Não	O ID do grupo de segurança. Obrigatório para VPCs.	sg-catalog-eventlist****
AuthType	string	Não	O tipo de autenticação. Valores válidos: ACL. Você também pode deixar este parâmetro vazio.	ACL
InstanceEndpoint	string	Não	O endpoint da instância.	registry-vpc****.aliyuncs.com
InstanceUsername	string	Não	O nome de usuário da instância.	root
InstancePassword	string	Não	A senha da instância.	yourPassword
SourceRabbitMQParameters	object	Não	O parâmetro de solicitação SourceRabbitMQParameters.
RegionId	string	Não	A região onde a instância do ApsaraMQ for RabbitMQ reside.	cn-hangzhou
InstanceId	string	Não	O ID da instância do ApsaraMQ for RabbitMQ. Para mais informações, consulte Limites.	amqp-cn-nif22u74****
VirtualHostName	string	Não	O nome do vhost da instância do ApsaraMQ for RabbitMQ. Para mais informações, consulte Limites.	eb-connect
QueueName	string	Não	O nome da fila da instância do ApsaraMQ for RabbitMQ, como eb-connect. Para mais informações, consulte Limites.	demo
SourceSLSParameters	object	Não	Os parâmetros para uma origem de evento do Simple Log Service.
Project	string	Não	O projeto do Simple Log Service.	test-project
LogStore	string	Não	O Logstore do Simple Log Service.	test-logstore
ConsumePosition	string	Não	O offset de início de consumo. Você pode definir este parâmetro como begin para consumir a partir do offset mais antigo, end para consumir a partir do offset mais recente, ou um carimbo de data/hora específico em segundos.	end
RoleName	string	Não	Ao conceder autorização ao EventBridge para ler logs do Simple Log Service usando esta função, as seguintes condições devem ser atendidas: ao criar a função no console do Resource Access Management (RAM), você deve selecionar Alibaba Cloud Service como a entidade confiável e EventBridge como o serviço confiável. Para mais informações sobre a política de acesso para esta função, consulte Origem de evento personalizada: Simple Log Service.	testRole
SourceHttpEventParameters	object	Não	O parâmetro de solicitação SourceHttpEventParameters.
Type	string	Não	O tipo de protocolo suportado pelo webhook gerado. Valores válidos: HTTP HTTPS HTTP&HTTPS	HTTPS
Method	array	Não	Os métodos de solicitação HTTP suportados pelo webhook gerado. Você pode selecionar vários valores. Valores válidos: GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT
	string	Não	Os métodos de solicitação HTTP suportados pelo webhook gerado. Você pode selecionar vários valores. Valores válidos: GET POST PUT PATCH DELETE HEAD OPTIONS TRACE CONNECT	GET
SecurityConfig	string	Não	O tipo da configuração de segurança. Valores válidos: none: Nenhuma configuração é necessária. ip: Bloco CIDR. referer: Nome de domínio seguro.	none
Ip	array	Não	O bloco CIDR para configuração de segurança. Este parâmetro é obrigatório apenas quando o parâmetro SecurityConfig é definido como ip. Você pode inserir um bloco CIDR ou um endereço IP.
	string	Não	O bloco CIDR para configuração de segurança. Este parâmetro é obrigatório apenas quando o parâmetro SecurityConfig é definido como ip. Você pode inserir um bloco CIDR ou um endereço IP.	10.0.0.0/8
Referer	array	Não	O nome de domínio seguro para configuração de segurança. Este parâmetro é obrigatório apenas quando o parâmetro SecurityConfig é definido como referer. Você pode inserir um nome de domínio.
	string	Não	O nome de domínio seguro para configuração de segurança. Este parâmetro é obrigatório apenas quando o parâmetro SecurityConfig é definido como referer. Você pode inserir um nome de domínio.	aliyundoc.com
SourceScheduledEventParameters	object	Não	O parâmetro de solicitação SourceScheduledEventParameters.
Schedule	string	Não	A expressão cron.	10 * * * * *
TimeZone	string	Não	O fuso horário para execução do cron.	GMT+0:00
UserData	string	Não	A string JSON.	{"a": "b"}
SourceKafkaParameters	object	Não	O parâmetro de solicitação SourceKafkaParameters.
InstanceId	string	Não	O ID da instância.	pc-2zehmg67txzuyuuwl****
ConsumerGroup	string	Não	O ID do grupo do consumidor que assina o tópico.	wechat_peer_****
Topic	string	Não	O nome do tópico.	prod_ma_dispatch_center_call_re****
OffsetReset	string	Não	O offset de consumo.	latest
RegionId	string	Não	O ID da região.	cn-hangzhou
MaximumTasks	integer	Não	A cota de simultaneidade, que é o número de consumidores.	1
Network	string	Não	A configuração de rede. Valores válidos: Default e PublicNetwork.	Default
SecurityGroupId	string	Não	O ID do grupo de segurança. Obrigatório para redes autogerenciadas.	sg-8vbf66aoyp0wfzrz****
VSwitchIds	string	Não	O ID do vSwitch. Obrigatório para redes autogerenciadas.	vsw-bp127azpeirmwu4q9****
VpcId	string	Não	O ID da VPC. Obrigatório para redes autogerenciadas.	vpc-2ze5ejm986a73qq3v****
SourceOSSEventParameters	object	Não	Os parâmetros para uma origem de evento do OSS.
EventTypes	array	Não	A lista de tipos de evento.
	string	Não	O tipo de evento.	ObjectCreated:PutObject
StsRoleArn	string	Não	O ARN da função STS.	acs:eventbridge:cn-hangzhou:**
MatchRules	array<object>	Não	As regras de correspondência.
	array<object>	Não	A regra de correspondência de eventos.
	object	Não
Prefix	string	Não	The prefix.	fun/document/
Suffix	string	Não	The suffix.	document
Name	string	Não	The name.	bucketName
MatchState	boolean	Não	The match state.

Exemplo de solicitação `POST /openapi/createEventSource HTTP/1.1 Host: 164901546557****.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

{ "EventSourceName":"myRabbitMQ.source", "Description":"RabbitMQ event source", "SourceRabbitMQParameters":{ "RegionId":"cn-hangzhou", "InstanceId":"amqp-cn-nif22u74****", "VirtualHostName":"eb-connect", "QueueName":"demo" }, "EventBusName":"my-event-bus" }`

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros da solicitação.
Message	string	A mensagem de erro.	Remote error. requestId: [A8EFABD2-95B9-1C46-9E01-xxxx], error code: [CreateRelatedResourceFailed], message: [Create related resource failed, EntityNotExist.Role : The role not exists: xxxx. \r\nRequestId : xxxx-168C-54ED-8FEB-BF11CB70AEB7]
RequestId	string	O ID da solicitação.	2922208e-e1c6-43ee-bfd1-aca50263bc8a
Data	object	Os dados retornados.
EventSourceARN	string	O ARN do recurso.	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/mymns.source
Code	string	O código de resposta da API. Valores válidos: Success: A operação foi bem-sucedida. Outros valores: 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.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": " Remote error. requestId: [A8EFABD2-95B9-1C46-9E01-xxxx], error code: [CreateRelatedResourceFailed], message: [Create related resource failed, EntityNotExist.Role : The role not exists: xxxx. \\r\\nRequestId : xxxx-168C-54ED-8FEB-BF11CB70AEB7]   ",
  "RequestId": "2922208e-e1c6-43ee-bfd1-aca50263bc8a",
  "Data": {
    "EventSourceARN": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/mymns.source"
  },
  "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.