Gunakan GetConnection untuk kueri konfigurasi koneksi - EventBridge - Alibaba Cloud - EventBridge

Mengkueri informasi konfigurasi dari satu koneksi.

Deskripsi operasi

Mengkueri informasi konfigurasi dari satu koneksi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:GetConnection

get

*Connection

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ConnectionName	string	Yes	Nama koneksi.	connection-name

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan yang dikembalikan.	34AD682D-5B91-5773-8132-AA38C130****
Message	string	Informasi yang dikembalikan oleh permintaan API.	success
Code	string	Status API atau kode kesalahan POP. Nilai yang valid: Success: Permintaan berhasil.	Success
HttpCode	integer	Kode status HTTP.	200
Data	object	Hasil yang dikembalikan.
Connections	array<object>	Daftar informasi konfigurasi koneksi.
	array<object>	Struktur data dari informasi konfigurasi koneksi.
ConnectionName	string	Nama konfigurasi koneksi.	demo
Id	integer	ID sumber data.	5668
Description	string	Deskripsi konfigurasi koneksi.	demo
Type	string	Tipe koneksi. Nilai yang valid: Http, MySQL, PostgreSQL, Elasticsearch.	Http
Parameters	any	Parameter koneksi sumber data (objek JSON). Parameter ini hanya dikembalikan untuk koneksi bertipe sumber data, dan kosong untuk tipe Http. Untuk definisi field, lihat ParamsSchema yang dikembalikan oleh GetConnectionType.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
GmtCreate	integer	Waktu pembuatan.	1669648905
NetworkParameters	object	Struktur data konfigurasi jaringan.
NetworkType	string	Jaringan publik: PublicNetwork Virtual private cloud (VPC): PrivateNetwork	PublicNetwork
VpcId	string	ID dari virtual private cloud (VPC).	eb-test/vpc-bp1symadadwnwg****
VswitcheId	string	ID vSwitch.	vsw-bp1iu4x7aeradadown**,vsw-bp193sqmadadlaszpeq**
SecurityGroupId	string	ID grup keamanan.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
AuthParameters	object	Struktur data otorisasi.
AuthorizationType	string	Tipe otorisasi. Nilai yang valid: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
ApiKeyAuthParameters	object	Struktur data API key.
ApiKeyName	string	Kunci dari API key.	key
ApiKeyValue	string	Nilai dari API key.	value
BasicAuthParameters	object	Struktur data autentikasi dasar.
Password	string	Kata sandi untuk autentikasi dasar.	********
Username	string	Nama pengguna untuk autentikasi dasar.	admin
OAuthParameters	object	Struktur data parameter permintaan OAuth.
AuthorizationEndpoint	string	Endpoint OAuth untuk memperoleh token.	http://localhost:8080/oauth/token
HttpMethod	string	Metode permintaan HTTP. Nilai yang valid: GET POST HEAD	POST
ClientParameters	object	Struktur data parameter klien.
ClientID	string	ID klien.	ClientID
ClientSecret	string	Client secret dari aplikasi.	Qo57Q~F249~S74GmNPA36pZJoJK4f4****
OAuthHttpParameters	object	Parameter permintaan untuk autentikasi OAuth.
BodyParameters	array<object>	Daftar struktur data parameter permintaan.
	object	Daftar struktur data parameter permintaan.
IsValueSecret	string	Menentukan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter permintaan body.	keyDemo
Value	string	Nilai dari parameter permintaan body.	valueDemo
HeaderParameters	array<object>	Daftar parameter header permintaan.
	object	Daftar parameter header permintaan.
IsValueSecret	string	Menentukan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter header permintaan.	keyDemo
Value	string	Nilai dari parameter header permintaan.	keyDemo
QueryStringParameters	array<object>	Struktur data parameter path permintaan.
	object	Struktur data parameter path permintaan.
IsValueSecret	string	Menentukan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter path permintaan.	keyDemo
Value	string	Nilai dari parameter path permintaan.	valueDemo

Contoh

Respons sukses

JSONformat

{
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Message": "success",
  "Code": "Success",
  "HttpCode": 200,
  "Data": {
    "Connections": [
      {
        "ConnectionName": "demo",
        "Id": 5668,
        "Description": "demo",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "GmtCreate": 1669648905,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwg****",
          "VswitcheId": "vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "key",
            "ApiKeyValue": "value"
          },
          "BasicAuthParameters": {
            "Password": "********",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "Qo57Q~F249~S74GmNPA36pZJoJK4f4****"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "keyDemo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError	InternalError
409	RequestParameterException	Pengecualian parameter permintaan
409	ConnectionNotExist	Nama Connection tidak ada!

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.