GetAgent - EventBridge - Alibaba Cloud Documentation Center

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Name	string	Yes	Nama agen.	my-agent

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
Message	string	Paket kesalahan.	Agent with name 'xxx' not found for account 1186xxx
RequestId	string	ID permintaan.	E0FFAB67-XXXXXX-CAD4D37448C4
Data	Agent	Hasil yang dikembalikan.	true
Code	string	Status API atau kode kesalahan POP. Nilai valid: Success: berhasil.	Success
Success	boolean	Mengembalikan true jika operasi berhasil.	true

Contoh

Respons sukses

JSONformat

{
  "Message": "Agent with name 'xxx' not found for account 1186xxx",
  "RequestId": "E0FFAB67-XXXXXX-CAD4D37448C4",
  "Data": {
    "Name": "",
    "Description": "",
    "Prompt": "",
    "Metadata": {
      "Attachments": [
        {
          "MimeType": "inner-resource/event-table",
          "Arn": "acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-xxx/table/order"
        }
      ]
    },
    "CreatedAt": 0,
    "UpdatedAt": 0
  },
  "Code": "Success",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.