调用ListConnections API获取连接配置列表-事件总线-阿里云

获取连接配置列表。

接口说明

获取连接配置列表。

调试

您可以在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
MaxResults	long	否	限定每次返回的最大条数，可以和 nextToken 搭配使用实现翻页能力。默认值是 10	10
NextToken	string	否	当指定 MaxResults 时，如果还有多余的返回值则会返回 NextToken。 NextToken 值默认是从 0 开始计算的，默认值是 0。	0

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	E3619976-8714-5D88-BBA2-6983D798A8BB
Message	string	返回信息。	success
Code	string	接口状态或 POP 错误码。取值说明如下：Success：成功。	Success
Data	object	返回连接配置的列表信息
Connections	array<object>	返回连接配置的列表信息
connections	object	返回的连接配置的数据结构
ConnectionName	string	连接配置名称	connection-name
Description	string	连接配置描述信息	连接配置描述信息
Id	long	连接配置的 id	1141093
GmtCreate	long	创建数据源的时间戳	1592838994234
NetworkParameters	object	网络配置的数据结构
NetworkType	string	公网：PublicNetwork 专有网络：PrivateNetwork	PublicNetwork
VpcId	string	专有网络 VPC 的 ID。	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	交换机 id	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	安全组 ID。	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
AuthParameters	object	权限数据结构
AuthorizationType	string	权限类型： BASIC：BASIC_AUTH API KEY ：API_KEY_AUTH OAUTH ：OAUTH_AUTH	BASIC_AUTH
ApiKeyAuthParameters	object	API KEY 的数据结构
ApiKeyName	string	Api key 的 key 值	Token
ApiKeyValue	string	Api key 的 value 值	asdkjnqkwejooa
BasicAuthParameters	object	Basic 权限的数据结构
Password	string	basic 鉴权的密码	admin
Username	string	basic 鉴权的用户名	admin
OAuthParameters	object	OAuth 请求参数数据结构
AuthorizationEndpoint	string	OAuth 获取 token 的请求地址	http://localhost:8080/oauth/token
HttpMethod	string	探测类型的方法。取值： GET POST HEAD	POST
ClientParameters	object	客户参数数据结构
ClientID	string	客户端的 ID	ClientID
ClientSecret	string	应用的客户端密钥 secret。	ClientSecret
OAuthHttpParameters	object	Oauth 鉴权的请求参数
BodyParameters	array<object>	请求参数的数据结构列表
bodyParameters	object	body 请求参数的数据结构
IsValueSecret	string	是否是鉴权	false
Key	string	body 请求参数的 key	name
Value	string	body 请求参数的 value	demo
HeaderParameters	array<object>	请求头的参数列表
headerParameters	object	请求头的参数数据结构
IsValueSecret	string	是否是鉴	false
Key	string	请求头参数 key	name
Value	string	请求头参数 value	demo
QueryStringParameters	array<object>	请求路径参数的数据结构
queryStringParameters	object	请求路径参数的实体类
IsValueSecret	string	是否是鉴	false
Key	string	请求路径参数 key	name
Value	string	请求路径参数 value	demo
NextToken	string	如果还有多余的返回值则会返回 NextToken。	0
Total	float	总条数。	1
MaxResults	float	页大小	10

示例

正常返回示例

JSON格式

{
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "ConnectionName": "connection-name",
        "Description": "连接配置描述信息",
        "Id": 1141093,
        "GmtCreate": 1592838994234,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwgmqud",
          "VswitcheId": "vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "Token",
            "ApiKeyValue": "asdkjnqkwejooa"
          },
          "BasicAuthParameters": {
            "Password": "admin",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "ClientSecret"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": false,
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": false,
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": false,
                  "Key": "name",
                  "Value": "demo"
                }
              ]
            }
          }
        }
      }
    ],
    "NextToken": 0,
    "Total": 1,
    "MaxResults": 10
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2023-09-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情