使用GetConnection查詢單個串連配置-事件匯流排-阿里雲 - EventBridge

查詢單個連線配置資訊。

介面說明

用於查詢單個連線配置資訊。

調試

您可以在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!

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

變更歷史

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