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

Obtém uma lista de configurações de conexão.

Descrição da operação

Obtém uma lista de configurações 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:ListConnections

get

*Connection

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConnectionNamePrefix	string	Não	O prefixo do nome da configuração de conexão usado para filtrar resultados. Suporta correspondência de prefixo.	connection-name
Type	string	Não	Filtra os resultados da consulta por tipo de conexão. Valores válidos: Http, MySQL, PostgreSQL, Elasticsearch, OSS_TABLES, SLS, OTS, MaxCompute, MongoDB, Redis, SQLServer, ClickHouse, Oracle, Hive, Iceberg, lakehouse. Se este parâmetro não for especificado, todos os tipos serão retornados.	Http
MaxResults	integer	Não	Exclui um único tipo de conexão. Os valores válidos são os mesmos do parâmetro Type. Especifique um único nome de tipo. Arrays ou valores separados por vírgula não são suportados. Por exemplo, especifique Http para excluir conexões HTTP. Se este parâmetro não for especificado ou for definido como uma string vazia, nenhum tipo será excluído. Se este parâmetro for definido com o mesmo valor de Type, uma lista vazia será retornada. A paginação e a contagem total são calculadas após a filtragem.	Http
NextToken	string	Não	O número máximo de entradas a serem retornadas por solicitação. Você pode usar este parâmetro junto com NextToken para implementar a paginação. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O status da API ou o código de erro POP. Valores válidos: Success: a solicitação foi bem-sucedida.	Success
Data	object	A lista de configurações de conexão.
Connections	array<object>	A lista de configurações de conexão.
	array<object>	A estrutura de dados da configuração de conexão.
AuthParameters	object	A estrutura de dados de autenticação.
ApiKeyAuthParameters	object	A estrutura de dados da chave de API.
ApiKeyName	string	O nome da chave de API.	Token
ApiKeyValue	string	O valor da chave de API.	asdkjnqkwejooa
AuthorizationType	string	O tipo de autenticação. Valores válidos: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
BasicAuthParameters	object	A estrutura de dados de autenticação básica.
Password	string	A senha para autenticação básica.	admin
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	O endpoint para obtenção do token OAuth.	http://localhost:8080/oauth/token
ClientParameters	object	A estrutura de dados dos parâmetros do cliente.
ClientID	string	O ID do cliente.	ClientID
ClientSecret	string	O segredo do cliente do aplicativo.	ClientSecret
HttpMethod	string	O método HTTP. Valores válidos: GET POST HEAD	POST
OAuthHttpParameters	object	Os parâmetros de solicitação para 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 de um parâmetro de solicitação do corpo.
IsValueSecret	string	Indica se o valor é um segredo.	false
Key	string	A chave do parâmetro de solicitação do corpo.	name
Value	string	O valor do parâmetro de solicitação do corpo.	demo
HeaderParameters	array<object>	A lista de estruturas de dados de parâmetros de cabeçalho.
	object	A estrutura de dados de um parâmetro de cabeçalho.
IsValueSecret	string	Indica se o valor é um segredo.	false
Key	string	A chave do parâmetro de cabeçalho.	name
Value	string	O valor do parâmetro de cabeçalho.	demo
QueryStringParameters	array<object>	A estrutura de dados da URI dos parâmetros de string de consulta da solicitação.
	object	A entidade de uma URI do parâmetro 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.	name
Value	string	O valor da URI do parâmetro de string de consulta da solicitação.	demo
ConnectionName	string	O nome da configuração de conexão.	connection-name
Description	string	A descrição da configuração de conexão.	Descrição da configuração de conexão
GmtCreate	integer	O timestamp de criação da fonte de dados.	1592838994234
Id	integer	O ID da configuração de conexão.	1141093
NetworkParameters	object	A estrutura de dados das configurações de rede.
NetworkType	string	O tipo de rede. Valores válidos: PublicNetwork: rede pública. PrivateNetwork: nuvem privada virtual (VPC).	PublicNetwork
SecurityGroupId	string	O ID do grupo de segurança.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
VpcId	string	O ID da VPC.	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	O ID do vSwitch.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
Parameters	any	Os parâmetros de conexão da fonte de dados (objeto JSON). Retornado apenas para conexões do tipo fonte de dados. Este campo está vazio para conexões do 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"}
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, lakehouse.	Http
MaxResults	number	O tamanho da página.	10
NextToken	string	Se houver entradas adicionais a serem retornadas, NextToken será incluído na resposta.	0
Total	number	O número total de entradas.	1
Message	string	A mensagem retornada.	success
RequestId	string	O parâmetro comum. O ID da solicitação. Cada solicitação possui um ID exclusivo, que é utilizado para solução de problemas e localização de falhas.	E3619976-8714-5D88-BBA2-6983D798A8BB

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "AuthParameters": {
          "ApiKeyAuthParameters": {
            "ApiKeyName": "Token",
            "ApiKeyValue": "asdkjnqkwejooa"
          },
          "AuthorizationType": "BASIC_AUTH",
          "BasicAuthParameters": {
            "Password": "admin",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "ClientSecret"
            },
            "HttpMethod": "POST",
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ]
            }
          }
        },
        "ConnectionName": "connection-name",
        "Description": "Descrição da configuração de conexão",
        "GmtCreate": 1592838994234,
        "Id": 1141093,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb",
          "VpcId": "eb-test/vpc-bp1symadadwnwgmqud",
          "VswitcheId": "vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c"
        },
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "Type": "Http"
      }
    ],
    "MaxResults": 10,
    "NextToken": "0",
    "Total": 1
  },
  "Message": "success",
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.