建立連接器,當前介面僅支援建立檔案類型連接器。
介面說明
- RAM 使用者(子帳號)需要首先擷取阿里雲百鍊的 API 許可權(需要
AliyunBailianDataFullAccess,已包括 sfm:AddCategory 許可權點),並加入一個業務空間後,方可調用本介面。阿里雲帳號(主帳號)可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。 - 本介面不具備等冪性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:
- 操作:是指具體的許可權點。
- 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。
-
資源類型:是指操作中支援授權的資源類型。具體說明如下:
- 對於必選的資源類型,用前面加 * 表示。
- 對於不支援資源級授權的操作,用
全部資源表示。
- 條件關鍵字:是指雲產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:AddConnector | create | *全部資源
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 知識庫所在工作空間 ID | llm-3shx2gu255oxxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| ConnectorName | string | 是 | 連接器名稱 | test-connector |
| ConnectorType | string | 是 | 連接器類型 | FILE |
| Description | string | 是 | 描述 | 檔案連接器 |
| FileConnectorConfig | object | 否 | 檔案連接器參數 | |
| RegionId | string | 否 | 儲存 bucket 地區 | cn-hangzhou |
| BucketName | string | 否 | 儲存 bucket 名稱 | zyb-docker-registry-jn |
| StorageType | string | 否 | 檔案儲存體位置 OSS_CUSTOM:使用自有 OSS 儲存 OSS_PLATFORM:使用平台 OSS 儲存 | OSS_CUSTOM |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | 錯誤狀態代碼 | Success |
| Data | object | 介面業務資料欄位 | |
| ConnectorId | string | 連接器 ID | conn_file_e0c9db4030b2465a9478028f7d76cd92_1234 |
| Message | string | 錯誤資訊 | Current file status does not support delete. |
| RequestId | string | Id of the request | 35A267BF-FBFA-54DB-8394-AA3B0742D833 |
| Status | string | 介面返回的狀態代碼 | 200 |
| Success | boolean | 介面調用是否成功,可能值為:
| true |
樣本
正常返回樣本
JSON格式