智能問數查詢。
接口說明
特別說明:當使用者被授權調用該 API 時,默認使用者有權限通過傳入 userId 以該用戶身份查詢對應的數據
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
UserId | string | 否 | 用戶 ID。 注意 該字段不填寫時默認以組織所有者身份查詢數據。 | 7c7223ae-****-3c744528014b |
UserQuestion | string | 是 | 問題文本。 | 今年銷售額數據 |
CubeId | string | 是 | 數據集 ID。 | 7c7223ae-****-3c744528014b |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D787E1A3-A************2B05DF8D885",
"Result": {
"ChartType": "NEW_TABLE",
"MetaType": [
{
"Key": "Polar***STPS",
"Value": "string"
}
],
"Values": [
{
"Row": [
"199"
]
}
]
},
"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沒有權限操作。 |
500 | Invalid.User.Organization | The user is not in your organization. | 該用戶不在您的組織中。 |
訪問錯誤中心查看更多錯誤碼。