Menanyakan daftar tujuan API.
Deskripsi operasi
Anda dapat menggunakan operasi API ini untuk menanyakan daftar tujuan API.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eventbridge:ListApiDestinations |
list |
*ApiDestination
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ApiDestinationNamePrefix |
string |
No |
Awalan nama tujuan API. |
api-demo |
| ConnectionName |
string |
No |
Nama koneksi. |
connection-name |
| MaxResults |
integer |
No |
Jumlah maksimum entri yang akan dikembalikan dalam satu panggilan. Anda dapat menggunakan parameter ini bersama NextToken untuk menerapkan paginasi.
|
10 |
| NextToken |
string |
No |
Jika Anda mengatur Limit dan terdapat nilai pengembalian yang berlebih, parameter ini akan dikembalikan.
|
0 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
ID permintaan. |
96D7C0AB-DCE5-5E82-96B8-4725E1706BB1 |
| Message |
string |
Pesan yang dikembalikan. Jika permintaan berhasil, success akan dikembalikan. Jika permintaan gagal, kode kesalahan akan dikembalikan. |
success |
| Code |
string |
Kode respons yang dikembalikan. Nilai Success menunjukkan bahwa permintaan berhasil. |
Success |
| Data |
object |
Data yang dikembalikan. |
|
| ApiDestinations |
array<object> |
Daftar tujuan API. |
|
|
array<object> |
|||
| ApiDestinationName |
string |
The name of the API destination. |
api-destination-2 |
| ConnectionName |
string |
The connection name. |
connection-name |
| Description |
string |
The description of the connection. |
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 |
| GmtCreate |
integer |
The time when the API destination was created. |
1665223213000 |
| NextToken |
string |
Jika terdapat nilai pengembalian yang berlebih, parameter ini akan dikembalikan. |
1 |
| Total |
number |
Jumlah total entri yang dikembalikan. |
2 |
| MaxResults |
number |
Jumlah maksimum entri yang dikembalikan per halaman. |
10 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "96D7C0AB-DCE5-5E82-96B8-4725E1706BB1",
"Message": "success",
"Code": "Success",
"Data": {
"ApiDestinations": [
{
"ApiDestinationName": "api-destination-2",
"ConnectionName": "connection-name",
"Description": "demo",
"HttpApiParameters": {
"Endpoint": "http://127.0.0.1:8001/api",
"Method": "POST"
},
"GmtCreate": 1665223213000
}
],
"NextToken": "1",
"Total": 2,
"MaxResults": 10
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | InternalError | |
| 409 | RequestParameterException | Request parameter exception |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.