調用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。不傳則返回所有類型	Http
MaxResults	integer	否	限定每次返回的最大筆數，可與 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>	返回連線設定的清單資訊
	array<object>	返回的連線設定的資料結構
ConnectionName	string	连接配置名称	connection-name
Description	string	连接配置描述信息	Description of the connection configuration
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"}
Id	integer	连接配置的 id	1141093
GmtCreate	integer	创建数据源的时间戳	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>	请求参数的数据结构列表
	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
NextToken	string	若還有多餘的返回值則會返回 NextToken。	0
Total	number	總筆數。	1
MaxResults	number	頁面大小	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "ConnectionName": "connection-name",
        "Description": "Description of the connection configuration",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "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	錯誤碼	錯誤資訊	描述
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。