ListCustomAgents - DataWorks - Alibaba Cloud Documentation Center

Mengambil daftar agen kustom dengan paginasi.

Deskripsi operasi

Permintaan

Kata kunci pencarian: Gunakan parameter Q untuk melakukan pencarian fuzzy berdasarkan nama agen.
Pemfilteran tingkat visibilitas: Gunakan parameter Visibility untuk memfilter hasil berdasarkan tingkat visibilitas, seperti TENANT, PROJECT, atau USER.
Informasi paginasi: Gunakan parameter MaxResults dan NextToken untuk menerapkan kueri berpaginasi. NextToken mengambil halaman hasil berikutnya.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
MaxResults	integer	No	Jumlah maksimum entri yang dikembalikan pada satu halaman.	20
NextToken	string	No	Token paginasi. Abaikan parameter ini untuk permintaan pertama. Untuk permintaan berikutnya, gunakan nilai `NextToken` dari respons sebelumnya untuk mengambil halaman berikutnya.	12345
Q	string	No	Kata kunci pencarian untuk pencocokan fuzzy berdasarkan nama agen.	analysis
Visibility	array	No	Memfilter hasil berdasarkan tingkat visibilitas. Anda dapat menentukan beberapa tingkat.	-
	string	No	Tingkat visibilitas.	TENANT

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
PagingInfo	object	Informasi paginasi.
TotalCount	integer	Jumlah total entri yang memenuhi kriteria filter.	100
MaxResults	integer	Jumlah maksimum entri yang dikembalikan dalam respons ini.	20
NextToken	string	Token untuk mengambil halaman hasil berikutnya. Parameter ini kosong ketika tidak ada lagi hasil yang dikembalikan.	5
Agents	array<object>	Daftar agen kustom.
	object	Agen kustom.
Name	string		my-agent
DisplayName	string		我的助手
Description	string		数据分析助手
CreatorId	string		123456
ModifierId	string		123456
Visibility	string		TENANT
GmtCreateTime	string		1780555634000
GmtModifiedTime	string		1780555634000

Contoh

Respons sukses

JSONformat

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "MaxResults": 20,
    "NextToken": "5",
    "Agents": [
      {
        "Name": "my-agent",
        "DisplayName": "我的助手",
        "Description": "数据分析助手",
        "CreatorId": "123456",
        "ModifierId": "123456",
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.