文档

UpdateConnection - 更新连接配置信息

更新时间:

更新连接配置信息。

接口说明

用于更新连接配置。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

要更新的连接名称。最大长度 127 个字符。最小长度 2 个字符。

connection-name
Descriptionstring

描述信息。最大长度 255 个字符。

连接配置描述信息
NetworkParametersobject

网络配置的数据结构。

NetworkTypestring
  • 公网 :PublicNetwork

  • 专有网络 :PrivateNetwork

说明 选择专有网络时,VpcId、VswitcheId 和 SecurityGroupId 必填。
PublicNetwork
VpcIdstring

专有网络 VPC 的 ID。

eb-test/vpc-bp1symadadwnwgmqud
VswitcheIdstring

交换机 ID。

vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupIdstring

安全组 ID。

eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
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 Ke 的 key 值。

name
ApiKeyValuestring

API Ke 的 value 值。

demo
BasicAuthParametersobject

Basic 鉴权的数据结构。

Passwordstring

basic 鉴权的密码。

admin
Usernamestring

basic 鉴权的用户名。

admin
OAuthParametersobject

OAuth 鉴权参数数据结构。

AuthorizationEndpointstring

OAuth 获取 token 的请求地址。最大长度 127 个字符。

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

客户参数数据结构。

ClientIDstring

客户端的 ID。

ClientID
ClientSecretstring

应用的客户端密钥 secret。

ClientSecret
HttpMethodstring

探测类型的方法。取值:

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

OAuth 鉴权的请求参数。

BodyParametersobject []

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

IsValueSecretstring

是否是鉴权。

false
Keystring

body 请求参数的 key。

name
Valuestring

body 请求参数的 value。

demo
HeaderParametersobject []

请求头的参数列表。

IsValueSecretstring

是否是鉴权。

false
Keystring

请求头参数 key。

name
Valuestring

请求头参数 value。

demo
QueryStringParametersobject []

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

IsValueSecretstring

是否是鉴权。

false
Keystring

请求路径参数 key。

name
Valuestring

请求路径参数 value。

demo

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

8346BE8F-40F3-533D-A0B8-1359C31BD5BA
Messagestring

返回信息。

success
Codestring

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

Success

示例

正常返回示例

JSON格式

{
  "RequestId": "8346BE8F-40F3-533D-A0B8-1359C31BD5BA",
  "Message": "success",
  "Code": "Success"
}

错误码

HTTP status code错误码错误信息
409RequestParameterExceptionRequest parameter exception
409ConnectionNotExistThe Connection not existed!
409SecretManagerAPIDeleteSecretFailedDelete secret manager api secret failed!
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!
409SecretManagerAPIGetSecretValueFailedGet secret manager api secret value failed!
500InternalErrorInternalError

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

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 409 变更
    新增错误码:500
2023-04-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:409
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:409
  • 本页导读 (1)
文档反馈