Authorize Intelligent Q&A in Batch with SmartqAuthorize - Quick BI

Operation description

Manages authorizations for Intelligent Q&A in batches. Granting an existing authorization is treated as a new grant operation. By default, an attempt to delete an authorization that does not exist is skipped and no audit log is recorded.

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:SmartqAuthorize

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
OperationType	integer	Yes	The operation type. Valid values: 0: Grant authorization 1: Delete authorization Valid values: 0 : Grant authorization 1 : Delete authorization	0
UserIds	string	Yes	An array of user IDs. Separate multiple IDs with commas. Important The number of user IDs × (the number of Q&A resources + the number of analysis subjects) in a single request cannot exceed 100.	wasdasd*****1235235sd,ASDAS*******ASDAW123
LlmCubes	string	No	An array of Q&A resource IDs. Separate multiple IDs with commas.	wasdasd*****1235235sd,ASDAS*******ASDAW123
LlmCubeThemes	string	No	An array of analysis subject IDs. Separate multiple IDs with commas.	wasdasd*****1235235sd,ASDAS*******ASDAW123
ExpireDay	string	No	The expiration time. The default is seven days. Format: 2099-12-31	2099-12-31
CubeIds	string	No	An array of dataset IDs. Separate multiple IDs with commas. Important This parameter is converted to the corresponding Q&A resource ID for authorization. If a `cubeId` does not correspond to an existing Q&A resource, an error is reported that the Q&A resource does not exist. Ensure that the `cubeId` is correct.	wasdasd*****1235235sd,ASDAS*******ASDAW123

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	617277C****************ABA47E31
Result	array<object>	An array of user information for failed operations.
	object	Information about the user for whom the operation failed.
UserId	string	The user ID.	617277C****************ABA47E31
LlmCube	string	The Q&A resource ID.	617277C****************ABA47E31
LlmCubeTheme	string	The analysis subject ID.	617277C****************ABA47E31
DetailMessage	string	The reason for the failure.	INVALID_FILE_FORMAT
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": "617277C****************ABA47E31",
  "Result": [
    {
      "UserId": "617277C****************ABA47E31",
      "LlmCube": "617277C****************ABA47E31",
      "LlmCubeTheme": "617277C****************ABA47E31",
      "DetailMessage": "INVALID_FILE_FORMAT"
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Date.Format.Error	Date format conversion error.	Date format conversion error
400	Date.Exceed.Error	The start date must be within 90 days from the current date.	Start date cannot be 90 days earlier than current date
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Query.Auth.Error	Query is not permitted.	No query permission.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.
400	Share.ExpireDate.Error	The expire date is illegal.
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.	Please purchase Nl2sql module first.
400	API.Not.Exist	The data service API operation does not exist.	The data service API operation does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.