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

Cria uma configuração de conexão.

Descrição da operação

Cria uma configuração de conexão.

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

create

*Connection

acs:eventbridge:{#regionId}:{#accountId}:connection/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConnectionName	string	Sim	O nome da configuração de conexão. Comprimento máximo: 127 caracteres. Comprimento mínimo: 2 caracteres.	connection-name
Description	string	Não	A descrição da configuração de conexão. Comprimento máximo: 255 caracteres.	demo
NetworkParameters	object	Sim	A configuração de rede.
NetworkType	string	Sim	Rede pública: PublicNetwork Virtual private cloud (VPC): PrivateNetwork Importante Se você selecionar PrivateNetwork, VpcId, VswitcheId e SecurityGroupId são obrigatórios.	PublicNetwork
VpcId	string	Não	O ID da VPC.	eb-test/vpc-bp1symadadwnwg****
VswitcheId	string	Não	O ID do vSwitch.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq****
SecurityGroupId	string	Não	O ID do grupo de segurança.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
Type	string	Não	O tipo de conexão. Valores válidos: MySQL, PostgreSQL, Elasticsearch e Http. Este parâmetro é obrigatório para conexões de fonte de dados. Se este parâmetro não for especificado, o valor padrão Http será usado. O tipo Http é usado para destinos com protocolo HTTP, como API Destination. Os tipos de fonte de dados são usados para conexões de dados no marketplace de integração.	Http
Parameters	any	Não	Os parâmetros de conexão da fonte de dados (objeto JSON). Este parâmetro é obrigatório quando Type é definido como um tipo de fonte de dados. Este parâmetro não é obrigatório para o tipo Http. Para definições específicas dos campos, chame a operação GetConnectionType e consulte ParamsSchema na resposta.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
AuthParameters	object	Não	A configuração de autenticação.
AuthorizationType	string	Não	O tipo de autenticação: BASIC: BASIC_AUTH. Este método de autorização é um método básico de autorização implementado por navegadores em conformidade com o protocolo HTTP. Durante a comunicação HTTP, o protocolo HTTP define um método de autenticação básica que permite que um servidor HTTP autentique clientes. Adicione `Authorization: Basic Base64Encoded(username:password)` no formato fixo ao cabeçalho da solicitação. Username e Password são obrigatórios. API KEY: API_KEY_AUTH. Adicione `Token: TokenValue` no formato fixo ao cabeçalho da solicitação. ApiKeyName e ApiKeyValue são obrigatórios. OAUTH: OAUTH_AUTH. OAuth 2.0 é um mecanismo de autorização. Em um sistema que não utiliza um mecanismo de autorização como OAuth 2.0, o cliente pode acessar diretamente os recursos no servidor de recursos. Para garantir o acesso seguro aos dados, um mecanismo de Access Token é adicionado. O cliente deve portar um Access Token para acessar recursos protegidos. O OAuth 2.0 impede que recursos sejam acessados por clientes maliciosos, o que melhora a segurança do sistema. AuthorizationEndpoint, OAuthHttpParameters e HttpMethod são obrigatórios.	BASIC_AUTH
ApiKeyAuthParameters	object	Não	A configuração de autenticação por API key.
ApiKeyName	string	Não	O nome da chave da API key.	Token
ApiKeyValue	string	Não	O valor da API key.	adkjnakddh****
BasicAuthParameters	object	Não	A configuração de autenticação básica.
Password	string	Não	A senha para autenticação básica.	*******
Username	string	Não	O nome de usuário para autenticação básica.	admin
OAuthParameters	object	Não	A configuração de autenticação OAuth.
AuthorizationEndpoint	string	Não	A URL do endpoint de autorização. Comprimento máximo: 127 caracteres.	http://localhost:8080/oauth/token
ClientParameters	object	Não	A configuração de parâmetros do cliente.
ClientID	string	Não	O ID do cliente.	ClientID
ClientSecret	string	Não	O segredo do cliente da aplicação.	Qo57Q~F249~S74GmNPA36pZJoJK4f4LY****
HttpMethod	string	Não	O método HTTP. Valores válidos: GET POST HEAD DELETE PUT PATCH	POST
OAuthHttpParameters	object	Não	Os parâmetros de solicitação de autenticação OAuth.
BodyParameters	array<object>	Não	A lista de estruturas de dados de parâmetros de solicitação do corpo.
	object	Não	A estrutura de dados de um parâmetro de solicitação do corpo.
IsValueSecret	string	Não	Especifica se o valor é usado para autenticação.	false
Key	string	Não	A chave do parâmetro de solicitação do corpo.	keyDemo
Value	string	Não	O valor do parâmetro de solicitação do corpo.	keyValue
HeaderParameters	array<object>	Não	A lista de parâmetros de cabeçalho.
	object	Não	A estrutura de dados de um parâmetro de cabeçalho.
IsValueSecret	string	Não	Especifica se o valor é usado para autenticação.	false
Key	string	Não	A chave do parâmetro de cabeçalho.	keyDemo
Value	string	Não	O valor do parâmetro de cabeçalho.	keyValue
QueryStringParameters	array<object>	Não	A estrutura de dados da URI dos parâmetros de caminho da solicitação.
	object	Não	A estrutura de dados de uma URI de parâmetro de caminho da solicitação.
IsValueSecret	string	Não	Especifica se o valor é usado para autenticação.	false
Key	string	Não	A chave da URI do parâmetro de caminho da solicitação.	keyDemo
Value	string	Não	O valor da URI do parâmetro de caminho da solicitação.	valueDemo

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação gerado pelo Alibaba Cloud para esta solicitação.	7DA60DED-CD36-5837-B848-C01A23D2****
Message	string	As informações adicionais. Se a solicitação for bem-sucedida, success será retornado. Se a solicitação falhar, o código de erro específico será retornado.	success
Code	string	O status da API ou código de erro POP. Valores válidos: Success.	Success
Data	object	O resultado retornado.
ConnectionName	string	O nome da configuração de conexão.	connection-demo

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ConnectionName": "connection-demo"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception
409	ConnectionAlreadyExist	The Connection already existed!
409	ConnectionCountExceedLimit	The current count of connection, which will exceed the limit quota.
409	BasicRequiredParameterIsEmpty	Basic required parameters are empty, the required parameters are username and password!
409	BasicUserNameLengthExceed	Basic username length cannot exceed 127!
409	BasicPassWordLengthExceed	Basic password length cannot exceed 127!
409	ApiKeyRequiredParameterIsEmpty	Api Key required parameters are empty, the required parameters are apiKeyName and apiKeyValue!
409	ApiKeyNameLengthExceed	Api key name length cannot exceed 127!
409	ApiKeyValueLengthExceed	Api key value length cannot exceed 127!
409	OAuthRequiredParameterIsEmpty	OAuth required parameters are empty, the required parameters are authorizationEndpoint and httpMethod!
409	AuthorizationEndpointLengthExceed	Authorization endpoint length cannot exceed 127!
409	ClientIDLengthExceed	ClientID length cannot exceed 127!
409	ClientSecretLengthExceed	ClientSecret length cannot exceed 127!
409	OauthHttpParametersEmpty	OauthHttpParameters is Empty.
409	SecretManagerAPICreateSecretNameFailed	Create secret manager api secret name failed

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.