修改指定API資料來源的配置。
介面說明
修改查詢語句時，僅支援修改最上層的 JsonObject，不支援多層嵌套內的參數修改。具體的參數說明詳見建立 API 資料來源。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
quickbi-public:ModifyApiDatasourceParameters |
update |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ApiId |
string |
是 |
API 資料來源的 ID。 |
b66a66de51f24d149116c17718138194 |
| WorkspaceId |
string |
是 |
工作空間 ID。 |
726bee5a-****-43e1-9a8e-b550f0120f35 |
| Parameters |
string |
是 |
JSONArray 格式的 API 資料參數配置，修改的參數數量不能超過 10 個。
|
[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}] |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
D8749D65-E80A-433C-AF1B-CE9C180FF3B4 |
| Result |
boolean |
介面執行結果。取值範圍：
|
true |
| Success |
boolean |
是否請求成功。取值範圍：
|
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": true,
"Success": true
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ApiDataSource.NotIn.Workspace | Target apiId not in target workspace. | 目標API不在工作空間內。 |
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | 空間不在組織內。 |
| 400 | ApiDatasource.Not.Exist | Api datasource not exist. | API資料來源不存在。 |
| 400 | ApiDatasource.Param.IsNull | Api datasource modify parameters is null. | API資料來源的修改參數parameters為空白。 |
| 400 | ApiDatasource.Param.Oversize | The number of parameters of API data source exceeds the limit and cannot exceed %s. | API資料來源的參數數量超過限制，不能超過%s個。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。