调用ListConnections API获取连接配置列表-事件总线-阿里云-事件总线(EventBridge)-阿里云帮助中心

获取连接配置列表。

接口说明

获取连接配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:ListConnections

get

*Connection

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

无

请求参数

名称	类型	必填	描述	示例值
ConnectionNamePrefix	string	否	获取指定连接配置名称的参数，支持前缀匹配查询	connection-name
Type	string	否	按连接类型过滤查询结果。可选值：Http、MySQL、PostgreSQL、Elasticsearch、OSS_TABLES、SLS、OTS、MaxCompute、MongoDB、Redis、SQLServer、ClickHouse、Oracle、Hive、Iceberg、lakehouse。不传则返回所有类型	Http
ExcludeType	string	否	排除单个连接类型，取值范围与 Type 相同。传入单个类型名称，不支持数组或逗号分隔的多个值。例如传入 Http 可排除 HTTP 类型的连接。未传或传入空字符串时不排除任何类型；与 Type 相同时返回空列表。分页与总数均在过滤后计算。	Http
MaxResults	integer	否	限定每次返回的最大条数，可以和 nextToken 搭配使用实现翻页能力。默认值是 10	10
NextToken	string	否	当指定 MaxResults 时，如果还有多余的返回值则会返回 NextToken。 NextToken 值默认是从 0 开始计算的，默认值是 0。	0

返回参数

名称	类型	描述	示例值
	object
Code	string	接口状态或 POP 错误码。取值说明如下：Success：成功。	Success
Data	object	返回连接配置的列表信息
Connections	array<object>	返回连接配置的列表信息
	array<object>	返回的连接配置的数据结构
AuthParameters	object	权限数据结构
ApiKeyAuthParameters	object	API KEY 的数据结构
ApiKeyName	string	Api key 的 key 值	Token
ApiKeyValue	string	Api key 的 value 值	asdkjnqkwejooa
AuthorizationType	string	权限类型： BASIC：BASIC_AUTH API KEY ：API_KEY_AUTH OAUTH ：OAUTH_AUTH	BASIC_AUTH
BasicAuthParameters	object	Basic 权限的数据结构
Password	string	basic 鉴权的密码	admin
Username	string	basic 鉴权的用户名	admin
OAuthParameters	object	OAuth 请求参数数据结构
AuthorizationEndpoint	string	OAuth 获取 token 的请求地址	http://localhost:8080/oauth/token
ClientParameters	object	客户参数数据结构
ClientID	string	客户端的 ID	ClientID
ClientSecret	string	应用的客户端密钥 secret。	ClientSecret
HttpMethod	string	探测类型的方法。取值： GET POST HEAD	POST
OAuthHttpParameters	object	Oauth 鉴权的请求参数
BodyParameters	array<object>	请求参数的数据结构列表
	object	body 请求参数的数据结构
IsValueSecret	string	是否是鉴权	false
Key	string	body 请求参数的 key	name
Value	string	body 请求参数的 value	demo
HeaderParameters	array<object>	请求头的参数列表
	object	请求头的参数数据结构
IsValueSecret	string	是否是鉴	false
Key	string	请求头参数 key	name
Value	string	请求头参数 value	demo
QueryStringParameters	array<object>	请求路径参数的数据结构
	object	请求路径参数的实体类
IsValueSecret	string	是否是鉴	false
Key	string	请求路径参数 key	name
Value	string	请求路径参数 value	demo
ConnectionName	string	连接配置名称	connection-name
Description	string	连接配置描述信息	Description of the connection configuration
GmtCreate	integer	创建数据源的时间戳	1592838994234
Id	integer	连接配置的 id	1141093
NetworkParameters	object	网络配置的数据结构
NetworkType	string	公网：PublicNetwork 专有网络：PrivateNetwork	PublicNetwork
SecurityGroupId	string	安全组 ID。	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
VpcId	string	专有网络 VPC 的 ID。	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	交换机 id	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
Parameters	any	数据源连接参数（JSON 对象）。仅数据源类型连接返回，Http 类型为空。字段定义参考 GetConnectionType 返回的 ParamsSchema	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
Type	string	连接类型。可选值：Http、MySQL、PostgreSQL、Elasticsearch、OSS_TABLES、SLS、OTS、MaxCompute、MongoDB、Redis、SQLServer、ClickHouse、Oracle、Hive、Iceberg、lakehouse	Http
MaxResults	number	页大小	10
NextToken	string	如果还有多余的返回值则会返回 NextToken。	0
Total	number	总条数。	1
Message	string	返回信息。	success
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	E3619976-8714-5D88-BBA2-6983D798A8BB

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。