Gunakan CreateApiDestination untuk membuat tujuan API - EventBridge - Alibaba Cloud - EventBridge

Deskripsi operasi

You can call this API operation to create 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:CreateApiDestination

create

*ApiDestination

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ApiDestinationName	string	Yes	Nama tujuan API. Panjang nama harus 2 hingga 127 karakter.	api-destination-name
ConnectionName	string	Yes	Nama koneksi. Panjang nama harus 2 hingga 127 karakter. Catatan Sebelum mengonfigurasi parameter ini, Anda harus memanggil operasi CreateConnection untuk membuat koneksi. Lalu, atur parameter ini ke nama koneksi yang telah Anda buat.	connection-name
Description	string	No	Deskripsi tujuan API. Panjang deskripsi dapat mencapai 255 karakter.	This is the description.
HttpApiParameters	object	Yes	Parameter yang dikonfigurasi untuk tujuan API.
Endpoint	string	Yes	The endpoint of the API destination. The endpoint can be up to 127 characters in length.	http://127.0.0.1:8001/api
Method	string	Yes	The HTTP request method. Valid values: GET POST HEAD DELETE PUT PATCH	POST

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5DAF96FB-A4B6-548C-B999-0BFDCB22****
Message	string	The returned message.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
Date	object	The data returned if the API destination is created.
ApiDestinationName	string	The name of the API destination.	ApiDestinationName

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB22****",
  "Message": "success",
  "Code": "Success",
  "Date": {
    "ApiDestinationName": "ApiDestinationName"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception
409	RequestParameterInvalid	The ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.
409	ApiDestinationAlreadyExist	The api-destination already existed!
409	ConnectionNotExist	The Connection not existed!
409	HttpApiParametersIsNull	HttpApiParameters is null!
409	EndpointIsBlank	Endpoint is blank!
409	Method	Method is blank!
409	EndpointLengthExceed	Endpoint length cannot exceed 127!
409	ApiDestinationCountExceedLimit	The current count of api-destination is [{0}], which will exceed the limit quota.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.