Modify API data source parameters with ModifyApiDatasourceParameters - Quick BI - Alibaba Cloud - Quick BI

Operation description

When modifying a query statement, only the top-level JsonObject can be modified. Parameters nested in multiple layers cannot be modified. For more information, see Create an API data source.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ModifyApiDatasourceParameters

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ApiId	string	Yes	The ID of the API data source.	b66a66de51f24d149116c17718138194
WorkspaceId	string	Yes	The workspace ID.	726bee5a-****-43e1-9a8e-b550f0120f35
Parameters	string	Yes	The configuration of API data parameters in the JSONArray format. You can modify a maximum of 10 parameters. name: the name of a common parameter or a parameter in a query statement value: the value of a common parameter or a parameter in a query statement.	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]

Response elements

Element	Type	Description	Example
	object	The information returned.
RequestId	string	The request ID.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	The execution result of the operation. Valid values: true: The request was successful. false: The request failed.	true
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ApiDataSource.NotIn.Workspace	Target apiId not in target workspace.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	ApiDatasource.Not.Exist	Api datasource not exist.
400	ApiDatasource.Param.IsNull	Api datasource modify parameters is null.
400	ApiDatasource.Param.Oversize	The number of parameters of API data source exceeds the limit and cannot exceed %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.