Call the ListConnections API to query connections - EventBridge - Alibaba Cloud - EventBridge

Retrieves a list of connection configurations.

Operation description

Retrieves a list of connection configurations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:ListConnections

get

*Connection

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

None

Request parameters

Parameter	Type	Required	Description	Example
ConnectionNamePrefix	string	No	The connection configuration name prefix used to filter results. Supports prefix matching.	connection-name
Type	string	No	Filters query results by connection type. Valid values: Http, MySQL, PostgreSQL, Elasticsearch, OSS_TABLES, SLS, OTS, MaxCompute, MongoDB, Redis, SQLServer, ClickHouse, Oracle, Hive, Iceberg, lakehouse. If this parameter is not specified, all types are returned.	Http
MaxResults	integer	No	Excludes a single connection type. Valid values are the same as those for Type. Specify a single type name. Arrays or comma-separated values are not supported. For example, specify Http to exclude HTTP connections. If this parameter is not specified or is set to an empty string, no types are excluded. If this parameter is set to the same value as Type, an empty list is returned. Pagination and total count are calculated after filtering.	Http
NextToken	string	No	The maximum number of entries to return per request. You can use this parameter together with NextToken to implement pagination. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
Code	string	The API status or POP error code. Valid values: Success: The request was successful.	Success
Data	object	The list of connection configurations.
Connections	array<object>	The list of connection configurations.
	array<object>	The data structure of the connection configuration.
AuthParameters	object	The authentication data structure.
ApiKeyAuthParameters	object	The data structure of the API key.
ApiKeyName	string	The key name of the API key.	Token
ApiKeyValue	string	The value of the API key.	asdkjnqkwejooa
AuthorizationType	string	The authentication type. Valid values: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
BasicAuthParameters	object	The data structure of basic authentication.
Password	string	The password for basic authentication.	admin
Username	string	The username for basic authentication.	admin
OAuthParameters	object	The data structure of OAuth request parameters.
AuthorizationEndpoint	string	The endpoint for obtaining the OAuth token.	http://localhost:8080/oauth/token
ClientParameters	object	The data structure of client parameters.
ClientID	string	The client ID.	ClientID
ClientSecret	string	The client secret of the application.	ClientSecret
HttpMethod	string	The HTTP method. Valid values: GET POST HEAD	POST
OAuthHttpParameters	object	The request parameters for OAuth authentication.
BodyParameters	array<object>	The list of request parameter data structures for the body.
	object	The data structure of a body request parameter.
IsValueSecret	string	Indicates whether the value is a secret.	false
Key	string	The key of the body request parameter.	name
Value	string	The value of the body request parameter.	demo
HeaderParameters	array<object>	The list of header parameter data structures.
	object	The data structure of a header parameter.
IsValueSecret	string	Indicates whether the value is a secret.	false
Key	string	The key of the header parameter.	name
Value	string	The value of the header parameter.	demo
QueryStringParameters	array<object>	The data structure of the URI of the request path parameters.
	object	The entity of a URI of the request path parameter.
IsValueSecret	string	Indicates whether the value is a secret.	false
Key	string	The key of the URI of the request path parameter.	name
Value	string	The value of the URI of the request path parameter.	demo
ConnectionName	string	The name of the connection configuration.	connection-name
Description	string	The description of the connection configuration.	Description of the connection configuration
GmtCreate	integer	The timestamp when the data source was created.	1592838994234
Id	integer	The ID of the connection configuration.	1141093
NetworkParameters	object	The data structure of network configurations.
NetworkType	string	The network type. Valid values: PublicNetwork: public network. PrivateNetwork: virtual private cloud (VPC).	PublicNetwork
SecurityGroupId	string	The security group ID.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
VpcId	string	The VPC ID.	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	The vSwitch ID.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
Parameters	any	The data source connection parameters (JSON object). Returned only for data source type connections. This field is empty for Http type connections. For field definitions, refer to the ParamsSchema returned by GetConnectionType.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
Type	string	The connection type. Valid values: Http, MySQL, PostgreSQL, Elasticsearch, OSS_TABLES, SLS, OTS, MaxCompute, MongoDB, Redis, SQLServer, ClickHouse, Oracle, Hive, Iceberg, lakehouse.	Http
MaxResults	number	The page size.	10
NextToken	string	If there are additional entries to return, NextToken is included in the response.	0
Total	number	The total number of entries.	1
Message	string	The returned message.	success
RequestId	string	The common parameter. The request ID. Each request has a unique ID, which is active for troubleshooting and locating issues.	E3619976-8714-5D88-BBA2-6983D798A8BB

Examples

Success response

JSON format

{
  "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": "Description of the connection configuration",
        "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"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.