SmartqQueryAbility - 智能问数查询

智能问数查询。

接口说明

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

调试

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

授权信息

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

请求参数

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

用户 ID。

注意 该字段不填写时默认以组织所有者身份查询数据。

7c7223ae-****-3c744528014b
UserQuestionstring

问题文本。

今年销售额数据
CubeIdstring

数据集 ID。

7c7223ae-****-3c744528014b

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

D787E1A3-A************2B05DF8D885
Resultobject

返回结果。

ChartTypestring

建议图表类型。

NEW_TABLE
MetaTypearray<object>

列元组类型列表。

MetaTypeobject

元数据对象。

Keystring

列元组名称。

Polar***STPS
Valuestring

列元组类型。

string
Valuesarray<object>

数据值列表数组。

Valuesobject

数据值列表对象。

Rowarray

每一行的数据值。

Rowstring

每个字段的数据值。

199
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Query.Auth.ErrorQuery is not permitted.没有查询权限。
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.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。
400UserRoleConfig.NotContain.FunctionThe user %s does not have permission to operate.此用户%s没有权限操作。
500Invalid.User.OrganizationThe user is not in your organization.该用户不在您的组织中。

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