调用SmartqQueryAbility API进行小Q问数查询-智能商业分析 Quick BI-阿里云

小Q问数查询。

接口说明

特别说明：当使用者被授权调用该 API 时，默认使用者有权限通过传入 userId 以该用户身份查询对应的数据

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:SmartqQueryAbility

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
UserId	string	否	用户 ID。重要该字段不填写时默认以组织所有者身份查询数据。	7c7223ae-****-3c744528014b
UserQuestion	string	是	问题文本。	test
CubeId	string	否	数据集 ID，点击工作台-->数据集，打开选定的数据集后，url 中携带有该数据集的 cubeId 信息多表场景下，该参数须为空。	7c7223ae-****-3c744528014b
MultipleCubeIds	string	否	多数据集 id 列表模型会根据问题内容，选择列表中一张或多张表生成回答，多表场景下该参数为必要，单表场景不需要该参数。	test

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	D787E1A3-A************2B05DF8D885
Result	object	返回结果。
ChartType	string	建议图表类型。	NEW_TABLE
MetaType	array<object>	列元组类型列表。
	object	元数据对象。
Key	string	列元组名称。	Polar***STPS
Value	string	列元组类型。	string
Type	string	元数据行列类型。 Dimension：维度 Measure：度量	Dimension
Values	array<object>	数据值列表数组。
	object	数据值列表对象。
Row	array	每一行的数据值。
	string	每个字段的数据值。	199
LogicSql	string	可视化逻辑 sql。	select * ****
ConclusionText	string	总结信息。	test
DataList	array	仅多步场景下返回数据列表，每一个元素对应一份图表数据。
	string	图表数据。	test
Success	boolean	是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A************2B05DF8D885",
  "Result": {
    "ChartType": "NEW_TABLE",
    "MetaType": [
      {
        "Key": "Polar***STPS",
        "Value": "string",
        "Type": "Dimension"
      }
    ],
    "Values": [
      {
        "Row": [
          "199"
        ]
      }
    ],
    "LogicSql": "select * ****",
    "ConclusionText": "test",
    "DataList": [
      "test"
    ]
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Query.Auth.Error	Query is not permitted.	没有查询权限。
400	Instance.Expired	Your instance has expired.	您的购买实例已经过期。
400	Instance.Not.Exist	The specified instance does not exist.	暂未匹配到您的购买实例。
400	Invalid.Organization	The specified organizational unit does not exist.	该组织不存在。
400	User.Not.In.Organization	The specified user is not in the organizational unit.	该用户不在组织中。
400	Invalid.Parameter	An error occurred while verifying parameters.	参数验证失败。
400	Invalid.Parameter.Error	The parameter is invalid:%s.	无效参数%s。
400	Invalid.Param.Error	The parameter is invalid.	无效参数。
400	Invalid.User.Admin	You are not an administrator of this organization.	没有权限，您不是组织管理员。
400	System.Param.Empty	You must specify the %s parameter.	参数%s不能为空。
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.	您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。
400	UserInfo.Error	The personal information is invalid.	个人信息不合法。
400	ApiUser.Not.Exists	The specified user does not exist.	用户不存在。
400	User.Not.WorkspaceAdmin	Only administrators of the group workspace can perform this operation.	没有权限，您不是该群空间的管理员。
400	Application.Object.NotExist	The object you are operating does not exist or has been deleted.	操作组件不存在或已被删除。
400	Not.ApiCall.AuthUser	You are not an administrator or API call auth user of this organization.	非组织管理员或API调用授权用户。
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	此用户%s没有权限操作。
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.	请先购买智能问数模块。
500	Invalid.User.Organization	The user is not in your organization.

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

变更历史

更多信息，参考变更详情。