Mengambil informasi connector. Saat ini, operasi ini hanya mendukung pengambilan informasi file connector.
Deskripsi operasi
- Pengguna Resource Access Management (RAM) harus terlebih dahulu mendapatkan izin API untuk Alibaba Cloud Studio Model (memerlukan
AliyunBailianDataFullAccess, yang mencakup izin sfm:GetConnector), dan bergabung ke ruang kerja sebelum memanggil operasi ini. Akun Alibaba Cloud dapat memanggil operasi ini secara langsung tanpa otorisasi. Gunakan Alibaba Cloud Studio Model SDKAlibaba Cloud Studio Model SDK versi terbaru untuk memanggil operasi ini. - Operasi ini bersifat idempoten.
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.
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
Actionpada 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
Resourcepada kebijakan. - Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen
Resourcepada kebijakan.
- 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
- 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 |
|---|---|---|---|---|
sfm:GetConnector | get | *全部资源
| None | None |
Sintaks permintaan
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | ID ruang kerja tempat file berada. Untuk informasi cara mendapatkan ID ruang kerja, lihat Cara menggunakan ruang kerja. | llm-3z7uw7fwz0vxxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ConnectorName | string | No | Nama connector yang akan dikueri. Pencocokan tepat. | 连接器名称 |
| ConnectorId | string | No | ID connector. Anda dapat mendapatkan ID connector dari daftar connector di Konsol Studio Model. | conn_file_xxxx |
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Skema Tanggapan. | ||
| Code | string | Kode status error. | success |
| Data | object | Bidang data bisnis yang dikembalikan oleh operasi. | |
| ConnectorId | string | ID connector. | conn_file_e0c9db4030b2465a9478028f7d76cd92_1234 |
| ConnectorName | string | Nama connector. | name |
| ConnectorType | string | Tipe connector. | FILE |
| Description | string | Deskripsi connector. | Description |
| Message | string | Paket error. | Requests throttling triggered. |
| RequestId | string | ID permintaan. | 7BA8ADD9-53D6-53F0-918F-A1E776AD230E |
| Status | string | Kode status yang dikembalikan oleh operasi. | 200 |
| Success | boolean | Apakah panggilan berhasil. Nilai valid:
| True |
Contoh
Respons sukses
JSONformat