GetConnection - EventBridge - Alibaba Cloud Documentation Center

Queries the configurations of a connection.

Operation description

You can call this API operation to query the configurations of a connection.

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
ConnectionName	string	Yes	The connection name.	connection-name

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The returned request ID.	34AD682D-5B91-5773-8132-AA38C130****
Message	string	The returned message.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
HttpCode	integer	The HTTP status code.	200
Data	object	The returned data.
Connections	object []	The queried connections.
ConnectionName	string	The connection name.	demo
Id	long	The data source ID.	5668
Description	string	The connection description.	demo
GmtCreate	long	The time when the connection was created.	1669648905
NetworkParameters	object	The information about the network.
NetworkType	string	PublicNetwork: the Internet. PrivateNetwork: virtual private cloud (VPC).	PublicNetwork
VpcId	string	The VPC ID.	eb-test/vpc-bp1symadadwnwg****
VswitcheId	string	The vSwitch ID.	vsw-bp1iu4x7aeradadown**,vsw-bp193sqmadadlaszpeq**
SecurityGroupId	string	The security group ID.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
AuthParameters	object	The authentication methods.
AuthorizationType	string	The authentication method. Valid values: BASIC_AUTH: basic authentication. API_KEY_AUTH: API key authentication. OAUTH_AUTH: OAuth authentication.	BASIC_AUTH
ApiKeyAuthParameters	object	The information about API key authentication.
ApiKeyName	string	The key of the API key.	key
ApiKeyValue	string	The value of the API key.	value
BasicAuthParameters	object	The information about basic authentication.
Password	string	The password of basic authentication.	********
Username	string	The username of basic authentication.	admin
OAuthParameters	object	The information about 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 information about the client.
ClientID	string	The client ID.	ClientID
ClientSecret	string	The AccessKey secret of the client.	Qo57Q~F249~S74GmNPA36pZJoJK4f****
OAuthHttpParameters	object	The request parameters of OAuth authentication.
BodyParameters	object []	The information about the request body.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key of the request body.	keyDemo
Value	string	The value of the request body.	valueDemo
HeaderParameters	object []	The information about the request header.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key of the request header.	keyDemo
Value	string	The value of the request header.	keyDemo
QueryStringParameters	object []	The information about the request path.
IsValueSecret	string	Indicates whether authentication is enabled.	false
Key	string	The key of the request path.	keyDemo
Value	string	The value of the request path.	valueDemo

Examples

Sample success responses

JSONformat

{
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Message": "success",
  "Code": "Success",
  "HttpCode": 200,
  "Data": {
    "Connections": [
      {
        "ConnectionName": "demo",
        "Id": 5668,
        "Description": "demo",
        "GmtCreate": 1669648905,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwg****",
          "VswitcheId": "vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "key",
            "ApiKeyValue": "value"
          },
          "BasicAuthParameters": {
            "Password": "********",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "Qo57Q~F249~S74GmNPA36pZJoJK4f****"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "keyDemo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
409	RequestParameterException	Request parameter exception
409	ConnectionNotExist	The Connection name not existed!
500	InternalError	InternalError

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.
	Error Codes 409 change
	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.