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

Consulta a configuração de uma única conexão.

Descrição da operação

Consulta a configuração de uma única 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:GetConnection

get

*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.	connection-name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	34AD682D-5B91-5773-8132-AA38C130****
Message	string	A mensagem retornada para a solicitação.	success
Code	string	O status da API ou código de erro POP. Valores válidos: Success: A solicitação foi bem-sucedida.	Success
HttpCode	integer	O código de status HTTP.	200
Data	object	O resultado retornado.
Connections	array<object>	A lista de configurações de conexão.
	array<object>	A estrutura de dados da configuração de conexão.
ConnectionName	string	O nome da configuração de conexão.	demo
Id	integer	O ID da fonte de dados.	5668
Description	string	A descrição da configuração de conexão.	demo
Type	string	O tipo de conexão. Valores válidos: Http, MySQL, PostgreSQL, Elasticsearch, OSS_TABLES, SLS, OTS, MaxCompute, MongoDB, Redis, SQLServer, ClickHouse, Oracle, Hive, Iceberg e lakehouse.	Http
Parameters	any	Os parâmetros de conexão da fonte de dados (objeto JSON). Retornado apenas para conexões do tipo fonte de dados. Vazio para o tipo Http. Para definições de campos, consulte o ParamsSchema retornado por GetConnectionType.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
GmtCreate	integer	A hora de criação.	1669648905
NetworkParameters	object	A estrutura de dados da configuração de rede.
NetworkType	string	Rede pública: PublicNetwork Virtual private cloud (VPC): PrivateNetwork	PublicNetwork
VpcId	string	O ID da VPC.	eb-test/vpc-bp1symadadwnwg****
VswitcheId	string	O ID do vSwitch.	vsw-bp1iu4x7aeradadown**,vsw-bp193sqmadadlaszpeq**
SecurityGroupId	string	O ID do grupo de segurança.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
AuthParameters	object	A estrutura de dados de autenticação.
AuthorizationType	string	O tipo de autorização. Valores válidos: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
ApiKeyAuthParameters	object	A estrutura de dados da API KEY.
ApiKeyName	string	O nome da chave da API key.	key
ApiKeyValue	string	O valor da API key.	value
BasicAuthParameters	object	A estrutura de dados de autenticação básica.
Password	string	A senha para autenticação básica.	********
Username	string	O nome de usuário para autenticação básica.	admin
OAuthParameters	object	A estrutura de dados dos parâmetros de solicitação OAuth.
AuthorizationEndpoint	string	A URL do endpoint para obtenção do token OAuth.	http://localhost:8080/oauth/token
HttpMethod	string	O método HTTP para a solicitação de sondagem. Valores válidos: GET POST HEAD	POST
ClientParameters	object	A estrutura de dados dos parâmetros do cliente.
ClientID	string	O ID do cliente.	ClientID
ClientSecret	string	O segredo do cliente da aplicação.	Qo57Q~F249~S74GmNPA36pZJoJK4f4****
OAuthHttpParameters	object	Os parâmetros da solicitação de autenticação OAuth.
BodyParameters	array<object>	A lista de estruturas de dados de parâmetros de solicitação para o corpo.
	object	A estrutura de dados do parâmetro de solicitação para o corpo.
IsValueSecret	string	Indica se o valor é um segredo.	false
Key	string	A chave do parâmetro de solicitação do corpo.	keyDemo
Value	string	O valor do parâmetro de solicitação do corpo.	valueDemo
HeaderParameters	array<object>	A lista de parâmetros de cabeçalho.
	object	A lista de parâmetros de cabeçalho.
IsValueSecret	string	Indica se o valor é um segredo.	false
Key	string	A chave do parâmetro de cabeçalho.	keyDemo
Value	string	O valor do parâmetro de cabeçalho.	keyDemo
QueryStringParameters	array<object>	A estrutura de dados da URI dos parâmetros de string de consulta da solicitação.
	object	A estrutura de dados da URI dos parâmetros de string de consulta da solicitação.
IsValueSecret	string	Indica se o valor é um segredo.	false
Key	string	A chave da URI do parâmetro de string de consulta da solicitação.	keyDemo
Value	string	O valor da URI do parâmetro de string de consulta da solicitação.	valueDemo

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Message": "success",
  "Code": "Success",
  "HttpCode": 200,
  "Data": {
    "Connections": [
      {
        "ConnectionName": "demo",
        "Id": 5668,
        "Description": "demo",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "GmtCreate": 1669648905,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwg****",
          "VswitcheId": "vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "key",
            "ApiKeyValue": "value"
          },
          "BasicAuthParameters": {
            "Password": "********",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "Qo57Q~F249~S74GmNPA36pZJoJK4f4****"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "keyDemo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

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 name not existed!

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.