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

Atualiza a configuração da conexão.

Descrição da operação

Atualiza a configuração da 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:UpdateConnection

update

*Connection

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConnectionName	string	Sim	O nome da conexão a ser atualizada. O comprimento máximo é de 127 caracteres. O comprimento mínimo é de 2 caracteres.	connection-name
Description	string	Não	A descrição. O comprimento máximo é de 255 caracteres.	Description of the connection configuration
NetworkParameters	object	Sim	A estrutura de dados da configuração de rede.
NetworkType	string	Sim	Rede pública: PublicNetwork Virtual Private Cloud (VPC): PrivateNetwork Nota Ao selecionar PrivateNetwork, VpcId, VswitcheId e SecurityGroupId são obrigatórios.	PublicNetwork
VpcId	string	Não	O ID da VPC.	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	Não	O ID do vSwitch.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	Não	O ID do grupo de segurança.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
Type	string	Não	O tipo de conexão. Valores válidos: MySQL, PostgreSQL, Elasticsearch e Http.	Http
Parameters	any	Não	Os parâmetros de conexão da fonte de dados (objeto JSON). Para definições de campos específicas, chame a API GetConnectionType e consulte o ParamsSchema na resposta.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
AuthParameters	object	Não	A estrutura de dados dos parâmetros de autenticação.
AuthorizationType	string	Não	O tipo de autenticação. Valores válidos: BASIC: BASIC_AUTH. Este método de autorização é o método de autenticação básica implementado por navegadores em conformidade com o protocolo HTTP. Durante a comunicação usando o protocolo HTTP, o protocolo HTTP define a autenticação básica que permite que o servidor HTTP autentique a identidade do usuário do cliente. Adicione Authorization: Basic seguido de um espaço e o valor codificado em Base64 de `username:password` ao cabeçalho da solicitação em um formato fixo. Username e Password são obrigatórios. API KEY: API_KEY_AUTH. Adicione Token: TokenValue ao cabeçalho da solicitação em um formato fixo. ApiKeyName e ApiKeyValue são obrigatórios. OAUTH: OAUTH_AUTH. O OAuth 2.0 é um mecanismo de autorização. Em casos normais, em um sistema que não usa um mecanismo de autorização como o OAuth 2.0, o cliente pode acessar diretamente os recursos no servidor de recursos. Para garantir o acesso seguro aos dados para os usuários, o mecanismo de Access Token é adicionado entre o cliente e o servidor de recursos. O cliente deve portar um Access Token para acessar recursos protegidos. Portanto, o OAuth 2.0 impede que os recursos sejam acessados por clientes mal-intencionados, melhorando assim a segurança do sistema. AuthorizationEndpoint, OAuthHttpParameters e HttpMethod são obrigatórios.	BASIC_AUTH
ApiKeyAuthParameters	object	Não	A estrutura de dados da autenticação por API Key.
ApiKeyName	string	Não	A chave da API Key.	name
ApiKeyValue	string	Não	O valor da API Key.	demo
BasicAuthParameters	object	Não	A estrutura de dados da autenticação Basic.
Password	string	Não	A senha para a autenticação Basic.	admin
Username	string	Não	O nome de usuário para a autenticação Basic.	admin
OAuthParameters	object	Não	A estrutura de dados dos parâmetros de autenticação OAuth.
AuthorizationEndpoint	string	Não	A URL da solicitação para obtenção do token OAuth. O comprimento máximo é de 127 caracteres.	http://localhost:8080/oauth/token
ClientParameters	object	Não	A estrutura de dados dos parâmetros do cliente.
ClientID	string	Não	The client ID.	ClientID
ClientSecret	string	Não	The client secret of the application.	ClientSecret
HttpMethod	string	Não	O método de solicitação HTTP. Valores válidos: GET POST HEAD DELETE PUT PATCH	POST
OAuthHttpParameters	object	Não	Os parâmetros da solicitação para autenticação OAuth.
BodyParameters	array<object>	Não	The list of data structures for body request parameters.
	object	Não	The data structure of body request parameters.
IsValueSecret	string	Não	Specifies whether the parameter is used for authentication.	false
Key	string	Não	The key of the body request parameter.	name
Value	string	Não	The value of the body request parameter.	demo
HeaderParameters	array<object>	Não	The list of request header parameters.
	object	Não	The data structure of request header parameters.
IsValueSecret	string	Não	Specifies whether the parameter is used for authentication.	false
Key	string	Não	The key of the request header parameter.	name
Value	string	Não	The value of the request header parameter.	demo
QueryStringParameters	array<object>	Não	The data structure of request query parameters.
	object	Não	The data structure of request query parameters.
IsValueSecret	string	Não	Specifies whether the parameter is used for authentication.	false
Key	string	Não	The key of the request query parameter.	name
Value	string	Não	The value of the request query parameter.	demo

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	8346BE8F-40F3-533D-A0B8-1359C31BD5BA
Message	string	A mensagem retornada.	success
Code	string	O código de status da API ou código de erro POP. Descrição: 200 indica sucesso.	200

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8346BE8F-40F3-533D-A0B8-1359C31BD5BA",
  "Message": "success",
  "Code": "200"
}

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	ConnectionNotExist	The Connection not existed!
409	SecretManagerAPIDeleteSecretFailed	Delete secret manager api secret failed!
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!
409	SecretManagerAPIGetSecretValueFailed	Get secret manager api secret value failed!

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.