官方文档
首页 事件总线EventBridge 开发参考 API参考指南 API目录 其他 GetConnection - 查询单个连接配置信息

GetConnection - 查询单个连接配置信息

更新时间：
复制 MD 格式

查询单个连接配置信息。

接口说明

用于查询单个连接配置信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:GetConnection

get

*Connection

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

 无 无

请求参数

名称

类型

必填

描述

示例值
ConnectionName

string

是

连接名称。

connection-name

返回参数

名称

类型

描述

示例值

object

RequestId

string

返回的 requestId

34AD682D-5B91-5773-8132-AA38C130****
Message

string

接口请求返回的信息。

success
Code

string

接口状态或 POP 错误码。取值说明如下：Success：成功。

Success
HttpCode

integer

HTTP 状态码。

200
Data

object

返回结果。

Connections

array<object>

连接配置信息列表。

array<object>

连接配置信息数据结构

ConnectionName

string

连接配置名称

demo
Id

integer

数据源 ID。

5668
Description

string

连接配置描述信息

demo
Type

string

连接类型。可选值：Http、MySQL、PostgreSQL、Elasticsearch

Http
Parameters

any

数据源连接参数（JSON 对象）。仅数据源类型连接返回，Http 类型为空。字段定义参考 GetConnectionType 返回的 ParamsSchema

{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
GmtCreate

integer

创建时间

1669648905
NetworkParameters

object

网络配置的数据结构

NetworkType

string

  • 公网 ：PublicNetwork

  • 专有网络 ：PrivateNetwork

PublicNetwork
VpcId

string

专有网络 VPC 的 ID

eb-test/vpc-bp1symadadwnwg****
VswitcheId

string

交换机 ID

vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****
SecurityGroupId

string

安全组 ID

eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
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 值

key
ApiKeyValue

string

Api key 的 value 值

value
BasicAuthParameters

object

Basic 权限的数据结构

Password

string

basic 鉴权的密码

********
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

Qo57Q~F249~S74GmNPA36pZJoJK4f4****
OAuthHttpParameters

object

Oauth 鉴权的请求参数

BodyParameters

array<object>

请求参数的数据结构列表

object

请求参数的数据结构列表

IsValueSecret

string

是否是鉴权

false
Key

string

body 请求参数的 key

keyDemo
Value

string

body 请求参数的 value

valueDemo
HeaderParameters

array<object>

请求头的参数列表

object

请求头的参数列表

IsValueSecret

string

是否是鉴

false
Key

string

请求头参数 key

keyDemo
Value

string

请求头的参数 value

keyDemo
QueryStringParameters

array<object>

请求路径参数的数据结构

object

请求路径参数的数据结构

IsValueSecret

string

是否是鉴

false
Key

string

请求路径参数 key

keyDemo
Value

string

请求路径参数 value

valueDemo

示例

正常返回示例

JSON格式

{
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Message": "success",
  "Code": "Success",
  "HttpCode": 200,
  "Data": {
    "Connections": [
      {
        "ConnectionName": "demo",
        "Id": 5668,
        "Description": "demo",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "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~S74GmNPA36pZJoJK4f4****"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "keyDemo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
500 InternalError InternalError
409 RequestParameterException Request parameter exception
409 ConnectionNotExist The Connection name not existed!

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

变更历史

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

上一篇：GetCatalog - 查询catalog下一篇：GetNamespace - 查询命名空间