ListConnections - EventBridge - Alibaba Cloud Documentation Center

Queries connections.

Operation description

You can call this API operation to query connections.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ConnectionNamePrefix	string	No	The key word that you specify to query connections. Connections can be queried by prefixes.	connection-name
MaxResults	long	No	The maximum number of entries to be returned in a single call. You can use this parameter and the NextToken parameter to implement paging. Default value: 10.	10
NextToken	string	No	If you set the Limit parameter and excess return values exist, this parameter is returned. Default value: 0.	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.	E3619976-8714-5D88-BBA2-6983D798A8BB
Message	string	The message returned.	success
Code	string	The HTTP status code. The value Success indicates that the request is successful.	Success
Data	object	The information about the connections returned.
Connections	object []	The value of the key in the request path.
ConnectionName	string	The connection name.	connection-name
Description	string	The connection description.	The description of the connection.
Id	long	The connection ID.	1141093
GmtCreate	long	The time when the connection was created.	1592838994234
NetworkParameters	object
NetworkType	string	The network type. Valid values:PublicNetwork and PrivateNetwork.	PublicNetwork
VpcId	string	The virtual private cloud (VPC) ID.	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	The vSwitch ID.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	The security group ID.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
AuthParameters	object	The parameters that are configured for authentication.
AuthorizationType	string	The authentication type. Valid values: BASIC_AUTH: basic authentication. API_KEY_AUTH: API key authentication. OAUTH_AUTH: OAuth authentication.	BASIC_AUTH
ApiKeyAuthParameters	object	The parameters that are configured for API key authentication.
ApiKeyName	string	The API key.	Token
ApiKeyValue	string	The value of the API key.	asdkjnqkwejooa
BasicAuthParameters	object	The parameters that are configured for basic authentication.
Password	string	The password for basic authentication.	admin
Username	string	The username for basic authentication.	admin
InvocationHttpParameters	object	The parameter that is configured for the request.
BodyParameters	object []	The parameters that are configured for the request.
Key	string	The key in the request body.	name
Value	string	The value of the key in the request body.	demo
HeaderParameters	object []	The parameters that are configured for the request header.
Key	string	The key in the request header.	name
Value	string	The value of the parameter in the request header.	demo
QueryStringParameters	object []	The parameters that are configured for the request path.
Key	string	The key in the request path.	name
Value	string	The value of the key in the request path.	demo
OAuthParameters	object	The parameters that are configured for OAuth authentication.
AuthorizationEndpoint	string	The endpoint that is used to obtain the OAuth token.	http://localhost:8080/oauth/token
HttpMethod	string	The HTTP request method. Valid values: GET POST HEAD	POST
ClientParameters	object	The parameters that are configured for the client.
ClientID	string	The client ID.	ClientID
ClientSecret	string	The client key secret of the application.	ClientSecret
OAuthHttpParameters	object	The request parameters for OAuth authentication.
BodyParameters	object []	The parameters that are configured for the request.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key in the request body.	name
Value	string	The value of the key in the request body.	demo
HeaderParameters	object []	The parameters that are configured for the request header.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key in the request header.	name
Value	string	The value of the key in the request header.	demo
QueryStringParameters	object []	The parameters that are configured for the request path.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key in the request path.	name
Value	string	The value of the key in the request path.	demo
NextToken	string	If excess return values exist, this parameter is returned.	0
Total	float	The total number of entries returned.	1
MaxResults	float	The number of entries returned per page.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "ConnectionName": "connection-name",
        "Description": "The description of the connection.",
        "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"
          },
          "InvocationHttpParameters": {
            "BodyParameters": [
              {
                "Key": "name",
                "Value": "demo"
              }
            ],
            "HeaderParameters": [
              {
                "Key": "name",
                "Value": "demo"
              }
            ],
            "QueryStringParameters": [
              {
                "Key": "name",
                "Value": "demo"
              }
            ]
          },
          "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
  }
}

Error codes

HTTP status code	Error code	Error message
409	RequestParameterException	Request parameter exception

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-13

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409
	Added Error Codes: 500
Output Parameters	The response structure of the API has changed.

2023-04-06

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409
Output Parameters	The response structure of the API has changed.