修改指定API数据源的配置。
接口说明
修改查询语句时,仅支持修改最上层的 JsonObject,不支持多层嵌套内的参数修改。具体的参数说明详见创建 API 数据源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
 - 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
 - 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
 - 对于不支持资源级授权的操作,用
全部资源表示。 
 - 条件关键字:是指云产品自身定义的条件关键字。
 - 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
 
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| 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}] | 
返回参数
示例
正常返回示例
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个。 | 
访问错误中心查看更多错误码。
