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

Atualiza as informações de configuração da conexão.

Descrição da operação

Atualiza as configurações 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. Comprimento máximo: 127 caracteres. Comprimento mínimo: 2 caracteres.	connection-name
Description	string	Não	A descrição. Comprimento máximo: 255 caracteres.	Descrição da configuração da conexão
NetworkParameters	object	Sim	A estrutura de dados da configuração de rede.
NetworkType	string	Sim	Rede pública: PublicNetwork Nuvem privada virtual (VPC): PrivateNetwork Nota Se você 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, OSS_TABLES, SLS, OTS, MaxCompute, MongoDB, Redis, SQLServer, ClickHouse, Oracle, Hive, Iceberg, lakehouse, Http.	Http
Parameters	any	Não	Os parâmetros de conexão da fonte de dados (objeto JSON). Para definições específicas de 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 estrutura de dados 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 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 servidores HTTP verifiquem identidades de clientes. Adicione Authorization: Basic Base64-encoded(`username:password`) no cabeçalho da solicitação em um formato fixo. Username e Password são obrigatórios. API KEY: API_KEY_AUTH. Adicione Token: token value no cabeçalho da solicitação em um formato fixo. ApiKeyName e ApiKeyValue são obrigatórios. OAUTH: OAUTH_AUTH. OAuth 2.0 é um mecanismo de autorização. Normalmente, sem um mecanismo de autorização como OAuth 2.0, os clientes podem acessar diretamente recursos no servidor de recursos. Para garantir acesso seguro aos dados, um mecanismo de Access Token é adicionado. Os clientes devem portar um Access Token para acessar recursos protegidos. O OAuth 2.0 impede que recursos sejam acessados por clientes maliciosos, 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 para 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 para autenticação Basic.
Password	string	Não	A senha para autenticação Basic.	admin
Username	string	Não	O nome de usuário para autenticação Basic.	admin
OAuthParameters	object	Não	A estrutura de dados para parâmetros de autenticação OAuth.
AuthorizationEndpoint	string	Não	A URL da solicitação para obtenção do token OAuth. Comprimento máximo: 127 caracteres.	http://localhost:8080/oauth/token
ClientParameters	object	Não	A estrutura de dados para parâmetros do cliente.
ClientID	string	Não	O ID do cliente.	ClientID
ClientSecret	string	Não	O segredo do cliente da aplicação.	ClientSecret
HttpMethod	string	Não	O método HTTP para a solicitação de sondagem. 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	A lista de estruturas de dados de parâmetros de corpo da solicitação.
	object	Não	A estrutura de dados de um parâmetro de corpo da solicitação.
IsValueSecret	string	Não	Especifica se o valor é usado para autenticação.	false
Key	string	Não	A chave do parâmetro de corpo da solicitação.	name
Value	string	Não	O valor do parâmetro de corpo da solicitação.	demo
HeaderParameters	array<object>	Não	A lista de estruturas de dados 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.	name
Value	string	Não	O valor do parâmetro de cabeçalho.	demo
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 da URI dos parâmetros 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.	name
Value	string	Não	O valor da URI do parâmetro de caminho da solicitação.	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 status da API ou código de erro POP. Valores válidos: 200: 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.