Panggil API ListConnections untuk kueri koneksi - EventBridge - Alibaba Cloud - EventBridge

Mengkueri daftar konfigurasi koneksi.

Deskripsi operasi

Mengkueri daftar konfigurasi 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:ListConnections

get

*Connection

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ConnectionNamePrefix	string	No	Prefiks nama konfigurasi koneksi yang akan dikueri. Mendukung pencocokan prefiks.	connection-name
Type	string	No	Memfilter hasil kueri berdasarkan tipe koneksi. Nilai yang valid: Http, MySQL, PostgreSQL, Elasticsearch. Jika dikosongkan, koneksi dari semua tipe akan dikembalikan.	Http
MaxResults	integer	No	Jumlah maksimum entri yang dikembalikan di setiap halaman. Dapat digunakan bersama dengan NextToken untuk mengimplementasikan paginasi. Nilai default: 10	10
NextToken	string	No	Ketika MaxResults ditentukan, NextToken dikembalikan jika masih ada hasil yang dapat diambil. NextToken dimulai dari 0 secara default. Nilai default: 0.	0

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	Parameter umum. ID setiap permintaan bersifat unik dan dapat digunakan untuk pemecahan masalah serta pelacakan masalah.	E3619976-8714-5D88-BBA2-6983D798A8BB
Message	string	Pesan yang dikembalikan.	success
Code	string	Status API atau kode kesalahan POP. Nilai yang valid: Success: Permintaan berhasil.	Success
Data	object	Daftar konfigurasi koneksi yang dikembalikan.
Connections	array<object>	Daftar konfigurasi koneksi yang dikembalikan.
	array<object>	Struktur data konfigurasi koneksi yang dikembalikan.
ConnectionName	string	Nama dari konfigurasi koneksi.	connection-name
Description	string	Deskripsi dari konfigurasi koneksi.	Deskripsi dari konfigurasi koneksi
Type	string	Tipe koneksi. Nilai yang valid: Http, MySQL, PostgreSQL, Elasticsearch.	Http
Parameters	any	Parameter koneksi sumber data (objek JSON). Hanya dikembalikan untuk koneksi tipe sumber data; 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"}
Id	integer	ID dari konfigurasi koneksi.	1141093
GmtCreate	integer	Stempel waktu saat sumber data dibuat.	1592838994234
NetworkParameters	object	Struktur data dari konfigurasi jaringan.
NetworkType	string	Jaringan publik: PublicNetwork Virtual Private Cloud (VPC): PrivateNetwork	PublicNetwork
VpcId	string	ID dari Virtual Private Cloud (VPC).	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	ID vSwitch.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	ID grup keamanan.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
AuthParameters	object	Struktur data autentikasi.
AuthorizationType	string	Tipe autentikasi: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
ApiKeyAuthParameters	object	Struktur data dari API KEY.
ApiKeyName	string	Kunci dari API key.	Token
ApiKeyValue	string	Nilai dari API key.	asdkjnqkwejooa
BasicAuthParameters	object	Struktur data dari autentikasi Basic.
Password	string	Kata sandi untuk autentikasi basic.	admin
Username	string	Nama pengguna untuk autentikasi basic.	admin
OAuthParameters	object	Struktur data dari parameter permintaan OAuth.
AuthorizationEndpoint	string	Endpoint tujuan pengiriman permintaan token OAuth.	http://localhost:8080/oauth/token
HttpMethod	string	Metode dari tipe probe. Nilai yang valid: GET POST HEAD	POST
ClientParameters	object	Struktur data dari parameter klien.
ClientID	string	ID klien.	ClientID
ClientSecret	string	Client secret dari aplikasi.	ClientSecret
OAuthHttpParameters	object	Parameter permintaan untuk autentikasi OAuth.
BodyParameters	array<object>	Daftar struktur data dari parameter permintaan.
	object	Struktur data dari parameter permintaan body.
IsValueSecret	string	Menunjukkan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter permintaan body.	name
Value	string	Nilai dari parameter permintaan body.	demo
HeaderParameters	array<object>	Daftar parameter header permintaan.
	object	Struktur data dari parameter header permintaan.
IsValueSecret	string	Menunjukkan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter header permintaan.	name
Value	string	Nilai dari parameter header permintaan.	demo
QueryStringParameters	array<object>	Struktur data dari parameter query string.
	object	Kelas entitas dari parameter query string.
IsValueSecret	string	Menunjukkan apakah digunakan untuk autentikasi.	false
Key	string	Kunci dari parameter query string.	name
Value	string	Nilai dari parameter query string.	demo
NextToken	string	Jika masih ada hasil yang dapat diambil, NextToken akan dikembalikan.	0
Total	number	Jumlah total entri.	1
MaxResults	number	Ukuran halaman.	10

Contoh

Respons sukses

JSONformat

{
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "ConnectionName": "connection-name",
        "Description": "Description of the connection configuration",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "Id": 1141093,
        "GmtCreate": 1592838994234,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwgmqud",
          "VswitcheId": "vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "Token",
            "ApiKeyValue": "asdkjnqkwejooa"
          },
          "BasicAuthParameters": {
            "Password": "admin",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "ClientSecret"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ]
            }
          }
        }
      }
    ],
    "NextToken": "0",
    "Total": 1,
    "MaxResults": 10
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	InternalError
409	RequestParameterException	Pengecualian parameter permintaan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.