首页 Quick BI 开发参考 API参考(专业版) API目录 数据集资源管理 ModifyApiDatasourceParameters - 修改API数据源配置

ModifyApiDatasourceParameters - 修改API数据源配置

更新时间: 2023-06-27 16:37:00

修改指定API数据源的配置。

接口说明

修改查询语句时,仅支持修改最上层的JsonObject,不支持多层嵌套内的参数修改。具体的参数说明详见创建API数据源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ApiIdstring

API数据源的ID。

b66a66de51f24d149116c17718138194
WorkspaceIdstring

工作空间ID。

726bee5a-****-43e1-9a8e-b550f0120f35
Parametersstring

JSONArray格式的API数据参数配置,修改的参数数量不能超过10个。

  • name:普通参数或查询语句中的参数名称
  • value:普通参数或查询语句中的参数值
[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultboolean

接口执行结果。取值范围:

  • true:请求成功
  • false:请求失败
true
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400ApiDataSource.NotIn.WorkspaceTarget apiId not in target workspace.目标API不在工作空间内。
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400ApiDatasource.Not.ExistApi datasource not exist.API数据源不存在。
400ApiDatasource.Param.IsNullApi datasource modify parameters is null.API数据源的修改参数parameters为空。
400ApiDatasource.Param.OversizeThe number of parameters of API data source exceeds the limit and cannot exceed %s.API数据源的参数数量超过限制,不能超过%s个。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。

访问错误中心查看更多错误码。

阿里云首页 Quick BI 相关技术圈