文档

CreateConnection - 创建连接配置信息

更新时间:

创建连接配置信息。

接口说明

用于创建连接配置信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eventbridge:CreateConnectioncreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ConnectionNamestring

连接配置名称。最大长度 127 个字符。最小长度 2 个字符。

connection-name
Descriptionstring

连接配置描述信息。最大长度 255 个字符。

demo
NetworkParametersobject

网络配置的数据结构。

NetworkTypestring
  • 公网 :PublicNetwork

  • 专有网络 :PrivateNetwork

注意 选择专有网络时,VpcId、VswitcheId 和 SecurityGroupId 必填。

PublicNetwork
VpcIdstring

专有网络 VPC 的 ID。

eb-test/vpc-bp1symadadwnwg****
VswitcheIdstring

交换机 ID。

vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq****
SecurityGroupIdstring

安全组 ID。

eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
AuthParametersobject

鉴权数据结构。

AuthorizationTypestring

鉴权类型 :

  • BASIC:BASIC_AUTH。这种授权方式是浏览器遵守 HTTP 协议实现的基本授权方式,HTTP 协议进行通信的过程中,HTTP 协议定义了基本认证允许 HTTP 服务器对客户端进行用户身份证的方法。在请求头中添加 Authorization :Basic 空一格 Base64 加密(用户名:密码)固定格式。Username 和 Password 是必填的。

  • API KEY :API_KEY_AUTH。固定的格式在请求头中添加 Token :Token 值。ApiKeyName 和 ApiKeyValue 是必填的。

  • OAUTH :OAUTH_AUTH。OAuth2.0 是一种授权机制,正常情况,不使用 OAuth2.0 等授权机制的系统,客户端是可以直接访问资源服务器的资源的,为了用户安全访问数据,在访问中间添加了 Access Token 机制。客户端需要携带 Access Token 去访问受到保护的资源。所以 OAuth2.0 确保了资源不被恶意客户端访问,从而提高了系统的安全性。AuthorizationEndpoint、OAuthHttpParameters 和 HttpMethod 是必填的。

BASIC_AUTH
ApiKeyAuthParametersobject

API KEY 的数据结构。

ApiKeyNamestring

Api key 的 key 值。

Token
ApiKeyValuestring

Api key 的 value 值。

adkjnakddh****
BasicAuthParametersobject

Basic 鉴权的数据结构。

Passwordstring

basic 鉴权的密码。

*******
Usernamestring

basic 鉴权的用户名。

admin
OAuthParametersobject

OAuth 鉴权参数数据结构。

AuthorizationEndpointstring

授权的终端节点地址。最大长度 127 个字符。

http://localhost:8080/oauth/token
ClientParametersobject

客户参数数据结构。

ClientIDstring

客户端的 ID。

ClientID
ClientSecretstring

应用的客户端密钥 secret。

Qo57Q~F249~S74GmNPA36pZJoJK4f4LY****
HttpMethodstring

探测类型的方法。取值:

  • GET
  • POST
  • HEAD
  • DELETE
  • PUT
  • PATCH
POST
OAuthHttpParametersobject

Oauth 鉴权的请求参数。

BodyParametersarray<object>

body 请求参数的数据结构列表。

object

body 请求参数的数据结构。

IsValueSecretstring

是否是鉴权。

false
Keystring

body 请求参数的 key。

keyDemo
Valuestring

body 请求参数的 value。

keyValue
HeaderParametersarray<object>

请求头的参数列表。

object

请求头的参数数据结构。

IsValueSecretstring

是否是鉴权。

false
Keystring

请求头的参数 key。

keyDemo
Valuestring

请求头参数 value。

keyValue
QueryStringParametersarray<object>

请求路径参数的数据结构。

object

请求路径参数的数据结构。

IsValueSecretstring

是否是鉴权。

false
Keystring

请求路径参数 key。

keyDemo
Valuestring

请求路径参数 value。

valueDemo

返回参数

名称类型描述示例值
object
RequestIdstring

阿里云为该请求生成的唯一标识符。

7DA60DED-CD36-5837-B848-C01A23D2****
Messagestring

附加信息。取值说明如下:请求正常,返回 success。 请求异常,返回具体异常错误码。

success
Codestring

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

Success
Dataobject

返回结果。

ConnectionNamestring

连接配置名称。

connection-demo

示例

正常返回示例

JSON格式

{
  "RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ConnectionName": "connection-demo"
  }
}

错误码

HTTP status code错误码错误信息
409RequestParameterExceptionRequest parameter exception
409ConnectionAlreadyExistThe Connection already existed!
409ConnectionCountExceedLimitThe current count of connection, which will exceed the limit quota.
409BasicRequiredParameterIsEmptyBasic required parameters are empty, the required parameters are username and password!
409BasicUserNameLengthExceedBasic username length cannot exceed 127!
409BasicPassWordLengthExceedBasic password length cannot exceed 127!
409ApiKeyRequiredParameterIsEmptyApi Key required parameters are empty, the required parameters are apiKeyName and apiKeyValue!
409ApiKeyNameLengthExceedApi key name length cannot exceed 127!
409ApiKeyValueLengthExceedApi key value length cannot exceed 127!
409OAuthRequiredParameterIsEmptyOAuth required parameters are empty, the required parameters are authorizationEndpoint and httpMethod!
409AuthorizationEndpointLengthExceedAuthorization endpoint length cannot exceed 127!
409ClientIDLengthExceedClientID length cannot exceed 127!
409ClientSecretLengthExceedClientSecret length cannot exceed 127!
409OauthHttpParametersEmptyOauthHttpParameters is Empty.
409SecretManagerAPICreateSecretNameFailedCreate secret manager api secret name failed
500InternalErrorInternalError

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

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 错误码发生变更查看变更详情
2023-04-12OpenAPI 错误码发生变更查看变更详情
2023-04-06OpenAPI 错误码发生变更查看变更详情