創建連接配置信息。
接口說明
用于創建連接配置信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
eventbridge:CreateConnection | create | *Connection acs:eventbridge:{#regionId}:{#accountId}:connection/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConnectionName | string | 是 | 連接配置名稱。最大長度 127 個字符。最小長度 2 個字符。 | connection-name |
Description | string | 否 | 連接配置描述信息。最大長度 255 個字符。 | demo |
NetworkParameters | object | 是 | 網絡配置的數據結構。 | |
NetworkType | string | 是 |
注意 選擇專有網絡時,VpcId、VswitcheId 和 SecurityGroupId 必填。 | PublicNetwork |
VpcId | string | 否 | 專有網絡 VPC 的 ID。 | eb-test/vpc-bp1symadadwnwg**** |
VswitcheId | string | 否 | 交換機 ID。 | vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq**** |
SecurityGroupId | string | 否 | 安全組 ID。 | eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9**** |
AuthParameters | object | 否 | 鑒權數據結構。 | |
AuthorizationType | string | 否 | 鑒權類型 :
| BASIC_AUTH |
ApiKeyAuthParameters | object | 否 | API KEY 的數據結構。 | |
ApiKeyName | string | 否 | Api key 的 key 值。 | Token |
ApiKeyValue | string | 否 | Api key 的 value 值。 | adkjnakddh**** |
BasicAuthParameters | object | 否 | Basic 鑒權的數據結構。 | |
Password | string | 否 | basic 鑒權的密碼。 | ******* |
Username | string | 否 | basic 鑒權的用戶名。 | admin |
OAuthParameters | object | 否 | OAuth 鑒權參數數據結構。 | |
AuthorizationEndpoint | string | 否 | 授權的終端節點地址。最大長度 127 個字符。 | http://localhost:8080/oauth/token |
ClientParameters | object | 否 | 客戶參數數據結構。 | |
ClientID | string | 否 | 客戶端的 ID。 | ClientID |
ClientSecret | string | 否 | 應用的客戶端密鑰 secret。 | Qo57Q~F249~S74GmNPA36pZJoJK4f4LY**** |
HttpMethod | string | 否 | 探測類型的方法。取值:
| POST |
OAuthHttpParameters | object | 否 | Oauth 鑒權的請求參數。 | |
BodyParameters | array<object> | 否 | body 請求參數的數據結構列表。 | |
object | 否 | body 請求參數的數據結構。 | ||
IsValueSecret | string | 否 | 是否是鑒權。 | false |
Key | string | 否 | body 請求參數的 key。 | keyDemo |
Value | string | 否 | body 請求參數的 value。 | keyValue |
HeaderParameters | array<object> | 否 | 請求頭的參數列表。 | |
object | 否 | 請求頭的參數數據結構。 | ||
IsValueSecret | string | 否 | 是否是鑒權。 | false |
Key | string | 否 | 請求頭的參數 key。 | keyDemo |
Value | string | 否 | 請求頭參數 value。 | keyValue |
QueryStringParameters | array<object> | 否 | 請求路徑參數的數據結構。 | |
object | 否 | 請求路徑參數的數據結構。 | ||
IsValueSecret | string | 否 | 是否是鑒權。 | false |
Key | string | 否 | 請求路徑參數 key。 | keyDemo |
Value | string | 否 | 請求路徑參數 value。 | valueDemo |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
"Message": "success",
"Code": "Success",
"Data": {
"ConnectionName": "connection-demo"
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
409 | RequestParameterException | Request parameter exception |
409 | ConnectionAlreadyExist | The Connection already existed! |
409 | ConnectionCountExceedLimit | The current count of connection, which will exceed the limit quota. |
409 | BasicRequiredParameterIsEmpty | Basic required parameters are empty, the required parameters are username and password! |
409 | BasicUserNameLengthExceed | Basic username length cannot exceed 127! |
409 | BasicPassWordLengthExceed | Basic password length cannot exceed 127! |
409 | ApiKeyRequiredParameterIsEmpty | Api Key required parameters are empty, the required parameters are apiKeyName and apiKeyValue! |
409 | ApiKeyNameLengthExceed | Api key name length cannot exceed 127! |
409 | ApiKeyValueLengthExceed | Api key value length cannot exceed 127! |
409 | OAuthRequiredParameterIsEmpty | OAuth required parameters are empty, the required parameters are authorizationEndpoint and httpMethod! |
409 | AuthorizationEndpointLengthExceed | Authorization endpoint length cannot exceed 127! |
409 | ClientIDLengthExceed | ClientID length cannot exceed 127! |
409 | ClientSecretLengthExceed | ClientSecret length cannot exceed 127! |
409 | OauthHttpParametersEmpty | OauthHttpParameters is Empty. |
409 | SecretManagerAPICreateSecretNameFailed | Create secret manager api secret name failed |
500 | InternalError | InternalError |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |