Gunakan GetApiDestination untuk mengkueri informasi tentang tujuan API-EventBridge-Alibaba Cloud - EventBridge

Mengkueri informasi tujuan API.

Deskripsi operasi

You can call this API operation to query the information about an API destination.

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:GetApiDestination

get

*ApiDestination

acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ApiDestinationName	string	Yes	Nama tujuan API.	api-destination-name

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B896B484-F16D-59DE-9E23-DD0E5C361108
Message	string	The returned message. If the request is successful, success is returned. If the request failed, an error code is returned.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
Data	object	The returned data.
ApiDestinationName	string	The name of the API destination.	demo
ConnectionName	string	The connection name.	test-basic
Description	string	The description of the API destination.	demo
HttpApiParameters	object	The request parameters that are configured for the API destination.
Endpoint	string	The endpoint of the API destination.	http://127.0.0.1:8001/api
Method	string	The HTTP request method. Valid values: POST GET DELETE PUT HEAD TRACE PATCH	POST
GmtCreate	integer	The time when the API destination was created.	1649055710565

Contoh

Respons sukses

JSONformat

{
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C361108",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinationName": "demo",
    "ConnectionName": "test-basic",
    "Description": "demo",
    "HttpApiParameters": {
      "Endpoint": "http://127.0.0.1:8001/api\n",
      "Method": "POST"
    },
    "GmtCreate": 1649055710565
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception
409	ApiDestinationNotExist	The api-destination not existed!

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.