UpdateConnection API の呼び出し - EventBridge - Alibaba Cloud - EventBridge

接続の構成を更新します。

操作説明

接続の構成を更新します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eventbridge:UpdateConnection

update

*Connection

acs:eventbridge:{#regionId}:{#accountId}:connection/{#ConnectionName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConnectionName	string	必須	更新する接続の名前。最大長は127 文字です。最小長は2 文字です。	connection-name
Description	string	任意	説明。最大長は255 文字です。	Description of the connection configuration
NetworkParameters	object	必須	ネットワーク構成のデータ構造。
NetworkType	string	必須	パブリックネットワーク: PublicNetwork Virtual Private Cloud (VPC): PrivateNetwork 説明 PrivateNetworkを選択した場合、VpcId、VswitcheId、およびSecurityGroupIdが必須です。	PublicNetwork
VpcId	string	任意	VPCのID。	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	任意	vSwitch ID。	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	任意	セキュリティグループのID。	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
Type	string	任意	接続のタイプ。有効な値: MySQL、PostgreSQL、Elasticsearch、およびHttp。	Http
Parameters	any	任意	データソース接続パラメータ (JSONオブジェクト)。具体的なフィールド定義については、GetConnectionType APIを呼び出し、レスポンス内のParamsSchemaを参照してください。	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
AuthParameters	object	任意	認証パラメータのデータ構造。
AuthorizationType	string	任意	認証タイプ。有効な値: BASIC: BASIC_AUTH。この認可方式は、HTTPプロトコルに準拠してブラウザによって実装される基本認証方式です。HTTPプロトコルを使用した通信時、HTTPプロトコルはHTTPサーバーがクライアントのユーザー身元を認証できる基本認証を定義します。リクエストヘッダーに固定形式で「Authorization: Basic」の後に1つの空白と `username:password` のBase64エンコード値を追加します。UsernameとPasswordが必須です。 API KEY: API_KEY_AUTH。リクエストヘッダーに固定形式で「Token: TokenValue」を追加します。ApiKeyNameとApiKeyValueが必須です。 OAUTH: OAUTH_AUTH。OAuth 2.0は認可メカニズムです。通常、OAuth 2.0などの認可メカニズムを使用しないシステムでは、クライアントはリソースサーバー上のリソースに直接アクセスできます。ユーザーのデータアクセスを安全にするため、クライアントとリソースサーバーの間にAccess Tokenメカニズムが追加されます。クライアントは保護されたリソースにアクセスするためにAccess Tokenを携帯する必要があります。したがって、OAuth 2.0は悪意のあるクライアントによるリソースへのアクセスを防ぎ、システムのセキュリティを向上させます。AuthorizationEndpoint、OAuthHttpParameters、およびHttpMethodが必須です。	BASIC_AUTH
ApiKeyAuthParameters	object	任意	API Key 認証のデータ構造。
ApiKeyName	string	任意	API Keyのキー。	name
ApiKeyValue	string	任意	API Keyの値。	demo
BasicAuthParameters	object	任意	Basic 認証のデータ構造。
Password	string	任意	Basic 認証のパスワード。	admin
Username	string	任意	Basic 認証のユーザー名。	admin
OAuthParameters	object	任意	OAuth 認証パラメータのデータ構造。
AuthorizationEndpoint	string	任意	OAuthトークンを取得するためのリクエストURL。最大長は127 文字です。	http://localhost:8080/oauth/token
ClientParameters	object	任意	クライアントパラメータのデータ構造。
ClientID	string	任意	クライアントのID。	ClientID
ClientSecret	string	任意	クライアントのAppKeyシークレット。	ClientSecret
HttpMethod	string	任意	HTTPリクエストメソッド。有効な値: GET POST HEAD DELETE PUT PATCH	POST
OAuthHttpParameters	object	任意	OAuth 認証のリクエストパラメータ。
BodyParameters	array<object>	任意	リクエストパラメーターのデータ構造リスト。
	object	任意	ボディリクエストパラメーターのデータ構造。
IsValueSecret	string	任意	認証を実行するかどうかを指定します。	false
Key	string	任意	ボディリクエストパラメーターのキー。	name
Value	string	任意	ボディリクエストパラメーターの値。	demo
HeaderParameters	array<object>	任意	リクエストヘッダーパラメーターのリスト。
	object	任意	リクエストヘッダーパラメーターのデータ構造。
IsValueSecret	string	任意	認証を実行するかどうかを指定します。	false
Key	string	任意	リクエストヘッダーパラメーターのキー。	name
Value	string	任意	リクエストヘッダーパラメーターの値。	demo
QueryStringParameters	array<object>	任意	リクエストパスパラメーターのデータ構造。
	object	任意	リクエストパスパラメーターのデータ構造。
IsValueSecret	string	任意	認証を実行するかどうかを指定します。	false
Key	string	任意	リクエストパスパラメーターのキー。	name
Value	string	任意	リクエストパスパラメーターの値。	demo

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストのID。	8346BE8F-40F3-533D-A0B8-1359C31BD5BA
Message	string	返されたメッセージ。	success
Code	string	APIステータスコードまたはPOPエラーコード。説明: 200は成功を示します。	200

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	InternalError	内部エラー
409	RequestParameterException	リクエストパラメーター例外
409	ConnectionNotExist	接続が存在しません！
409	SecretManagerAPIDeleteSecretFailed	シークレットマネージャーAPIシークレットの削除に失敗しました！
409	BasicRequiredParameterIsEmpty	基本認証の必須パラメーターが空です。必須パラメーターはusernameとpasswordです！
409	BasicUserNameLengthExceed	基本認証のユーザー名の長さは127を超えることはできません！
409	BasicPassWordLengthExceed	基本認証のパスワードの長さは127を超えることはできません！
409	ApiKeyRequiredParameterIsEmpty	APIキーの必須パラメーターが空です。必須パラメーターはapiKeyNameとapiKeyValueです！
409	ApiKeyNameLengthExceed	APIキー名の長さは127を超えることはできません！
409	ApiKeyValueLengthExceed	APIキー値の長さは127を超えることはできません！
409	OAuthRequiredParameterIsEmpty	OAuthの必須パラメーターが空です。必須パラメーターはauthorizationEndpointとhttpMethodです！
409	AuthorizationEndpointLengthExceed	認証エンドポイントの長さは127を超えることはできません！
409	ClientIDLengthExceed	ClientIDの長さは127を超えることはできません！
409	ClientSecretLengthExceed	ClientSecretの長さは127を超えることはできません！
409	OauthHttpParametersEmpty	OauthHttpParametersが空です。
409	SecretManagerAPICreateSecretNameFailed	シークレットマネージャーAPIシークレット名の作成に失敗しました！
409	SecretManagerAPIGetSecretValueFailed	シークレットマネージャーAPIシークレット値の取得に失敗しました！

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。