Memperbarui konfigurasi koneksi.
Deskripsi operasi
Updates the connection configuration.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eventbridge:UpdateConnection |
update |
*Connection
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ConnectionName |
string |
Yes |
Nama koneksi yang akan diperbarui. Nilai harus terdiri dari 2 hingga 127 karakter. |
connection-name |
| Description |
string |
No |
Deskripsi. Nilai dapat berisi hingga 255 karakter. |
Deskripsi konfigurasi koneksi |
| NetworkParameters |
object |
Yes |
Struktur data konfigurasi jaringan. |
|
| NetworkType |
string |
Yes |
Catatan
When you select PrivateNetwork, VpcId, VswitcheId, and SecurityGroupId are required. |
PublicNetwork |
| VpcId |
string |
No |
The ID of the VPC. |
eb-test/vpc-bp1symadadwnwgmqud |
| VswitcheId |
string |
No |
The vSwitch ID. |
vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c |
| SecurityGroupId |
string |
No |
The ID of the security group. |
eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb |
| Type |
string |
No |
Jenis koneksi. Nilai valid: MySQL, PostgreSQL, Elasticsearch, dan Http. |
Http |
| Parameters |
any |
No |
Parameter koneksi Sumber data sebagai objek JSON. Untuk definisi bidang spesifik, panggil operasi GetConnectionType lalu lihat ParamsSchema di tanggapan. |
{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"} |
| AuthParameters |
object |
No |
Struktur data parameter otentikasi. |
|
| AuthorizationType |
string |
No |
The authentication type. Valid values:
|
BASIC_AUTH |
| ApiKeyAuthParameters |
object |
No |
The data structure of API Key authentication. |
|
| ApiKeyName |
string |
No |
The key of the API Key. |
name |
| ApiKeyValue |
string |
No |
The value of the API Key. |
demo |
| BasicAuthParameters |
object |
No |
The data structure of Basic authentication. |
|
| Password |
string |
No |
The password for Basic authentication. |
admin |
| Username |
string |
No |
The username for Basic authentication. |
admin |
| OAuthParameters |
object |
No |
The data structure of the OAuth authentication parameters. |
|
| AuthorizationEndpoint |
string |
No |
The request URL for obtaining the OAuth token. The maximum length is 127 characters. |
http://localhost:8080/oauth/token |
| ClientParameters |
object |
No |
The data structure of the client parameters. |
|
| ClientID |
string |
No |
ID klien. |
ClientID |
| ClientSecret |
string |
No |
AppKey secret dari klien. |
ClientSecret |
| HttpMethod |
string |
No |
The HTTP request method. Valid values:
|
POST |
| OAuthHttpParameters |
object |
No |
The request parameters for OAuth authentication. |
|
| BodyParameters |
array<object> |
No |
Daftar struktur data parameter permintaan. |
|
|
object |
No |
Struktur data parameter permintaan body. |
||
| IsValueSecret |
string |
No |
Menentukan apakah akan melakukan autentikasi. |
false |
| Key |
string |
No |
Kunci parameter permintaan body. |
name |
| Value |
string |
No |
Nilai parameter permintaan body. |
demo |
| HeaderParameters |
array<object> |
No |
Daftar parameter header permintaan. |
|
|
object |
No |
Struktur data parameter header permintaan. |
||
| IsValueSecret |
string |
No |
Menentukan apakah akan melakukan autentikasi. |
false |
| Key |
string |
No |
Kunci parameter header permintaan. |
name |
| Value |
string |
No |
Nilai parameter header permintaan. |
demo |
| QueryStringParameters |
array<object> |
No |
Struktur data parameter path permintaan. |
|
|
object |
No |
Struktur data parameter path permintaan. |
||
| IsValueSecret |
string |
No |
Menentukan apakah akan melakukan autentikasi. |
false |
| Key |
string |
No |
Kunci parameter path permintaan. |
name |
| Value |
string |
No |
Nilai parameter path permintaan. |
demo |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
8346BE8F-40F3-533D-A0B8-1359C31BD5BA |
| Message |
string |
The returned message. |
success |
| Code |
string |
The API status code or POP error code. Description: 200 indicates success. |
200 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "8346BE8F-40F3-533D-A0B8-1359C31BD5BA",
"Message": "success",
"Code": "200"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | InternalError | |
| 409 | RequestParameterException | Pengecualian parameter permintaan | |
| 409 | ConnectionNotExist | Koneksi tidak ada! | |
| 409 | SecretManagerAPIDeleteSecretFailed | Gagal menghapus secret API secret manager! | |
| 409 | BasicRequiredParameterIsEmpty | Parameter wajib Basic kosong, parameter yang diperlukan adalah username dan password! | |
| 409 | BasicUserNameLengthExceed | Panjang username Basic tidak boleh melebihi 127! | |
| 409 | BasicPassWordLengthExceed | Panjang password Basic tidak boleh melebihi 127! | |
| 409 | ApiKeyRequiredParameterIsEmpty | Parameter wajib Api Key kosong, parameter yang diperlukan adalah apiKeyName dan apiKeyValue! | |
| 409 | ApiKeyNameLengthExceed | Panjang nama Api key tidak boleh melebihi 127! | |
| 409 | ApiKeyValueLengthExceed | Panjang nilai Api key tidak boleh melebihi 127! | |
| 409 | OAuthRequiredParameterIsEmpty | Parameter wajib OAuth kosong, parameter yang diperlukan adalah authorizationEndpoint dan httpMethod! | |
| 409 | AuthorizationEndpointLengthExceed | Panjang authorization endpoint tidak boleh melebihi 127! | |
| 409 | ClientIDLengthExceed | Panjang ClientID tidak boleh melebihi 127! | |
| 409 | ClientSecretLengthExceed | Panjang ClientSecret tidak boleh melebihi 127! | |
| 409 | OauthHttpParametersEmpty | OauthHttpParameters Kosong. | |
| 409 | SecretManagerAPICreateSecretNameFailed | Gagal membuat nama secret API secret manager! | |
| 409 | SecretManagerAPIGetSecretValueFailed | Gagal mendapatkan nilai secret API secret manager! |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.