Membuat konfigurasi koneksi.
Deskripsi operasi
Membuat konfigurasi koneksi.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eventbridge:CreateConnection |
create |
*Connection
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ConnectionName |
string |
Yes |
Nama konfigurasi koneksi. Panjang maksimum: 127 karakter. Panjang minimum: 2 karakter. |
connection-name |
| Description |
string |
No |
Deskripsi konfigurasi koneksi. Panjang maksimum: 255 karakter. |
demo |
| NetworkParameters |
object |
Yes |
Konfigurasi jaringan. |
|
| NetworkType |
string |
Yes |
Penting Jika Anda memilih PrivateNetwork, VpcId, VswitcheId, dan SecurityGroupId wajib diisi. |
PublicNetwork |
| VpcId |
string |
No |
ID VPC. |
eb-test/vpc-bp1symadadwnwg**** |
| VswitcheId |
string |
No |
ID vSwitch. |
vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq**** |
| SecurityGroupId |
string |
No |
ID grup keamanan. |
eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9**** |
| Type |
string |
No |
Jenis koneksi. Nilai valid: MySQL, PostgreSQL, Elasticsearch, dan Http. Parameter ini wajib diisi untuk koneksi sumber data. Jika parameter ini tidak ditentukan, nilai default Http akan digunakan. Jenis Http digunakan untuk target protokol HTTP seperti API Destination. Jenis sumber data digunakan untuk koneksi data di pasar integrasi. |
Http |
| Parameters |
any |
No |
Parameter koneksi sumber data (objek JSON). Parameter ini wajib diisi ketika Type diatur ke jenis sumber data. Parameter ini tidak wajib untuk jenis Http. Untuk definisi bidang spesifik, panggil operasi GetConnectionType dan lihat ParamsSchema di tanggapan. |
{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"} |
| AuthParameters |
object |
No |
Konfigurasi otentikasi. |
|
| AuthorizationType |
string |
No |
Jenis metode autentikasi:
|
BASIC_AUTH |
| ApiKeyAuthParameters |
object |
No |
Konfigurasi otentikasi kunci API. |
|
| ApiKeyName |
string |
No |
Nama kunci API. |
Token |
| ApiKeyValue |
string |
No |
Nilai kunci API. |
adkjnakddh**** |
| BasicAuthParameters |
object |
No |
Konfigurasi otentikasi dasar. |
|
| Password |
string |
No |
Kata sandi untuk otentikasi dasar. |
******* |
| Username |
string |
No |
Nama pengguna untuk otentikasi dasar. |
admin |
| OAuthParameters |
object |
No |
Konfigurasi otentikasi OAuth. |
|
| AuthorizationEndpoint |
string |
No |
URL titik akhir otorisasi. Panjang maksimum: 127 karakter. |
http://localhost:8080/oauth/token |
| ClientParameters |
object |
No |
Konfigurasi parameter klien. |
|
| ClientID |
string |
No |
ID klien. |
ClientID |
| ClientSecret |
string |
No |
Rahasia klien aplikasi. |
Qo57Q~F249~S74GmNPA36pZJoJK4f4LY**** |
| HttpMethod |
string |
No |
Metode HTTP. Nilai valid:
|
POST |
| OAuthHttpParameters |
object |
No |
Parameter permintaan otentikasi OAuth. |
|
| BodyParameters |
array<object> |
No |
Daftar struktur data parameter permintaan body. |
|
|
object |
No |
Struktur data parameter permintaan body. |
||
| IsValueSecret |
string |
No |
Apakah nilai digunakan untuk otentikasi. |
false |
| Key |
string |
No |
Kunci parameter permintaan body. |
keyDemo |
| Value |
string |
No |
Nilai parameter permintaan body. |
keyValue |
| HeaderParameters |
array<object> |
No |
Daftar parameter header. |
|
|
object |
No |
Struktur data parameter header. |
||
| IsValueSecret |
string |
No |
Apakah nilai digunakan untuk otentikasi. |
false |
| Key |
string |
No |
Kunci parameter header. |
keyDemo |
| Value |
string |
No |
Nilai parameter header. |
keyValue |
| QueryStringParameters |
array<object> |
No |
Struktur data URI parameter jalur permintaan. |
|
|
object |
No |
Struktur data URI parameter jalur permintaan. |
||
| IsValueSecret |
string |
No |
Apakah nilai digunakan untuk otentikasi. |
false |
| Key |
string |
No |
Kunci URI parameter jalur permintaan. |
keyDemo |
| Value |
string |
No |
Nilai URI parameter jalur permintaan. |
valueDemo |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
ID permintaan yang dihasilkan oleh Alibaba Cloud untuk permintaan ini. |
7DA60DED-CD36-5837-B848-C01A23D2**** |
| Message |
string |
Informasi tambahan. Jika permintaan berhasil, success dikembalikan. Jika permintaan gagal, kode kesalahan spesifik dikembalikan. |
success |
| Code |
string |
Status API atau kode kesalahan POP. Nilai valid: Success. |
Success |
| Data |
object |
Hasil yang dikembalikan. |
|
| ConnectionName |
string |
Nama konfigurasi koneksi. |
connection-demo |
Contoh
Respons sukses
JSONformat
{
"RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
"Message": "success",
"Code": "Success",
"Data": {
"ConnectionName": "connection-demo"
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | InternalError | |
| 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 |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.