'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'quickbi-public', 'version' => '2022-01-01', ], 'directories' => [ [ 'children' => [ [ 'children' => [ 'CheckOrganizationMember', 'AddUser', 'BatchAddFeishuUsers', 'DeleteUser', 'UpdateUser', 'QueryUserList', 'QueryUserInfoByUserId', 'QueryUserInfoByAccount', ], 'type' => 'directory', 'title' => '组织用户管理', 'id' => 238712, ], [ 'children' => [ 'CreateUserGroup', 'AddUserGroupMember', 'AddUserGroupMembers', 'DeleteUserGroup', 'DeleteUserGroupMember', 'DeleteUserGroupMembers', 'WithdrawAllUserGroups', 'UpdateUserGroup', 'GetUserGroupInfo', 'ListByUserGroupId', 'ListUserGroupsByUserId', 'QueryUserGroupListByParentId', 'QueryUserGroupMember', ], 'type' => 'directory', 'title' => '组织用户组管理', 'id' => 238729, ], [ 'children' => [ 'AddUserTagMeta', 'DeleteUserTagMeta', 'UpdateUserTagValue', 'QueryUserTagMetaList', 'QueryUserTagValueList', 'UpdateUserTagMeta', ], 'type' => 'directory', 'title' => '用户标签管理', 'id' => 238722, ], [ 'children' => [ 'ListWorkspaceUserRolesByUserId', 'ListWorkspaceRoleUsers', 'QueryWorkspaceRoleConfig', 'QueryOrganizationRoleConfig', 'ListWorkspaceRoles', 'ListOrganizationRoles', 'ListOrganizationRoleUsers', ], 'type' => 'directory', 'title' => '角色管理', 'id' => 238743, ], ], 'type' => 'directory', 'title' => '组织管理', 'id' => 238711, ], [ 'children' => [ [ 'children' => [ 'AddShareReport', 'CancelReportShare', 'QuerySharesToUserList', 'QueryShareList', ], 'type' => 'directory', 'title' => '报表分享授权管理', 'id' => 238685, ], [ 'children' => [ 'AuthorizeMenu', 'CancelAuthorizationMenu', 'ChangeVisibilityModel', 'ListPortalMenus', 'ListPortalMenuAuthorization', 'ListWhitePortalMenu', ], 'type' => 'directory', 'title' => '数据门户菜单授权管理', 'id' => 238690, ], [ 'children' => [ 'SetDataLevelPermissionRuleConfig', 'AddDataLevelPermissionRuleUsers', 'AddDataLevelPermissionWhiteList', 'DeleteDataLevelRuleConfig', 'DeleteDataLevelPermissionRuleUsers', 'UpdateDataLevelPermissionStatus', 'SetDataLevelPermissionExtraConfig', 'SetDataLevelPermissionWhiteList', 'QueryDatasetSwitchInfo', 'ListCubeDataLevelPermissionConfig', 'ListDataLevelPermissionWhiteList', ], 'type' => 'directory', 'title' => '行级权限管理', 'id' => 238696, ], [ 'children' => [ 'QueryApprovalInfo', 'ResultCallback', ], 'type' => 'directory', 'title' => '开放审批', 'id' => 238708, ], ], 'type' => 'directory', 'title' => '权限管理', 'id' => 238684, ], [ 'children' => [ [ 'children' => [ 'UpdateEmbeddedStatus', 'QueryWorksByOrganization', 'QueryWorksByWorkspace', 'QueryReadableResourcesListByUserIdV2', 'QueryReadableResourcesListByUserId', 'CheckReadable', 'QueryEmbeddedInfo', 'QueryEmbeddedStatus', 'QueryWorks', 'QueryWorksBloodRelationship', 'QueryComponentPerformance', 'QueryReportPerformance', 'GetWorksEmbedList', ], 'type' => 'directory', 'title' => '报表资源管理', 'id' => 238640, ], [ 'children' => [ 'CheckDatasetExisted', 'CreateCubeBySql', 'CreateDataset', 'AddDataSource', 'UpdateDataSource', 'UpdateCubeBySql', 'QueryLastAccelerationEngineJob', 'ListDataSource', 'DataSetBlood', 'DataSourceBlood', 'ModifyApiDatasourceParameters', 'ListApiDatasource', 'QueryDatasetInfo', 'QueryDatasetDetailInfo', 'QueryDatasetList', 'AllotDatasetAccelerationTask', 'QueryCubePerformance', 'QueryCubeOptimization', 'GetDataSourceConnectionInfo', 'ListAccelerationOfWorkspace', 'QueryAccelerationLogByCubeId', ], 'type' => 'directory', 'title' => '数据集资源管理', 'id' => 238654, ], [ 'children' => [ 'AddUserToWorkspace', 'AddWorkspaceUsers', 'DeleteUserFromWorkspace', 'UpdateWorkspaceUsersRole', 'UpdateWorkspaceUserRole', 'QueryWorkspaceUserList', 'QueryOrganizationWorkspaceList', 'QueryUserRoleInfoInWorkspace', 'CreateWorkspace', ], 'type' => 'directory', 'title' => '工作空间管理', 'id' => 238631, ], [ 'children' => [ 'SaveFavorites', 'CancelCollection', 'ListCollections', ], 'type' => 'directory', 'title' => '收藏管理', 'id' => 238673, ], [ 'children' => [ 'ListFavoriteReports', 'ListRecentViewReports', 'ListSharedReports', ], 'type' => 'directory', 'title' => '首页管理', 'id' => 238677, ], [ 'children' => [ 'ManualRunMailTask', 'GetMailTaskStatus', 'GetMailTaskList', ], 'type' => 'directory', 'title' => '订阅管理', 'id' => 238681, ], ], 'type' => 'directory', 'title' => '资源管理', 'id' => 238630, ], [ 'children' => [ [ 'children' => [ 'QueryData', 'QueryDataServiceList', 'QueryDataService', ], 'type' => 'directory', 'title' => '数据服务', 'id' => 238626, ], ], 'type' => 'directory', 'title' => '数据管理', 'id' => 238625, ], [ 'children' => [ [ 'children' => [ 'CreateTicket', 'DeleteTicket', 'DelayTicketExpireTime', 'UpdateTicketNum', 'QueryTicketInfo', ], 'type' => 'directory', 'title' => '报表嵌入', 'id' => 238619, ], ], 'type' => 'directory', 'title' => '嵌入分析', 'id' => 238618, ], [ 'children' => [ [ 'children' => [ 'QueryAuditLog', ], 'type' => 'directory', 'title' => '资源分析', 'id' => 238752, ], ], 'type' => 'directory', 'title' => '统计分析', 'id' => 238751, ], [ 'children' => [ [ 'children' => [ 'CreateTicket4Copilot', 'ModifyCopilotEmbedConfig', 'QueryCopilotEmbedConfig', 'QueryDataRange', ], 'type' => 'directory', 'title' => '智能问数嵌入', 'id' => 238755, ], [ 'children' => [ 'ModifyDashboardNl2sqlStatus', 'QueryDashboardNl2sql', 'SmartqAuthorize', 'QueryLlmCubeWithThemeListByUserId', 'SmartqAuthTransfer', 'QuerySmartqPermissionByCubeId', 'QueryDatasetSmartqStatus', 'SmartqQueryAbility', ], 'type' => 'directory', 'title' => '智能问数管理', 'id' => 238760, ], ], 'type' => 'directory', 'title' => '智能问数', 'id' => 238754, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddDataLevelPermissionRuleUsers' => [ 'summary' => '针对单条行列权限规则增量添加选定的人群。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'AddUserModel', 'in' => 'query', 'schema' => [ 'description' => '{'."\n" .' "ruleId": "a5bb24da-***-a891683e14da", // 行列权限规则ID'."\n" .' "cubeId": "7c7223ae-***-3c744528014b", // 数据集ID'."\n" .' "addModel": {'."\n" .' "userGroups": ['."\n" .' "0d5fb19b-***-1248fc27ca51", // 添加用户组人群的用户组ID'."\n" .' "3d2c23d4-***-f6390f325c2d"'."\n" .' ],'."\n" .' "users": ['."\n" .' "4334***358", // 添加用户人群的UserID'."\n" .' "Huang***3fa822"'."\n" .' ]'."\n" .' }'."\n" .'}', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ruleId":"a5bb24da-***-a891683e14da","cubeId":"7c7223ae-***-3c744528014b","addModel":{"userGroups":["0d5fb19b-***-1248fc27ca51","3d2c23d4-***-f6390f325c2d"],"users":["4334***358","Huang***3fa822"]}}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '', ], [ 'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The usergroup %s does not belong to the current organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n true\\n true\\n","errorExample":""}]', 'title' => '添加行列权限规则人群', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [ [ 'createdAt' => '2025-03-14T06:35:33.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:57.000Z', 'description' => 'OpenAPI 下线', ], [ 'createdAt' => '2022-03-04T09:50:57.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddDataLevelPermissionRuleUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddDataLevelPermissionWhiteList' => [ 'summary' => '修改指定数据集行列权限的白名单。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-***-3c744528014b', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => '行级权限类型：'."\n" ."\n" .'- ROW_LEVEL：行级权限，'."\n" .'- COLUMN_LEVEL：列级权限', 'type' => 'string', 'required' => false, 'example' => 'ROW_LEVEL', ], ], [ 'name' => 'OperateType', 'in' => 'query', 'schema' => [ 'description' => '操作类型： '."\n" ."\n" .'- ADD：增加白名单'."\n" .'- DELETE：删除白名单', 'type' => 'string', 'required' => false, 'example' => 'ADD', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => '修改白名单对应的类型：'."\n" ."\n" .'- 1：用户 '."\n" .'- 2：用户组', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'TargetIds', 'in' => 'query', 'schema' => [ 'description' => '授权对象，同时支持多个授权对象，多个对象以英文逗号分隔。取值范围：'."\n" ."\n" .'- TargetType=1（用户）时，为用户ID。'."\n" .'- TargetType=2（用户组）时，为用户组ID。 ', 'type' => 'string', 'required' => false, 'example' => '43342***435,1553a****41231', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n true\\n true\\n","errorExample":""}]', 'title' => '增量修改行列权限白名单', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddDataLevelPermissionWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddDataSource' => [ 'summary' => '新增数据源连接信息。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AddModel', 'in' => 'query', 'schema' => [ 'description' => '可参考QuickBi数据源界面的新增数据源的逻辑，在点击【连接测试】时会触发restapi/datasource/detect接口，模拟该接口的传参负载，传入相同模型的json，外加一个在在bi中存在的userId和空间ID即可。'."\n" .'>有小部分数据源不支持，若参数和测试接口的传参负载相同，但依旧添加不成功，则表示当前数据源类型不支持通过该openapi创建>'."\n" .'>encode字段请不要传参，目前openapi创建数据源不支持加密模式，涉及上传文件类型的认证也不支持>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n" .' "userId": "235345xxxxx24336",'."\n" .' "workspaceId": "235345xxxxx24336",'."\n" .' "dsType": "postgresql",'."\n" .' "config": {'."\n" .' "category": "local",'."\n" .' "customDriverId": null,'."\n" .' "ssl": false,'."\n" .' "uploadFile": true,'."\n" .' "sslConfig": null'."\n" .' },'."\n" .' "showName": "test",'."\n" .' "address": "test",'."\n" .' "port": "5432",'."\n" .' "instance": "postgres",'."\n" .' "schema": "public",'."\n" .' "userName": "13****34",'."\n" .' "password": "12****425",'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1********DF8D885', ], 'Result' => [ 'description' => '数据源ID。', 'type' => 'string', 'example' => '472b241b-c651-****-****-ee719d6faf45', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not a member of the group workspace.', 'description' => '该用户不在群空间中。', ], [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '该空间不在组织内。', ], [ 'errorCode' => 'Name.RegularExpression.Error', 'errorMessage' => 'Name format validation failed.', 'description' => '名称格式验证失败。', ], [ 'errorCode' => 'NameExceeded.MaxLength.Error', 'errorMessage' => 'The name cannot exceed %s characters in length.', 'description' => '名称长度不能超过%s个字符。', ], [ 'errorCode' => 'Database.PortInvalid.Error', 'errorMessage' => 'The database port is invalid.', 'description' => '数据库端口无效。', ], [ 'errorCode' => 'Xengnie.TaskExecute.Error', 'errorMessage' => 'Fail to execute task %s.', 'description' => '任务执行失败 %s。', ], [ 'errorCode' => 'VpcInstance.Info.Error', 'errorMessage' => 'Get vpc instance info error.please check vpc config %s.', 'description' => '获取VPC实例信息错误。请检查VPC配置 %s。', ], [ 'errorCode' => 'VpcInstance.Info.EmptyError', 'errorMessage' => 'Not found instance. please check vpc config and authorization %s.', 'description' => '未找到实例。请检查VPC配置和权限 %s。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1********DF8D885\\",\\n \\"Result\\": \\"472b241b-c651-****-****-ee719d6faf45\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '新增数据源连接', 'requestParamsDescription' => '**以下是部分数据源添加的请求参数demo：**'."\n" .'- **adb** '."\n" .' ```json'."\n" .' {'."\n" .' "showName": "testadb3.0",'."\n" .' "address": "",'."\n" .' "port": 3306,'."\n" .' "dsType": "adb",'."\n" .' "username": "xxx",'."\n" .' "password": "xxx",'."\n" .' "schema": null,'."\n" .' "instance": "test",'."\n" .' "workspaceId": "xxx",'."\n" .' "userId": "xxx"'."\n" .' }'."\n" .'- **maxcompute**'."\n" .' ```json'."\n" .' { '."\n" .' "showName": "maxcompute", '."\n" .' "address": "http://service.xxx.xxx.com/api", '."\n" .' "dsType": "odps", '."\n" .' "username": "accessId", '."\n" .' "password": "accessKey", '."\n" .' "schema": "schema", '."\n" .' "project": "project name", '."\n" .' "config": {"category": "cloud", "customDriverId": null, "mcqa": true, "uploadFile": true}, '."\n" .' "workspaceId": "xxx", '."\n" .' "userId": "xxx" '."\n" .' }'."\n" .'- **hive**'."\n" .' ```json'."\n" .' {'."\n" .' "showName": "test", '."\n" .' "address": "192.168.0.1", '."\n" .' "port": "10000", '."\n" .' "dsType": "hive", '."\n" .' "instance": "hive", '."\n" .' "userName": "xxx", '."\n" .' "password": "xxx", '."\n" .' "config": { '."\n" .' "category": "local" '."\n" .' },'."\n" .' "workspaceId":"xxx", '."\n" .' "userId":"xxx" '."\n" .' }'."\n" .'- **gbase**'."\n" .' ```json'."\n" .' {'."\n" .' "showName": "test", '."\n" .' "address": "192.168.0.1", '."\n" .' "port": "5258", '."\n" .' "dsType": "gbase", '."\n" .' "instance": "quickbi_test", '."\n" .' "username": "root", '."\n" .' "password": "root", '."\n" .' "config": { '."\n" .' "category": "local" '."\n" .' }, '."\n" .' "workspaceId": "xxx", '."\n" .' "userId": "xxx" '."\n" .' } '."\n" .'- **rds-mysql**'."\n" .' ```json'."\n" .' {'."\n" .' "showName":"mysql", '."\n" .' "address":"", '."\n" .' "port": 3306, '."\n" .' "dsType":"mysql", '."\n" .' "username":"xxx", '."\n" .' "password":"xxx", '."\n" .' "schema": null, '."\n" .' "instance":"test", '."\n" .' "workspaceId":"xxx", '."\n" .' "userId":"xxx" '."\n" .' }'."\n" .'- **adb-mysql(vpc)**'."\n" .' ```json'."\n" .' {'."\n" .' "dsType": "adb",'."\n" .' "config": {'."\n" .' "category": "cloud",'."\n" .' "resource": "adb",'."\n" .' "uploadFile": true'."\n" .' },'."\n" .' "engineType": "adb",'."\n" .' "showName": "mysql",'."\n" .' "address": "amvxxxxxxxxxs.com",'."\n" .' "port": "3306",'."\n" .' "instance": "quxxxxxxxest",'."\n" .' "userName": "quixxxxxxxxxxxxst",'."\n" .' "password": "Taxxxxxxxx34",'."\n" .' "accessId": "LTAxxxxxxxxxxx453bo",'."\n" .' "accessKey": "Jy9xxxxxxxxxxxxZ96QqtBa",'."\n" .' "instanceId": "amxxxxxxxxxxxl0",'."\n" .' "region": "cn-hangzhou",'."\n" .' "userId": "ed3xxxxxxxxxxxxxx697b8664",'."\n" .' "workspaceId": "086xxxxxxxxxxxxxxxxxcd9a62236c"'."\n" .' }'."\n" .'- **hologres**'."\n" .' ```json'."\n" .' {'."\n" .' "showName": "Hologres", '."\n" .' "address": "hgprecn-cn-xxxxxx-cn-shanghai.hologres.aliyuncs.com", '."\n" .' "instance": "quickbi_test", '."\n" .' "schema": "publick", '."\n" .' "port": "80", '."\n" .' "dsType": "hologres", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "config": { '."\n" .' "initialSql": "Set timezone = \'-10\'" '."\n" .' }, '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "username": "LTAI4GDxxxxxLEpsdxkW9", '."\n" .' "password": "nVvUqwPUzxxxxxA3sCqockS7",'."\n" .' "workspaceId":"xxx", '."\n" .' "userId":"xxx" '."\n" .' }'."\n" .'- **impala-ldap**'."\n" .' ```json'."\n" .' { '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "dsType": "impala", '."\n" .' "config": { '."\n" .' "category": "local", '."\n" .' "resource": "ecs", '."\n" .' "ssl": false '."\n" .' }, '."\n" .' "showName": "impala-ldap", '."\n" .' "address": "xx.xx.xx.xx", '."\n" .' "port": "xxxx", '."\n" .' "instance": "default", '."\n" .' "dsVersion": "3.x", '."\n" .' "username": "xxxxx", '."\n" .' "password": "xxxxxxxxx", '."\n" .' "instanceId": "i-uf6fxxxxxbt3eh6lb", '."\n" .' "noSasl": true,'."\n" .' "workspaceId":"xxx", '."\n" .' "userId":"xxx" '."\n" .' }'."\n" .'- **impala**'."\n" .' ```json'."\n" .' {'."\n" .' "showName": "impala-test", '."\n" .' "address": "192.168.0.1", '."\n" .' "port": "21050", '."\n" .' "dsType": "impala", '."\n" .' "dsVersion": "3.x", '."\n" .' "instance": "test", '."\n" .' "userName": "xxx", '."\n" .' "password": "xxx", '."\n" .' "config": { '."\n" .' "category": "local", '."\n" .' "ssh" : { '."\n" .' "host": "192.168.0.2", '."\n" .' "username": "xxxx", '."\n" .' "password": "xxx", '."\n" .' "port": "22" '."\n" .' } '."\n" .' },'."\n" .' "workspaceId":"xxx", '."\n" .' "userId":"xxx" '."\n" .' }'."\n" .'- **dataphin-Dataphin_odps**'."\n" .' ```json'."\n" .' { '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "dsType": "dataphin_odps", '."\n" .' "address": "f6c64214dc27400xxxxxx-cn-shanghai.alicloudapi.com", '."\n" .' "username": "20xxx18", '."\n" .' "password": "33paqqexxxxg07qzj28", '."\n" .' "instance": "test_ds", '."\n" .' "showName": "1_1_dataphin_odps", '."\n" .' "config": { '."\n" .' "category": "application", '."\n" .' "engineType": "odps" '."\n" .' } '."\n" .' }'."\n" .'- **dataphin-Dataphin_hive**'."\n" .' ```json'."\n" .' { '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "dsType": "dataphin_hive", '."\n" .' "address": "f6c64214dc27400xxxxxx-cn-shanghai.alicloudapi.com", '."\n" .' "username": "20xxx18", '."\n" .' "password": "33paqqexxxxg07qzj28", '."\n" .' "instance": "test_ds", '."\n" .' "showName": "1_1_dataphin_odps", '."\n" .' "config": { '."\n" .' "category": "application", '."\n" .' "engineType": "hive" '."\n" .' } '."\n" .' }'."\n" .'- **DataPhin_JDBC_public**'."\n" .' ```json'."\n" .' { '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "dsType": "odps", '."\n" .' "config": { '."\n" .' "engineType": "hive", '."\n" .' "category": "application", '."\n" .' "dataphinConfig": { '."\n" .' "tenantId": "305xxx306", '."\n" .' "delegationUid": "@dataphin", '."\n" .' "accountType": "ACCOUNT_NAME", '."\n" .' "authMode": "DELEGATION" '."\n" .' }, '."\n" .' "resource": "clb", '."\n" .' "initialSql": "Set timezone = \'-10\'" '."\n" .' }, '."\n" .' "showName": "DataPhin_JDBC_public", '."\n" .' "connectType": "dataphin_v2", '."\n" .' "address": "47.xxx.xxx.124", '."\n" .' "port": "80", '."\n" .' "project": "bbb", '."\n" .' "instance": "fxxxk_test", '."\n" .' "username": "OIYtGZxxx7zmRpgQpB", '."\n" .' "password": "lDbQDnUuxxxxxGsxOd1", '."\n" .' "parentDsType": "dataphin", '."\n" .' "accessId": "[3eo[x>>", '."\n" .' "accessKey": "bHipbB>>", '."\n" .' "instanceId": "nnnn", '."\n" .' "region": "cn-qingdao" '."\n" .' }'."\n" .'- **Dataphin-jdbc-private**'."\n" .' ```json'."\n" .' { '."\n" .' "workspaceId": "87f73904-xxxx-xxxx-b1ee-5a3a03a8eb45", '."\n" .' "userId": "fec0741xxxxx061e6a951a2", '."\n" .' "dsType": "dataphin_v2", '."\n" .' "config": { '."\n" .' "engineType": "hive", '."\n" .' "category": "application", '."\n" .' "dataphinConfig": { '."\n" .' "tenantId": "30xxxx6", '."\n" .' "authMode": "SIMPLE" '."\n" .' }, '."\n" .' "resource": "clb", '."\n" .' "initialSql": "Set timezone = \'-10\'" '."\n" .' }, '."\n" .' "showName": "Dataphin-jdbc-private", '."\n" .' "connectType": "dataphin_v2", '."\n" .' "address": "47.xxx.x4x.124", '."\n" .' "port": "80", '."\n" .' "project": "bbb", '."\n" .' "instance": "fxxx_test", '."\n" .' "username": "kItowxxxxxxx2ZJr0", '."\n" .' "password": "kSlPkmS1xxxxxx61zd4SDX", '."\n" .' "parentDsType": "dataphin", '."\n" .' "accessId": "[3eo[x>>", '."\n" .' "accessKey": "bHipbB>>", '."\n" .' "instanceId": "nnnn", '."\n" .' "region": "cn-qingdao" '."\n" .' }'."\n" .'- **SQL Server(vpc)**'."\n" .' ```json'."\n" .' {'."\n" .' "dsType": "sqlserver",'."\n" .' "config": {'."\n" .' "category": "local",'."\n" .' "resource": "ecs",'."\n" .' "uploadFile": true'."\n" .' },'."\n" .' "showName": "sqlserver",'."\n" .' "address": "rm-bp11xxxxxxncs.com",'."\n" .' "port": "1433",'."\n" .' "instance": "quixxxxxest",'."\n" .' "schema": "dbo",'."\n" .' "userName": "quicxxxtest",'."\n" .' "password": "Taoxxxx34",'."\n" .' "accessId": "LTAI5xxxxxxxKLjjj",'."\n" .' "accessKey": "rOYdkxxxxxxxSeel1",'."\n" .' "instanceId": "rm-xxxxx502ndmq",'."\n" .' "region": "cn-huhehaote",'."\n" .' "userId": "ed33389xxxx6697b8664",'."\n" .' "workspaceId": "08634xxxx4cd9a62236c"'."\n" .' }', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'AddShareReport' => [ 'summary' => '添加数据作品的一个分享配置。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorksId', 'in' => 'query', 'schema' => [ 'description' => '分享作品的ID。这里的作品包括数据门户，仪表板，电子表格，自助取数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6b407e50-e774-406b-9956-da2425c2****', ], ], [ 'name' => 'ShareToId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '被分享者的ID，可能是Quick BI的用户ID，也可能是用户组ID。'."\n" ."\n" .'- ShareToType=0（用户）时，ShareTo为用户ID。'."\n" .'- ShareToType=1（用户组）时，ShareTo为用户组ID。'."\n" .'- ShareToType=2（组织）时，ShareTo为组织ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], [ 'name' => 'ShareToType', 'in' => 'query', 'schema' => [ 'description' => '分享类型。取值范围：'."\n" ."\n" .'- 0：用户'."\n" .'- 1：用户组'."\n" .'- 2：组织', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2', 'minimum' => '0', 'example' => '0', ], ], [ 'name' => 'ExpireDate', 'in' => 'query', 'schema' => [ 'description' => '分享的有效期限，格式为毫秒级时间戳 。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1608202110838', ], ], [ 'name' => 'AuthPoint', 'in' => 'query', 'schema' => [ 'description' => '授权类型。取值范围：'."\n" ."\n" .'- 1：仅查看'."\n" .'- 3：查看并导出', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '3', 'minimum' => '1', 'example' => '3', 'enum' => [ '1', '3', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '05739b8e-3de0-4204-9669-7f04f02522b9', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '作品不存在，可能已经被删除。作品ID:%s。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'Workspace.Share.Forbidden', 'errorMessage' => 'Content in the current group workspace cannot be shared.', 'description' => '当前群空间设置了禁止分享。', ], [ 'errorCode' => 'Workspace.OutsideShare.Forbidden', 'errorMessage' => 'Content in the current group workspace cannot be shared with another organization.', 'description' => '当前群空间设置了禁止组织外分享。', ], [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '用户组不存在。', ], [ 'errorCode' => 'UserGroup.NotIn.Organization', 'errorMessage' => 'The user group is not in the current organization.', 'description' => '用户组不在当前组织内。', ], [ 'errorCode' => 'Share.ExpireDate.Error', 'errorMessage' => 'The expire date is illegal.', 'description' => '设置的过期时间不合法。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05739b8e-3de0-4204-9669-7f04f02522b9\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 05739b8e-3de0-4204-9669-7f04f02522b9\\n true\\n true\\n","errorExample":""}]', 'title' => '添加数据作品分享配置', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-10-24T07:01:04.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddShareReport', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddShareReport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddUser' => [ 'summary' => '添加组织成员。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'AdminUser', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '是否赋予组织管理员角色。取值范围： '."\n" ."\n" .'- true：是 '."\n" .'- false：否'."\n" ."\n" .'参数已过期不推荐使用，当传入RoleIds 时该参数无效。', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'AuthAdminUser', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '是否赋予组织权限管理员角色。取值范围： '."\n" ."\n" .'- true：是 '."\n" .'- false：否'."\n" ."\n" .'参数已过期不推荐使用，当传入RoleIds 时该参数无效。', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'UserType', 'in' => 'query', 'schema' => [ 'description' => '组织成员的用户类型。取值范围：'."\n" .'- 1 ：开发者'."\n" .'- 2 ：访问者'."\n" .'- 3 ：分析师', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '1', 'example' => '1', 'enum' => [ '1', '2', '3', ], ], ], [ 'name' => 'AccountId', 'in' => 'query', 'schema' => [ 'description' => '阿里云账号ID。'."\n" .'>Quick BI于2024年12月31日之后发布的版本，AccountId将作为必填参数，请在此之前，对您的API进行改造。>', 'type' => 'string', 'deprecated' => false, 'required' => false, 'docRequired' => false, 'example' => '191476xxxxx23754', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '阿里云账号名称。'."\n" ."\n" .'- 说明：如果是子账号，格式为『主账号：子账号』。例如：master_test@aliyun.com:subaccount'."\n" .'- 格式检查：最大长度50个字符。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'xxxxxx@163.com', ], ], [ 'name' => 'NickName', 'in' => 'query', 'schema' => [ 'description' => '阿里云账号昵称。'."\n" ."\n" .'- 格式检查：最大长度50个字符。'."\n" .'- 特殊格式校验：中英文数字 _ \\ / | () ] \\[', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三', ], ], [ 'name' => 'RoleIds', 'in' => 'formData', 'schema' => [ 'description' => '用户绑定的预置或自定义组织角色ID，用英文逗号“,”分割，最多3个。取值范围：'."\n" .'- 组织管理员（预置角色）：111111111'."\n" .'- 权限管理员（预置角色）：111111112'."\n" .'- 普通用户（预置角色）：111111113', 'type' => 'string', 'required' => false, 'example' => '111111111,456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回新增阿里云用户的详细信息。', 'type' => 'object', 'properties' => [ 'AccountName' => [ 'description' => '阿里云账户。', 'type' => 'string', 'example' => 'xxxxxx@163.com', ], 'AdminUser' => [ 'description' => '是否绑定了组织管理员角色。取值范围：'."\n" ."\n" .'- true：是'."\n" .'- false：否'."\n" ."\n" .'参数已过期不推荐使用，当传入RoleIdList时该参数无效', 'type' => 'boolean', 'example' => 'true', ], 'AuthAdminUser' => [ 'description' => '是否绑定了权限管理员角色。取值范围：'."\n" ."\n" .'- true：是'."\n" .'- false：否'."\n" ."\n" .'参数已过期不推荐使用，当传入RoleIdList时该参数无效', 'type' => 'boolean', 'example' => 'true', ], 'NickName' => [ 'description' => '阿里云账号昵称。', 'type' => 'string', 'example' => '张三', ], 'RoleIdList' => [ 'description' => '用户绑定的组织角色ID列表。', 'type' => 'array', 'items' => [ 'description' => '组织角色ID，最多3个，包括但不限于组织预置角色：'."\n" ."\n" .'- 组织管理员（预置角色）：111111111'."\n" .'- 权限管理员（预置角色）：111111112'."\n" .'- 普通用户（预置角色）：111111113', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111', ], ], 'UserId' => [ 'description' => 'Quick BI中的UserID。', 'type' => 'string', 'example' => 'b5d8fd9348cc4327****afb604', ], 'UserType' => [ 'description' => '组织成员的用户类型。取值范围：'."\n" .'- 1 ：开发者'."\n" .'- 2 ：访问者'."\n" .'- 3 ：分析师', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Organization.Developers.ReachedTheUpperLimit', 'errorMessage' => 'The developers of the organization have reached the upper limit:%s', 'description' => '组织开发者已达到上限 %s 人，请升级联系组织管理员升级开发者数量。'."\n", ], [ 'errorCode' => 'Organization.Viewers.ReachedTheUpperLimit', 'errorMessage' => 'The visitors of the organization have reached the upper limit:%s.', 'description' => '组织访问者已达到上限%s人，请升级联系组织管理员升级访问者数量。', ], [ 'errorCode' => 'Organization.Analysts.ReachedTheUpperLimit', 'errorMessage' => 'The analysts of the organization have reached the upper limit:%s.', 'description' => '组织分析师已达到上限%s人，请升级联系组织管理员升级分析师数量。', ], [ 'errorCode' => 'NickName.AlreadyIn.Organization', 'errorMessage' => 'The alias already exists.', 'description' => '昵称已存在。', ], [ 'errorCode' => 'User.AlreadyIn.Organization', 'errorMessage' => 'This user is already a member of the current organization.', 'description' => '该用户已在当前组织中。', ], [ 'errorCode' => 'Instance.Over.MaxLicense', 'errorMessage' => 'You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.', 'description' => '', ], [ 'errorCode' => 'AnalystUser.NotSupport.AdminOrDevRole', 'errorMessage' => 'Analyst users do not support granting workspace administrator or developer roles.', 'description' => '分析师用户不支持授予工作空间管理员或开发者员角色。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'Workspace.Type.Error', 'errorMessage' => 'The type of group workspace is invalid.', 'description' => '无效的群空间类型。', ], [ 'errorCode' => 'Viewer.AddInTo.Workspace', 'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.', 'description' => '不允许将组织的访客类型用户添加到工作空间：%s。', ], [ 'errorCode' => 'User.AlreadyIn.Workspace', 'errorMessage' => 'This user already exists.', 'description' => '该用户已在群空间中。', ], [ 'errorCode' => 'User.AlreadyIn.Role', 'errorMessage' => 'The user is already assigned this role.', 'description' => '用户已经拥有该角色。', ], [ 'errorCode' => 'User.OrganizationRole.NotExist', 'errorMessage' => 'User %s must have role in organization.', 'description' => '用户 %s 在组织中必须有一个角色。', ], [ 'errorCode' => 'Viewer.CannotHave.CustomRole', 'errorMessage' => 'Organization viewer cannot have custom roles.', 'description' => '组织访问者不能具有自定义角色。', ], [ 'errorCode' => 'UserAnalyst.NotSupport.ThisRole', 'errorMessage' => 'This role has permissions that analysts cannot grant.', 'description' => '该角色具有分析员无法授予的权限。', ], [ 'errorCode' => 'RoleCount.ExceedsLimit.Error', 'errorMessage' => 'The user role cannot exceed three.', 'description' => '用户角色不能超过三个。', ], [ 'errorCode' => 'BindRole.NotExist.Error', 'errorMessage' => 'Bind role not exist, %s.', 'description' => '绑定的角色不存在，%s。', ], [ 'errorCode' => 'DirtyData.Duplicate.User', 'errorMessage' => 'Dirty data,duplicate user: %s.', 'description' => '脏数据，重复的用户：%s。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"AccountName\\": \\"xxxxxx@163.com\\",\\n \\"AdminUser\\": true,\\n \\"AuthAdminUser\\": true,\\n \\"NickName\\": \\"张三\\",\\n \\"RoleIdList\\": [\\n 111111111\\n ],\\n \\"UserId\\": \\"b5d8fd9348cc4327****afb604\\",\\n \\"UserType\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n \\n 1\\n b5d8fd9348cc4327****afb604\\n true\\n 张三\\n true\\n xxxxxx@163.com\\n \\n","errorExample":""}]', 'title' => '添加组织成员', 'changeSet' => [ [ 'createdAt' => '2025-03-18T08:50:40.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2025-03-14T06:35:33.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2024-11-27T06:07:36.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2024-11-26T11:47:12.000Z', 'description' => '错误码发生变更、请求参数发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-02-26T09:29:01.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', ], [ 'createdAt' => '2023-08-07T06:37:07.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUser', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddUserGroupMember' => [ 'summary' => '将组织成员添加到指定的用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'description' => '用户组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '555c4cd****', ], ], [ 'name' => 'UserIdList', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI的用户ID，可输入多个，以英文逗号（,）分隔，例如：abc,efg。最多可输入1000条。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '46e537a5****,3dadsu****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => 'B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3', ], 'Result' => [ 'description' => '返回添加用户组成员的结果。取值范围：'."\n" ."\n" .'- true：添加成功'."\n" ."\n" .'- false：添加失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" ."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.User', 'errorMessage' => 'The user does not exist and cannot be added to a user group.', 'description' => '用户不存在，无法将其添加到用户组。', ], [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '用户组不存在。', ], [ 'errorCode' => 'Parameter.Length.Exceed', 'errorMessage' => 'Parameter length exceeds maximum limit: [%s].', 'description' => '参数长度超过限制：%s。', ], [ 'errorCode' => 'UserGroup.Already.Synchronized', 'errorMessage' => 'Organization has synchronized with other organizational structures, so you are not allowed to add users under group.', 'description' => '该组织已经同步过其他组织架构，因此无法在根用户组下新增用户。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3\\n true\\n true\\n","errorExample":""}]', 'title' => '添加成员到用户组', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-09-18T02:06:59.000Z', 'description' => '响应参数发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserGroupMember', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddUserGroupMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddUserGroupMembers' => [ 'summary' => '将用户批量添加到指定的用户组中。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => ' Quick BI的用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '46e5****37a5', ], ], [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '用户组ID，以英文逗号分隔。示例：aGroupId,bGroupId,cGroupIds', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d5fb19b-****-****-99da-1248fc27ca51', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'title' => '接口执行结果。取值范围：true：请求成功false：请求失败', 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'title' => '是否请求成功。取值范围：true：请求成功false：请求失败', 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.User', 'errorMessage' => 'The user does not exist and cannot be added to a user group.', 'description' => '用户不存在，无法将其添加到用户组。', ], [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '用户组不存在。', ], [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The length of the parameter must not exceed 1000.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Already.Synchronized', 'errorMessage' => 'Organization has synchronized with other organizational structures, so you are not allowed to add users under group.', 'description' => '该组织已经同步过其他组织架构，因此无法在根用户组下新增用户。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n true\\n true\\n","errorExample":""}]', 'title' => '批量添加成员到用户组', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-09-18T02:06:59.000Z', 'description' => '响应参数发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserGroupMembers', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddUserGroupMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddUserTagMeta' => [ 'summary' => '新增组织成员标签元信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'TagName', 'in' => 'query', 'schema' => [ 'description' => '标签名称。格式检查：'."\n" .'- 最大长度50个字符。'."\n" .'- 只允许输入中英文数字和/\\|[]()符号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '职位', ], ], [ 'name' => 'TagDescription', 'in' => 'query', 'schema' => [ 'description' => '标签描述。格式检查：最大长度255个字符。', 'type' => 'string', 'required' => false, 'example' => '部门内的职位', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回添加成功的标签ID。', 'type' => 'string', 'example' => '0822a7d9-****-****-****-f20163ab9b0d', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'TagName.Repeat', 'errorMessage' => 'The tag name is duplicated.', 'description' => '标签名称重复。', ], [ 'errorCode' => 'Name.Length.Exceeded', 'errorMessage' => 'The max length of name exceeded.', 'description' => '名称长度超限。', ], [ 'errorCode' => 'Name.RegularExpression.Error', 'errorMessage' => 'Name format validation failed.', 'description' => '名称格式验证失败。', ], [ 'errorCode' => 'NameExceeded.MaxLength.Error', 'errorMessage' => 'The name cannot exceed %s characters in length.', 'description' => '名称长度不能超过%s个字符。', ], [ 'errorCode' => 'UserTag.Exceed.Limit', 'errorMessage' => 'The number of user tags cannot exceed %s, you have reached the upper limit.', 'description' => '用户标签数量不能超过%s个，您已达到上限。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": \\"0822a7d9-****-****-****-f20163ab9b0d\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n 0822a7d9-****-****-****-f20163ab9b0d\\n true\\n","errorExample":""}]', 'title' => '新增组织成员标签元信息', 'changeSet' => [ [ 'createdAt' => '2025-05-28T03:27:58.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2025-03-14T06:35:33.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserTagMeta', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddUserTagMeta', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddUserToWorkspace' => [ 'summary' => '添加成员到指定工作空间。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '被添加的Quick BI用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => [ 'description' => '空间角色ID。预置角色：'."\n" .'- 25：空间管理员'."\n" .'- 26：空间开发者'."\n" .'- 27：空间分析师'."\n" .'- 30：空间查看者'."\n" ."\n" .'> since 6.0.3支持自定义角色ID'."\n" .'>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '25', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'User.RoleType.Valid', 'errorMessage' => 'The role ID is invalid.', 'description' => '无效的角色ID。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'Workspace.Type.Error', 'errorMessage' => 'The type of group workspace is invalid.', 'description' => '无效的群空间类型。', ], [ 'errorCode' => 'Viewer.AddInTo.Workspace', 'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.', 'description' => '不允许将组织的访客类型用户添加到工作空间：%s。', ], [ 'errorCode' => 'User.AlreadyIn.Workspace', 'errorMessage' => 'This user already exists.', 'description' => '该用户已在群空间中。', ], [ 'errorCode' => 'User.AlreadyIn.Role', 'errorMessage' => 'The user is already assigned this role.', 'description' => '用户已经拥有该角色。', ], [ 'errorCode' => 'AnalystUser.NotSupport.AdminOrDevRole', 'errorMessage' => 'Analyst users do not support granting workspace administrator or developer roles.', 'description' => '分析师用户不支持授予工作空间管理员或开发者员角色。', ], [ 'errorCode' => 'UserAnalyst.NotSupport.ThisRole', 'errorMessage' => 'This role has permissions that analysts cannot grant.', 'description' => '该角色具有分析员无法授予的权限。', ], [ 'errorCode' => 'Viewer.CannotHave.CustomRole', 'errorMessage' => 'Organization viewer cannot have custom roles.', 'description' => '组织访问者不能具有自定义角色。', ], [ 'errorCode' => 'BindRole.NotExist.Error', 'errorMessage' => 'Bind role not exist, %s.', 'description' => '绑定的角色不存在，%s。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n true\\n true\\n","errorExample":""}]', 'title' => '添加成员到工作空间', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-08-07T06:37:07.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserToWorkspace', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddUserToWorkspace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AddWorkspaceUsers' => [ 'summary' => '批量添加成员到工作空间。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'UserIds', 'in' => 'query', 'schema' => [ 'description' => '用户ID。此处为Quick BI的UserID，而非阿里云的UID。'."\n" ."\n" .'- 支持批量传参，用户ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => [ 'description' => '预置空间角色ID。取值范围：'."\n" .'- 25：空间管理员'."\n" .'- 26：空间开发者'."\n" .'- 27：空间分析师'."\n" .'- 30：空间查看者', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '30', 'minimum' => '25', 'example' => '25', 'enum' => [ '25', '26', '27', '30', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功，存在添加部分成员成功，部分失败的情况，添加失败的原因参考返回结果中的FailureDetail'."\n" .'- false：请求失败，不会持久化任何数据', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7AAB95D7-2E11-4FE2-94BC-858E4FC0C976', ], 'Result' => [ 'description' => '返回接口执行结果。', 'type' => 'object', 'properties' => [ 'Failure' => [ 'description' => '添加失败的用户数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'FailureDetail' => [ 'description' => '添加失败的原因。', 'type' => 'object', 'example' => '{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}', ], 'Success' => [ 'description' => '添加成功的用户数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Total' => [ 'description' => '添加用户的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'User.RoleType.Valid', 'errorMessage' => 'The role ID is invalid.', 'description' => '', ], [ 'errorCode' => 'Viewer.CannotHave.CustomRole', 'errorMessage' => 'Organization viewer cannot have custom roles.', 'description' => '', ], [ 'errorCode' => 'UserAnalyst.NotSupport.ThisRole', 'errorMessage' => 'This role has permissions that analysts cannot grant.', 'description' => '', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '', ], [ 'errorCode' => 'ApiUser.Not.Exists', 'errorMessage' => 'The specified user does not exist.', 'description' => '', ], [ 'errorCode' => 'Viewer.AddInTo.Workspace', 'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.', 'description' => '', ], [ 'errorCode' => 'User.AlreadyIn.Workspace', 'errorMessage' => 'This user already exists.', 'description' => '', ], [ 'errorCode' => 'User.AlreadyIn.Role', 'errorMessage' => 'The user is already assigned this role.', 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7AAB95D7-2E11-4FE2-94BC-858E4FC0C976\\",\\n \\"Result\\": {\\n \\"Failure\\": 2,\\n \\"FailureDetail\\": {\\n \\"2046274934845893\\": \\"AE0150010001: This user already exists.\\",\\n \\"1213444447906552\\": \\"AE0150010001: This user already exists.\\"\\n },\\n \\"Success\\": 1,\\n \\"Total\\": 3\\n }\\n}","type":"json"}]', 'title' => '批量添加成员到工作空间', 'changeSet' => [ [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-08-07T06:37:07.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AddWorkspaceUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AllotDatasetAccelerationTask' => [ 'summary' => '触发数据集Quick引擎的采集加速。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'title' => '数据集ID。', 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-****-3c744528014b', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'title' => '是否执行成功。', 'description' => '返回结果：'."\n" .'- true：任务触发成功'."\n" .'- false：任务触发失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Quick.Job.NotExist', 'errorMessage' => 'The acceleration job is not found,please check the acceleration configuration.', 'description' => '', ], [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'Last.Job.Failed', 'errorMessage' => 'Last job status is warn or failure, please check.', 'description' => '', ], [ 'errorCode' => 'Repeat.Running.Job', 'errorMessage' => 'Job is already in progress.', 'description' => '', ], [ 'errorCode' => 'User.OperationPermission.Error', 'errorMessage' => 'You are not authorized to operate this object.', 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '触发数据集抽取加速', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-02-26T09:29:01.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:AllotDatasetAccelerationTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'AuthorizeMenu' => [ 'summary' => '数据门户菜单的批量授权，已经授权的会自动略过。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataPortalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d173abb53e84c8ca7495429163b****', ], ], [ 'name' => 'MenuIds', 'in' => 'query', 'schema' => [ 'description' => '数据门户的叶子节点菜单ID。'."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为100', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54kqgoa****,pg1n135****', ], ], [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '用户组ID列表。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为200'."\n" .'- UserGroupIds和UserIds不能同时为空', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****', ], ], [ 'name' => 'UserIds', 'in' => 'query', 'schema' => [ 'description' => '用户ID列表。此处为Quick BI的UserID，而非阿里云的UID。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为200', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '204627493484****,121344444790****', ], ], [ 'name' => 'AuthPointsValue', 'in' => 'query', 'schema' => [ 'description' => '授权菜单的权限。取值范围：'."\n" ."\n" .'- 1：查看'."\n" .'- 3：查看+导出（默认）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '188F0B12-00EF-41B3-944A-FB7EF06C9F43', ], 'Result' => [ 'description' => '授权成功的菜单数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'AccessMenu.NotMatch.Portal', 'errorMessage' => 'The menu does not match the BI portal.', 'description' => '', ], [ 'errorCode' => 'FolderMenu.CanNot.Authorize', 'errorMessage' => 'The folder type menu cannot be authorized. Menu ID: %s.', 'description' => '', ], [ 'errorCode' => 'Menu.NotBelongTo.CurrentDataportal', 'errorMessage' => 'Menu %s does not belong to the current data portal %s.', 'description' => '', ], [ 'errorCode' => 'User.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The user %s does not belong to the current organization.', 'description' => '', ], [ 'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The usergroup %s does not belong to the current organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"188F0B12-00EF-41B3-944A-FB7EF06C9F43\\",\\n \\"Result\\": 2,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 188F0B12-00EF-41B3-944A-FB7EF06C9F43\\n 2\\n true\\n","errorExample":""}]', 'title' => '数据门户菜单批量授权', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:AuthorizeMenu', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'BatchAddFeishuUsers' => [ 'summary' => '批量添加飞书用户。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'IsAuthAdmin', 'in' => 'query', 'schema' => [ 'description' => '是否是权限管理员'."\n" ."\n" .'- true'."\n" .'- false'."\n" ."\n" .'不填写默认为false', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'IsAdmin', 'in' => 'query', 'schema' => [ 'description' => '是否为admin用户：'."\n" .'- true'."\n" .'- false'."\n" ."\n" .'不填写默认为false', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'False', ], ], [ 'name' => 'FeishuUsers', 'in' => 'query', 'schema' => [ 'description' => '要添加的用户信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"ad****fd": "张三", "82****5a": "李四"}"', ], ], [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '所属用户组', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"', ], ], [ 'name' => 'UserType', 'in' => 'query', 'schema' => [ 'description' => '用户类型'."\n" .'- 开发者类型：1'."\n" .'- 访问者类型：2'."\n" .'- 分析师：3 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '返回添加用户组成员的结果。取值范围：'."\n" ."\n" .'- true：添加成功'."\n" ."\n" .'- false：添加失败', 'type' => 'object', 'properties' => [ 'FailCount' => [ 'description' => '失败校验的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'FailResults' => [ 'description' => '失败的具体详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FailInfos' => [ 'description' => '错误原因。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '错误码。', 'type' => 'string', 'example' => 'ACCOUNT_EXIST', ], 'CodeDesc' => [ 'description' => '错误码描述。', 'type' => 'string', 'example' => '账号已存在', ], 'Input' => [ 'description' => '错误的输入值。', 'type' => 'string', 'example' => '20', ], ], ], ], ], ], ], 'OkCount' => [ 'description' => '成功计数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'example' => 'True', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'True', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Feishhu.Config.Not.Exit', 'errorMessage' => 'Feishu is not configured in the current organization', 'description' => '', ], [ 'errorCode' => 'Feishu.User.Need.Sync.Contact', 'errorMessage' => 'Feishu need to sync contact list.', 'description' => '', ], [ 'errorCode' => 'Feishu.Parameter.Error', 'errorMessage' => 'Feishu config error: %s.', 'description' => '', ], [ 'errorCode' => 'Mail.Invalid', 'errorMessage' => 'Email/phone number is invalid.', 'description' => '', ], [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '', ], [ 'errorCode' => 'Instance.Over.MaxLicense', 'errorMessage' => 'You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.', 'description' => '', ], [ 'errorCode' => 'Feishu.User.Duplicated', 'errorMessage' => 'Feishu account already exists or bound：%s.', 'description' => '', ], [ 'errorCode' => 'Viewer.CannotHave.CustomRole', 'errorMessage' => 'Organization viewer cannot have custom roles.', 'description' => '', ], [ 'errorCode' => 'UserAnalyst.NotSupport.ThisRole', 'errorMessage' => 'This role has permissions that analysts cannot grant.', 'description' => '', ], [ 'errorCode' => 'User.OrganizationRole.NotExist', 'errorMessage' => 'User %s must have role in organization.', 'description' => '', ], [ 'errorCode' => 'FeishuUser.UserGroup.AssociationError', 'errorMessage' => 'Feishu User can only be added into feishu or Bi user group.', 'description' => '', ], ], ], 'staticInfo' => [ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": {\\n \\"FailCount\\": 10,\\n \\"FailResults\\": [\\n {\\n \\"FailInfos\\": [\\n {\\n \\"Code\\": \\"ACCOUNT_EXIST\\",\\n \\"CodeDesc\\": \\"账号已存在\\",\\n \\"Input\\": \\"20\\"\\n }\\n ]\\n }\\n ],\\n \\"OkCount\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '批量添加飞书用户', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:BatchAddFeishuUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CancelAuthorizationMenu' => [ 'summary' => '根据门户菜单ID，取消指定用户、用户组的授权记录。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataPortalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d173abb53e84c8ca7495429163b****', ], ], [ 'name' => 'MenuIds', 'in' => 'query', 'schema' => [ 'description' => '数据门户的叶子节点菜单ID。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为100', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54kqgoa****,pg1n135****', ], ], [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '用户组ID列表。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为200'."\n" .'- UserGroupIds和UserIds不能同时为空', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****', ], ], [ 'name' => 'UserIds', 'in' => 'query', 'schema' => [ 'description' => '用户ID列表。此处为Quick BI的UserID，而非阿里云的UID。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为200', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '204627493484****,121344444790****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '取消授权成功的菜单数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '作品不存在，可能已经被删除。作品ID:%s。', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'AccessMenu.NotMatch.Portal', 'errorMessage' => 'The menu does not match the BI portal.', 'description' => '菜单与门户网站不匹配。', ], [ 'errorCode' => 'FolderMenu.CanNot.Authorize', 'errorMessage' => 'The folder type menu cannot be authorized. Menu ID: %s.', 'description' => '文件夹类型菜单无法进行授权操作，menuId为%s。', ], [ 'errorCode' => 'Menu.NotBelongTo.CurrentDataportal', 'errorMessage' => 'Menu %s does not belong to the current data portal %s.', 'description' => '菜单%s不属于当前数据门户%s。', ], [ 'errorCode' => 'User.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The user %s does not belong to the current organization.', 'description' => '用户%s不属于当前组织。', ], [ 'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The usergroup %s does not belong to the current organization.', 'description' => '用户组%s不属于当前组织。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": 2,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n 2\\n true\\n","errorExample":""}]', 'title' => '批量取消数据门户菜单授权', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAuthorizationMenu', ], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:CancelAuthorizationMenu', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CancelCollection' => [ 'summary' => '取消用户收藏的数据作品。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorksId', 'in' => 'query', 'schema' => [ 'description' => '取消收藏的作品ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5d6ae4e7-cede-43cd-b4d3-d2fd442a9202', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '收藏用户的ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '121344444790****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7c7223ae-****-3c744528014b', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'Favorite.NotCancel.Permission', 'errorMessage' => 'You have not added this work to favorites.', 'description' => '', ], [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7c7223ae-****-3c744528014b\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 7c7223ae-****-3c744528014b\\n true\\n true\\n","errorExample":""}]', 'title' => '取消作品收藏', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:CancelCollection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CancelReportShare' => [ 'summary' => '删除数据作品的一个分享授权。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => '作品的ID。这里的作品包括数据门户，仪表板，电子表格，自助取数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6b407e50-e774-406b-9956-da2425c2****', ], ], [ 'name' => 'ShareToIds', 'in' => 'query', 'schema' => [ 'description' => '被分享者的ID，可能是Quick BI的用户ID，也可能是用户组ID。'."\n" ."\n" .'- ShareToType=0（用户）时，ShareTo为用户ID。'."\n" .'- ShareToType=1（用户组）时，ShareTo为用户组ID。'."\n" .'- ShareToType=2（组织）时，ShareTo为组织ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], [ 'name' => 'ShareToType', 'in' => 'query', 'schema' => [ 'description' => '删除方式。取值范围：'."\n" ."\n" .'- 0：按用户删除'."\n" .'- 1：按用户组删除'."\n" .'- 2：按组织删除', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '', ], [ 'errorCode' => 'Resource.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The resource does not belong to the current organization.', 'description' => '', ], [ 'errorCode' => 'User.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The user %s does not belong to the current organization.', 'description' => '', ], [ 'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The usergroup %s does not belong to the current organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\n true\\n true\\n","errorExample":""}]', 'title' => '删除数据作品的分享授权', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:CancelReportShare', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ChangeVisibilityModel' => [ 'summary' => '修改数据门户菜单的可见方式，是否仅授权可见。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataPortalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d173abb53e84c8ca7495429163b****', ], ], [ 'name' => 'MenuIds', 'in' => 'query', 'schema' => [ 'description' => '数据门户的叶子节点菜单ID。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开，批量修改的最大数为100', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54kqgoa****,pg1n135****', ], ], [ 'name' => 'ShowOnlyWithAccess', 'in' => 'query', 'schema' => [ 'description' => '是否仅授权可见。取值范围：'."\n" ."\n" .'- true：仅授权可见'."\n" .'- false：都可见', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '修改成功的菜单数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '', ], [ 'errorCode' => 'AccessMenu.NotMatch.Portal', 'errorMessage' => 'The menu does not match the BI portal.', 'description' => '', ], [ 'errorCode' => 'FolderMenu.CanNot.Authorize', 'errorMessage' => 'The folder type menu cannot be authorized. Menu ID: %s.', 'description' => '', ], [ 'errorCode' => 'Menu.NotBelongTo.CurrentDataportal', 'errorMessage' => 'Menu %s does not belong to the current data portal %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": 2,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n 2\\n true\\n","errorExample":""}]', 'title' => '修改数据门户菜单的可见方式', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-04-06T10:12:47.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:ChangeVisibilityModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CheckDatasetExisted' => [ 'summary' => '检查给定的cubeId是否存在。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-****-3c744528014b', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'C67ABB*********682B0B214', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C67ABB*********682B0B214\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '检查给定的cubeId是否存在', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CheckOrganizationMember' => [ 'summary' => '判断用户是否属于组织。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 [QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=api-workbench.api_explorer.0.0.672f50daGq9ooV¶ms=%7B%7D&tab=DOC&sdkStyle=old&RegionId=cn-hangzhou) 接口，获取 UserId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'adfssd-sdf****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A**********DF8D885', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A**********DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '判断用户是否属于组织', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CheckReadable' => [ 'summary' => '查询用户对数据作品（仪表板、电子表格等）是否有权限查看。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorksId', 'in' => 'query', 'schema' => [ 'description' => '作品的ID。这里的资源包括数据门户，仪表板，电子表格，自助取数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '待检测的Quick BI用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n true\\n true\\n","errorExample":""}]', 'title' => '查询用户对数据作品的查看权限', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:CheckReadable', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CreateCubeBySql' => [ 'summary' => '根据自定义sql创建数据集。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CustomSql', 'in' => 'query', 'schema' => [ 'description' => '自定义sql语句。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'select * from qqq', ], ], [ 'name' => 'Caption', 'in' => 'query', 'schema' => [ 'description' => '自定义数据集名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'DsId', 'in' => 'query', 'schema' => [ 'description' => '数据源ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7AAB95D-*****-****-*4FC0C976', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '需要传入一个有权限创建数据集的Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 [QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=api-workbench.api_explorer.0.0.672f50daGq9ooV¶ms=%7B%7D&tab=DOC&sdkStyle=old&RegionId=cn-hangzhou) 接口，获取 UserId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'asdaf-asda*****asd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '05739b************02522b9', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'string', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.User.Organization', 'errorMessage' => 'The user is not in your organization.', 'description' => '该用户不在您的组织中。', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not in this workspace.', 'description' => '该用户不在此空间中。', ], [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '该空间不在组织内。', ], [ 'errorCode' => 'Datasource.NotFound.Error', 'errorMessage' => 'The specified data source does not exist: %s.', 'description' => '数据源不存在：%s。', ], [ 'errorCode' => 'DatasourceId.IsNull.Error', 'errorMessage' => 'You must select a data source before selecting the table.', 'description' => '必须选择数据源之后再选择表。', ], [ 'errorCode' => 'Name.RegularExpression.Error', 'errorMessage' => 'Name format validation failed.', 'description' => '名称格式验证失败。', ], [ 'errorCode' => 'NameExceeded.MaxLength.Error', 'errorMessage' => 'The name cannot exceed %s characters in length.', 'description' => '名称长度不能超过%s个字符。', ], [ 'errorCode' => 'Cube.DuplicatedName.Error', 'errorMessage' => 'The dataset name already exists. Modify the name before saving.', 'description' => '数据集名称已存在，请修改名称后再保存。', ], [ 'errorCode' => 'Directory.NotExist.Error', 'errorMessage' => 'The directory does not exist.', 'description' => '文件夹不存在。', ], [ 'errorCode' => 'Xengnie.TaskExecute.Error', 'errorMessage' => 'Fail to execute task %s.', 'description' => '任务执行失败 %s。', ], [ 'errorCode' => 'Datasource.Sql.ExecuteFailed', 'errorMessage' => 'Failed to execute the SQL statement in the data source.', 'description' => '数据源执行SQL失败。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05739b************02522b9\\",\\n \\"Result\\": \\"true\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '根据自定义sql创建数据集', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateDataset' => [ 'summary' => '根据物理表名称创建数据集。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DsId', 'in' => 'query', 'schema' => [ 'description' => '数据源ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7AAB95D-*****-****-*4FC0C976', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => '表名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'st_trd_user_purchase_day_inc', ], ], [ 'name' => 'UserDefineCubeName', 'in' => 'query', 'schema' => [ 'description' => '数据集名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '726bee5a-****-43e1-9a8e-b550f0120f35', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '需要传入一个有权限创建数据集的Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 [QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=api-workbench.api_explorer.0.0.672f50daGq9ooV¶ms=%7B%7D&tab=DOC&sdkStyle=old&RegionId=cn-hangzhou) 接口，获取 UserId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '726bee5a-****-43e1-9a8e-b550f0120f35', ], ], [ 'name' => 'TargetDirectoryId', 'in' => 'query', 'schema' => [ 'description' => '指定目录文件夹ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'asah-fsdfsf*****92342', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => 'F68B***********A3DF743', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'string', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '数据集不存在。', ], [ 'errorCode' => 'Invalid.User.Organization', 'errorMessage' => 'The user is not in your organization.', 'description' => '该用户不在您的组织中。', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'Datasource.NotFound.Error', 'errorMessage' => 'The specified data source does not exist: %s.', 'description' => '数据源不存在：%s。', ], [ 'errorCode' => 'DatasourceId.IsNull.Error', 'errorMessage' => 'You must select a data source before selecting the table.', 'description' => '必须选择数据源之后再选择表。', ], [ 'errorCode' => 'Name.RegularExpression.Error', 'errorMessage' => 'Name format validation failed.', 'description' => '名称格式验证失败。', ], [ 'errorCode' => 'NameExceeded.MaxLength.Error', 'errorMessage' => 'The name cannot exceed %s characters in length.', 'description' => '名称长度不能超过%s个字符。', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not a member of the group workspace.', 'description' => '该用户不在群空间中。', ], [ 'errorCode' => 'Cube.DuplicatedName.Error', 'errorMessage' => 'The dataset name already exists. Modify the name before saving.', 'description' => '数据集名称已存在，请修改名称后再保存。', ], [ 'errorCode' => 'Directory.NotExist.Error', 'errorMessage' => 'The directory does not exist.', 'description' => '文件夹不存在。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F68B***********A3DF743\\",\\n \\"Result\\": \\"true\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '根据物理表名称创建数据集', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateTicket' => [ 'summary' => '生成报表嵌入需要使用的ticket。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorksId', 'in' => 'query', 'schema' => [ 'description' => '开通嵌入的报表ID，目前支持仪表板、电子表格、数据大屏、自助取数、即席分析和数据填报。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a206f5f3-****-e9b17c835b03', ], ], [ 'name' => 'CmptId', 'in' => 'query', 'schema' => [ 'description' => '组件ID。为以上仪表板中某个组件的ID，其他作品类型不支持。'."\n" .'获取组件ID调用的接口请参见[QueryWorksBloodRelationship](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryWorksBloodRelationship?spm=a2c4g.11186623.0.0.15615d7aWVvWAl¶ms={}&lang=JAVA&tab=DOC&sdkStyle=old)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0fc6a275c7f64f17b1****a306ce0f31', ], ], [ 'name' => 'TicketNum', 'in' => 'query', 'schema' => [ 'description' => 'Ticket的票据数量，每次使用票据访问后，Ticket的票据数量减1。'."\n" .'- 默认值为1。'."\n" .'- 建议值为1。'."\n" .'- 最大值为99999。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI的UserId，非您的阿里云账号ID。'."\n" .'您可以调用[QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=a2c4g.11186623.0.0.15615d7aWVvWAl¶ms={}&tab=DOC&sdkStyle=old)接口，获取UserId。UserId样例为fe67f61a35a94b7da1a34ba174a7****。'."\n" ."\n" .'> UserId和AccountName只填一个即可，不填时默认绑定报表的Owner，访问报表时将以该用户身份访问。若您需要配置数据行级权限，请参见[行级权限](~~322783~~)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '46e537466****92704c8', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '用户的账号名称。'."\n" ."\n" .'- 如果用户是阿里云主账号**wangwu**，格式为**[主账号]**，例如**wangwu**。'."\n" .'- 如果用户是RAM账号**zhangsan**@aliyun.cn**，格式为**[主账号：子账号]**，例如**wangwu:zhangsan****。'."\n" ."\n" .'> UserId和AccountName只填一个即可，不填时默认绑定报表的Owner，访问报表时将以该用户身份访问。若您需要配置数据行级权限，请参见[行级权限](~~322783~~)。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'test', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '用户的账号类型。'."\n" .'- 1：阿里云账号'."\n" .'- 3：Quick BI自建账号'."\n" .'- 4：钉钉'."\n" .'- 5：RAM子账号'."\n" .'- 9：企业微信'."\n" .'- 10：飞书'."\n" .'> 若AccountName不为空时，则AccountType也不能为空。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => '过期时间'."\n" .'- 单位：分钟'."\n" .'- 默认：240', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '200', ], ], [ 'name' => 'WatermarkParam', 'in' => 'query', 'schema' => [ 'description' => '报表的水印参数。'."\n" .'- 不得超过50个字符。'."\n" .'- 当报表类型为大屏时，不支持水印传参。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ticket embed', ], ], [ 'name' => 'GlobalParam', 'in' => 'query', 'schema' => [ 'description' => '报表过滤条件的全局参数。'."\n" .'- JsonArray格式的字符串。'."\n" ."\n" .'> 若您需要使用全局参数能力，请联系[Quick BI运营负责人](https://h5-alimebot.dingtalk.com/intl/index.htm?spm=a2c4g.11186623.0.0.3da14f6chrDv9e&sourceType=ding_talk&from=DEFFB9G5KBByQkwq23wneFIOmaJ)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '生成ticket的值。', 'type' => 'string', 'example' => 'ccd3428c-****-****-a608-26bae29dffee', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch', 'errorMessage' => 'The report bound by the ticket mismatches the actual report.', 'description' => 'Ticket绑定的报表与访问页面报表不一致。', ], [ 'errorCode' => 'Authorize3rdTicket.Expired', 'errorMessage' => 'Ticket [%s] has expired.', 'description' => '当前票据[%s]已过期。', ], [ 'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken', 'errorMessage' => 'The request [%s] has no token.', 'description' => '当前请求 [%s] 未找到token信息。', ], [ 'errorCode' => 'Authorize3rdTicket.NotExist', 'errorMessage' => 'Ticket %s does not exist.', 'description' => '当前票据%s不存在。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.Exceed', 'errorMessage' => 'The number of tickets %s is invalid.', 'description' => '票据数量不合法。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.HasNoLeft', 'errorMessage' => 'There is no ticket number left, please generate new ticket.', 'description' => '当前票据已消费完毕，请重新生成。', ], [ 'errorCode' => 'Report.NotExist.Error', 'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.', 'description' => '作品不存在，可能已经被删除。作品ID:%s。', ], [ 'errorCode' => 'Authorize3Rd.Report.Unauthorized', 'errorMessage' => 'The report is not enabled for third party embedding.', 'description' => '报表未开通三方嵌入，请开通后重试。', ], [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '数据集不存在。', ], [ 'errorCode' => 'Datasource.NotFound.Error', 'errorMessage' => 'The specified data source does not exist: %s.', 'description' => '数据源不存在：%s。', ], [ 'errorCode' => 'Report.NotExist', 'errorMessage' => 'The dashboard does not exist.', 'description' => '当前仪表板不存在。', ], [ 'errorCode' => 'Organization.Workspace.Inconformity', 'errorMessage' => 'The workspace does not match the organization.', 'description' => '工作空间与组织不一致。', ], [ 'errorCode' => 'Parameter.Length.Exceed', 'errorMessage' => 'Parameter length exceeds maximum limit: [%s].', 'description' => '参数长度超过限制：%s。', ], [ 'errorCode' => 'GlobalParam.Restricted.Use', 'errorMessage' => 'The global parameter function is restricted in your version.', 'description' => '当前版本不可用全局参数', ], [ 'errorCode' => 'Authorize3rdTicket.Unsupport.ScreenWatermark', 'errorMessage' => 'Screen embed does not support watermark parameters.', 'description' => '大屏嵌入不支持水印参数。', ], [ 'errorCode' => 'NoPermissionTo.Operate.Object', 'errorMessage' => 'You are not authorized to operate the objects.', 'description' => '您无权操作这些对象。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": \\"ccd3428c-****-****-a608-26bae29dffee\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n ccd3428c-****-****-a608-26bae29dffee\\n true\\n","errorExample":""}]', 'title' => '生成报表嵌入ticket', 'description' => '具体使用方法详见[报表嵌入数据权限控制和传参的安全增强方案](~~391291~~)。', 'changeSet' => [ [ 'createdAt' => '2025-03-17T08:55:41.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-10-24T07:01:04.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:CreateTicket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CreateTicket4Copilot' => [ 'summary' => '用于生成智能小Q嵌入Ticket。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CopilotId', 'in' => 'query', 'schema' => [ 'description' => '开通嵌入的智能小Q 模块 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccd3428c-dd23-460c-a608-26bae29dffee', ], ], [ 'name' => 'TicketNum', 'in' => 'query', 'schema' => [ 'description' => 'ticket的票据数量取值范围：'."\n" ."\n" .'- 默认值为1。'."\n" ."\n" .'- 建议值为1。'."\n" ."\n" .'- 最大值为99999。'."\n" ."\n" .'每次使用票据访问后，Ticket的票据数量减1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI的UserId。'."\n" ."\n" .'- 您可以调用【3.1.7 根据三方账号获取用户具体信息】或者其他接口获取。'."\n" ."\n" .'注意：userId和accountName只填一个即可，不填时默认绑定报表的owner，访问报表时将以该用户身份访问。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9c-asdawf-casxcasd-asdasd', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '用户的账号名称。'."\n" .'注意：userId和accountName只填一个即可，不填时默认绑定报表的owner，访问报表时将以该用户身份访问。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试用户', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '用户的账号类型:'."\n" ."\n" .'- 1：阿里云主账号'."\n" ."\n" .'- 3：QuickBI 自建账号。'."\n" ."\n" .'- 4：钉钉'."\n" ."\n" .'- 5：阿里云RAM账号'."\n" ."\n" .'- 6：三方账号（SAML、OAuth等协议对对接的账号）'."\n" ."\n" .'- 9：企业微信'."\n" ."\n" .'- 10：飞书'."\n" ."\n" .'注意：accountName不为空，则accountType不能为空。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [], 'example' => '1', ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => '过期时间。'."\n" ."\n" .'- 单位分钟，最大240（4小时）。'."\n" ."\n" .'- 默认240。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '200', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '开通嵌入的智能小Q 模块 ID。', 'type' => 'string', 'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" ."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'CopilotEmbed.Config.NotFind', 'errorMessage' => 'Can not find copilot embed config with this copilot ID.', 'description' => '找不到此嵌入配置', ], [ 'errorCode' => 'Authorize3rdTicket.Num.HasNoLeft', 'errorMessage' => 'There is no ticket number left, please generate new ticket.', 'description' => '当前票据已消费完毕，请重新生成。', ], [ 'errorCode' => 'Invalid.Param.Error', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.Exceed', 'errorMessage' => 'The number of tickets %s is invalid.', 'description' => '票据数量不合法。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": \\"f5eeb52e-d9c2-4a8b-80e3-47ab55c2****\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '生成智能小Q嵌入Ticket', 'changeSet' => [ [ 'createdAt' => '2025-03-14T06:35:33.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket4Copilot', ], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:CreateTicket4Copilot', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CreateUserGroup' => [ 'summary' => '新建用户组，可以指定父用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'description' => '用户组唯一ID。'."\n" ."\n" .'- 无需传入，系统会自动生成；当用户主动传入UserGroupId时，以用户传入的ID作为用户组ID，用户需要自行保证该ID在组织内唯一。'."\n" .'- 格式校验：最大长度64，不能为-1，', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pop0001', ], ], [ 'name' => 'UserGroupName', 'in' => 'query', 'schema' => [ 'description' => '用户组名称。'."\n" ."\n" .'- 格式校验：最大长度255'."\n" .'- 特殊格式校验：中英文数字 _ \\ / | () ] \\[', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '杭州财报', ], ], [ 'name' => 'UserGroupDescription', 'in' => 'query', 'schema' => [ 'description' => '用户组描述。'."\n" ."\n" .'- 格式校验：最大长度255'."\n" .'- 特殊格式校验：中英文数字 _ \\ / | () ] \\[', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '用户分组描述', ], ], [ 'name' => 'ParentUserGroupId', 'in' => 'query', 'schema' => [ 'description' => '父用户组ID。可以将新建的用户组添加到该分组下：'."\n" .'- 当输入父用户组ID时，新建的用户组会添加到该ID的用户组下。'."\n" .'- 当输入-1时，新建的用户组会添加到根目录下。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3d2c23d4-2b41-4af8-a1f5-f6390f32****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => '36829379-0C38-5BC0-830A-92665BF77D4F', ], 'Result' => [ 'description' => '返回用户组添加成功后的ID。如果添加失败，返回空字符串“”。', 'type' => 'string', 'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '', ], [ 'errorCode' => 'Duplicate.Name.Error', 'errorMessage' => 'The name already exists.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Parent.NotFound', 'errorMessage' => 'The parent user group does not exist.', 'description' => '', ], [ 'errorCode' => 'Duplicate.UserGroup.Id', 'errorMessage' => 'Duplicated usergroupId %s.', 'description' => '', ], [ 'errorCode' => 'RootUserGroup.Create.Error', 'errorMessage' => 'organization %s has synchronized with other organizational structures, so user groups cannot be created under the root user group.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Already.Synchronized', 'errorMessage' => 'Organization has synchronized with other organizational structures, so you are not allowed to add users under group.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Layer.Limited', 'errorMessage' => 'The user group cannot have more than ten layers.', 'description' => '', ], [ 'errorCode' => 'UserGroup.ExceedsLimit.Error', 'errorMessage' => 'User group exceed limit, %s.', 'description' => '', ], [ 'errorCode' => 'Duplicate.UserGroupName.Error', 'errorMessage' => 'There is already a user group with the same name %s, please rename it before saving.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36829379-0C38-5BC0-830A-92665BF77D4F\\",\\n \\"Result\\": \\"f5eeb52e-d9c2-4a8b-80e3-47ab55c2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 36829379-0C38-5BC0-830A-92665BF77D4F\\n f5eeb52e-d9c2-4a8b-80e3-47ab55c2****\\n true\\n","errorExample":""}]', 'title' => '新建用户组', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'quickbi-public:CreateUserGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'CreateWorkspace' => [ 'summary' => '新建工作空间。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'WorkspaceName', 'in' => 'query', 'schema' => [ 'description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'WorkspaceDescription', 'in' => 'query', 'schema' => [ 'description' => '工作空间备注。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', ], ], [ 'name' => 'UseComment', 'in' => 'query', 'schema' => [ 'description' => '工作空间创建数据集是否使用表备注，默认：true。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'AllowShare', 'in' => 'query', 'schema' => [ 'description' => '工作空间报表是否允许分享，默认：true。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'AllowPublish', 'in' => 'query', 'schema' => [ 'description' => '工作空间报表是否允许公开，默认：true。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'AllowViewAll', 'in' => 'query', 'schema' => [ 'description' => '工作空间是否是协同模式，默认：true。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], [ 'name' => 'DefaultShareToAll', 'in' => 'query', 'schema' => [ 'description' => '工作空间作品是否默认授权工作空间所有人可查看，默认：false。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', ], ], [ 'name' => 'OnlyAdminCreateDatasource', 'in' => 'query', 'schema' => [ 'description' => '工作空间数据源是否仅管理员可创建，默认false。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '685072****************4e79e718f', ], 'Result' => [ 'description' => '工作空间ID。', 'type' => 'string', 'example' => '12423twfasva********', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'CreateWorkspace.Exceeds.Limits', 'errorMessage' => 'The number of create workspace exceeds the maximum number limit:%s.', 'description' => '创建工作空间超过了最大数量限制：%s。', ], [ 'errorCode' => 'UserRoleConfig.NotContain.Function', 'errorMessage' => 'The user %s does not have permission to operate.', 'description' => '此用户%s没有权限操作。', ], [ 'errorCode' => 'Duplicate.WorkSpaceName.Error', 'errorMessage' => 'There is already a workspace with the same name %s, please rename it before saving.', 'description' => '已经存在同名工作空间“%s”，请修改名称后再保存。', ], [ 'errorCode' => 'Transfer.Not.Allowed', 'errorMessage' => 'Transfer to users with lower space permissions is not allowed.', 'description' => '不允许转移给更低空间权限的用户。', ], [ 'errorCode' => 'Transfer.TargetUser.NotExist', 'errorMessage' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.', 'description' => '转让目标用户不存在，请确保目标用户登录过当前系统。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '新建工作空间', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685072****************4e79e718f\\",\\n \\"Result\\": \\"12423twfasva********\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DataSetBlood' => [ 'summary' => '查询引用指定数据集下的作品信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataSetIds', 'in' => 'query', 'schema' => [ 'title' => '数据集ID列表，以逗号分割', 'description' => '数据集ID列表，以英文逗号分割。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '234235234,234235235,234235235', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '指定报表所属owner ，为userId', 'description' => '指定报表所属owner ，为userId。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dasasgaj342351', ], ], [ 'name' => 'WorksType', 'in' => 'query', 'schema' => [ 'title' => '指定报表类型:'."\n" .'● REPORT:电子表格'."\n" .'● dashboardOfflineQuery：自助取数'."\n" .'● DASHBOARD:仪表板'."\n" .'● ANALYSIS:即席分析'."\n" .'● SCREEN:数据大屏'."\n" .'● PAGE:老仪表板', 'description' => '指定报表类型：'."\n" .'- REPORT：电子表格'."\n" .'- dashboardOfflineQuery：自助取数'."\n" .'- DASHBOARD：仪表板'."\n" .'- ANALYSIS：即席分析'."\n" .'- SCREEN：数据大屏'."\n" .'- PAGE：老仪表板', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PAGE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '46e537a5****,3dadsu****', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Result' => [ 'description' => '作品数组。', 'type' => 'array', 'items' => [ 'description' => '作品对象。', 'type' => 'object', 'properties' => [ 'WorksId' => [ 'title' => '作品id', 'description' => '作品id。', 'type' => 'string', 'example' => 'ccd3428c-****-****-a608-26bae29dffee', ], 'WorksType' => [ 'title' => '作品类型：'."\n" .'● REPORT:电子表格'."\n" .'● dashboardOfflineQuery：自助取数'."\n" .'● DASHBOARD:仪表板'."\n" .'● ANALYSIS:即席分析'."\n" .'● SCREEN:数据大屏'."\n" .'● PAGE:老仪表板', 'description' => '作品类型：'."\n" .'- REPORT：电子表格'."\n" .'- dashboardOfflineQuery：自助取数'."\n" .'- DASHBOARD：仪表板'."\n" .'- ANALYSIS：即席分析'."\n" .'- SCREEN：数据大屏'."\n" .'- PAGE：老仪表板', 'type' => 'string', 'example' => 'PAGE', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '数据集不存在。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46e537a5****,3dadsu****\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"WorksId\\": \\"ccd3428c-****-****-a608-26bae29dffee\\",\\n \\"WorksType\\": \\"PAGE\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询引用指定数据集下的作品信息', 'changeSet' => [ [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DataSetBlood', ], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:DataSetBlood', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DataSourceBlood' => [ 'summary' => '查询引用指定数据源下的数据集信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'title' => '数据源ID', 'description' => '数据源id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '44051300991327000048', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '46e537a5****,3dadsu****', ], 'Success' => [ 'title' => '是否请求成功。取值范围：'."\n" .'● true：请求成功'."\n" .'● false：请求失败', 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Result' => [ 'title' => '数据集id数组。', 'description' => '数据集id数组。', 'type' => 'array', 'items' => [ 'description' => '数据集id。', 'type' => 'string', 'example' => 'sdfasdaw234234235', ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'Invalid.User.Admin', 'errorMessage' => 'You are not an administrator of this organization.', 'description' => '', ], [ 'errorCode' => 'Datasource.NotFound.Error', 'errorMessage' => 'The specified data source does not exist: %s.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46e537a5****,3dadsu****\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n \\"sdfasdaw234234235\\"\\n ]\\n}","type":"json"}]', 'title' => '查询引用指定数据源下的数据集信息', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:DataSourceBlood', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DelayTicketExpireTime' => [ 'summary' => '更新嵌入报表的ticket的失效时间。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'Ticket', 'in' => 'query', 'schema' => [ 'description' => '三方嵌入的票据值，即URL中的accessTicket值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '040e6f79d33444838e*****c7206c070', ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => '要延期的时间。'."\n" .'- 单位分钟，取值范围0~240（4小时）。'."\n" .'- 已过期的票据无法延期。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '200', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '是否延期成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch', 'errorMessage' => 'The report bound by the ticket mismatches the actual report.', 'description' => 'Ticket绑定的报表与访问页面报表不一致。', ], [ 'errorCode' => 'Authorize3rdTicket.Expired', 'errorMessage' => 'Ticket [%s] has expired.', 'description' => '当前票据[%s]已过期。', ], [ 'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken', 'errorMessage' => 'The request [%s] has no token.', 'description' => '当前请求 [%s] 未找到token信息。', ], [ 'errorCode' => 'Authorize3rdTicket.NotExist', 'errorMessage' => 'Ticket %s does not exist.', 'description' => '当前票据%s不存在。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.Exceed', 'errorMessage' => 'The number of tickets %s is invalid.', 'description' => '票据数量不合法。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.HasNoLeft', 'errorMessage' => 'There is no ticket number left, please generate new ticket.', 'description' => '当前票据已消费完毕，请重新生成。', ], [ 'errorCode' => 'NoPermissionTo.Operate.Object', 'errorMessage' => 'You are not authorized to operate the objects.', 'description' => '您无权操作这些对象。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n true\\n true\\n","errorExample":""}]', 'title' => '更新嵌入ticket的失效时间', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DelayTicketExpireTime', ], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:DelayTicketExpireTime', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteDataLevelPermissionRuleUsers' => [ 'summary' => '针对单条行列权限规则删除选定的人群。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DeleteUserModel', 'in' => 'query', 'schema' => [ 'description' => '{'."\n" .' "ruleId": "a5bb24da-***-a891683e14da", // 行列权限规则ID'."\n" .' "cubeId": "7c7223ae-***-3c744528014b", // 数据集ID'."\n" .' "delModel": {'."\n" .' "userGroups": ['."\n" .' "0d5fb19b-***-1248fc27ca51", // 删除用户组人群的用户组ID'."\n" .' "3d2c23d4-***-f6390f325c2d"'."\n" .' ],'."\n" .' "users": ['."\n" .' "4334***358", // 删除用户人群的UserID'."\n" .' "Huang***3fa822"'."\n" .' ]'."\n" .' }'."\n" .'}', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' {"ruleId":"a5bb24da-***-a891683e14da","cubeId":"7c7223ae-***-3c744528014b","delModel":{"userGroups":["0d5fb19b-***-1248fc27ca51","3d2c23d4-***-f6390f325c2d"],"users":["4334***358","Huang***3fa822"]}}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n true\\n true\\n","errorExample":""}]', 'title' => '删除行列规则的人群', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteDataLevelPermissionRuleUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteDataLevelRuleConfig' => [ 'summary' => '删除单条行列权限规则。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-****-3c744528014b', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '行列权限的规则ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a5bb24da-****-a891683e14da', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n true\\n true\\n","errorExample":""}]', 'title' => '删除行列权限规则', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:57.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteDataLevelRuleConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteTicket' => [ 'summary' => '删除免登嵌入报表的指定ticket。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'Ticket', 'in' => 'query', 'schema' => [ 'description' => '三方嵌入的票据值，即URL中的accessTicket值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '040e6f79d****7d283c7206c070', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '是否删除成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch', 'errorMessage' => 'The report bound by the ticket mismatches the actual report.', 'description' => 'Ticket绑定的报表与访问页面报表不一致。', ], [ 'errorCode' => 'Authorize3rdTicket.Expired', 'errorMessage' => 'Ticket [%s] has expired.', 'description' => '当前票据[%s]已过期。', ], [ 'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken', 'errorMessage' => 'The request [%s] has no token.', 'description' => '当前请求 [%s] 未找到token信息。', ], [ 'errorCode' => 'Authorize3rdTicket.NotExist', 'errorMessage' => 'Ticket %s does not exist.', 'description' => '当前票据%s不存在。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.Exceed', 'errorMessage' => 'The number of tickets %s is invalid.', 'description' => '票据数量不合法。', ], [ 'errorCode' => 'Authorize3rdTicket.Num.HasNoLeft', 'errorMessage' => 'There is no ticket number left, please generate new ticket.', 'description' => '当前票据已消费完毕，请重新生成。', ], [ 'errorCode' => 'NoPermissionTo.Operate.Object', 'errorMessage' => 'You are not authorized to operate the objects.', 'description' => '您无权操作这些对象。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n true\\n true\\n","errorExample":""}]', 'title' => '删除嵌入ticket', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTicket', ], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteTicket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUser' => [ 'summary' => '删除指定组织用户。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '待删除的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fe67f61a35a94b7da1a34ba174a7****', ], ], [ 'name' => 'TransferUserId', 'in' => 'query', 'schema' => [ 'description' => '继承者的用户ID。如果不为空，则将删除用户在工作空间内的报表资源转移给继承者，否则转移给空间owner。'."\n" .'- 继承者不能是组织访问者'."\n" .'- 继承者在工作空间的权限不能小于删除掉的用户，管理权限>开发权限>分享权限>查看权限'."\n" .'- 继承者不在工作空间内，会自动加入工作空间', 'type' => 'string', 'required' => false, 'example' => 'f5****afccd9e434a274', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'CannotRemove.OrganizationOwner', 'errorMessage' => 'You cannot remove the organization owner from the organization.', 'description' => '不能将组织所有者踢出组织。', ], [ 'errorCode' => 'Member.ExistInWorkspace.Error', 'errorMessage' => 'You cannot remove a user who is a member of a group workspace.', 'description' => '该用户仍在群空间中，无法移除。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'Workspace.Type.Error', 'errorMessage' => 'The type of group workspace is invalid.', 'description' => '无效的群空间类型。', ], [ 'errorCode' => 'Not.Organization.AuthAdmin', 'errorMessage' => 'You are not a role administrator of the organization and do not have the permission to perform the operation.', 'description' => '您不是该组织的角色管理员，无权操作此项。', ], [ 'errorCode' => 'Works.Transfer.Error', 'errorMessage' => 'You are not authorized to transfer this item.', 'description' => '转让失败，您没有相应权限。', ], [ 'errorCode' => 'CanNot.Remove.WorkspaceOwner', 'errorMessage' => 'You cannot remove the group workspace owner from the group.', 'description' => '不能将群空间拥有者剔除出群。', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not a member of the group workspace.', 'description' => '该用户不在群空间中。', ], [ 'errorCode' => 'Transfer.TargetUser.NotExist', 'errorMessage' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.', 'description' => '转让目标用户不存在，请确保目标用户登录过当前系统。', ], [ 'errorCode' => 'User.RoleType.Valid', 'errorMessage' => 'The role ID is invalid.', 'description' => '无效的角色ID。', ], [ 'errorCode' => 'Viewer.AddInTo.Workspace', 'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.', 'description' => '不允许将组织的访客类型用户添加到工作空间：%s。', ], [ 'errorCode' => 'UserAnalyst.NotSupport.ThisRole', 'errorMessage' => 'This role has permissions that analysts cannot grant.', 'description' => '该角色具有分析员无法授予的权限。', ], [ 'errorCode' => 'Transfer.Not.Allowed', 'errorMessage' => 'Transfer to users with lower space permissions is not allowed.', 'description' => '不允许转移给更低空间权限的用户。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\n true\\n true\\n","errorExample":""}]', 'title' => '删除组织用户', 'changeSet' => [ [ 'createdAt' => '2025-03-14T06:35:33.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2023-08-07T06:37:07.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser', ], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUserFromWorkspace' => [ 'summary' => '删除指定工作空间的成员。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '待删除的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'de4bc5f9429141cc8091cdd1c15b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '', ], [ 'errorCode' => 'Workspace.Type.Error', 'errorMessage' => 'The type of group workspace is invalid.', 'description' => '', ], [ 'errorCode' => 'CanNot.Remove.WorkspaceOwner', 'errorMessage' => 'You cannot remove the group workspace owner from the group.', 'description' => '', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not a member of the group workspace.', 'description' => '', ], [ 'errorCode' => 'Cannot.TransferTo.Owner', 'errorMessage' => 'You cannot transfer an item to its current owner.', 'description' => '', ], [ 'errorCode' => 'Works.Transfer.Error', 'errorMessage' => 'You are not authorized to transfer this item.', 'description' => '', ], [ 'errorCode' => 'Transfer.TargetUser.NotExist', 'errorMessage' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.', 'description' => '', ], [ 'errorCode' => 'PersonalWorkspace.NotSupport.AllTransfer', 'errorMessage' => 'Personal workspaces cannot be transferred.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\n true\\n true\\n","errorExample":""}]', 'title' => '删除工作空间成员', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUserFromWorkspace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUserGroup' => [ 'summary' => '删除组织内的用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'description' => '用户组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2775AB6-DE99-5FA6-86A4-72EA0A8AFEE3', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Remove.RootNode', 'errorMessage' => 'The root user group cannot be deleted.', 'description' => '', ], [ 'errorCode' => 'UserGroup.Remove.WithChildren', 'errorMessage' => 'This user group contains a child user group and cannot be deleted.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F2775AB6-DE99-5FA6-86A4-72EA0A8AFEE3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n F2775AB6-DE99-5FA6-86A4-72EA0A8AFEE3\\n true\\n true\\n","errorExample":""}]', 'title' => '删除用户组', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUserGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUserGroupMember' => [ 'summary' => '删除指定用户组下的指定成员。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'description' => '用户组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '46e537****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI的用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2fe4fbd8****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3', ], 'Result' => [ 'description' => '返回删除用户组成员的结果。取值范围：'."\n" ."\n" .'- true：删除成功'."\n" ."\n" .'- false：删除失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" ."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DC4E1E63-B337-44F8-8C22-6F00DF67E2C3\\n true\\n true\\n","errorExample":""}]', 'title' => '删除用户组成员', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUserGroupMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUserGroupMembers' => [ 'summary' => '指定用户批量退出用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '要退出用户组的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '204627493484****', ], ], [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '要退出的用户组ID。'."\n" ."\n" .'- 支持批量传参，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABBAD906-3925-5D18-B23D-714053AB0AA2', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The usergroup %s does not belong to the current organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABBAD906-3925-5D18-B23D-714053AB0AA2\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ABBAD906-3925-5D18-B23D-714053AB0AA2\\n true\\n true\\n","errorExample":""}]', 'title' => '用户批量退出用户组', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUserGroupMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'DeleteUserTagMeta' => [ 'summary' => '删除组织成员的标签元信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'TagId', 'in' => 'query', 'schema' => [ 'description' => '待删除的标签ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pop_001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回删除标签的执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'UserTag.NotIn.CurrentOrganization', 'errorMessage' => 'The user tag is not in the current organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n true\\n true\\n","errorExample":""}]', 'title' => '删除组织成员标签元信息', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:31.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'quickbi-public:DeleteUserTagMeta', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'GetDataSourceConnectionInfo' => [ 'summary' => '获取数据源信息。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DsId', 'in' => 'query', 'schema' => [ 'title' => '数据源id', 'description' => '数据源ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '7AAB95D-*****-****-*4FC0C976', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '7AAB95D-*****-****-*4FC0C976', ], 'Result' => [ 'title' => '数据源信息', 'description' => '数据源信息。', 'type' => 'object', 'properties' => [ 'Address' => [ 'title' => '数据库连接串地址（域名或ip）', 'description' => '数据库连接串地址（域名或ip）。', 'type' => 'string', 'example' => '172.**.**.48', ], 'AuthLevel' => [ 'title' => '权限级别：'."\n" .'● 0 -- 私有'."\n" .'● 1 -- 协同编辑(旧)'."\n" .'● 11 -- 协同编辑——空间成员'."\n" .'● 12 -- 协同编辑——指定到人', 'description' => '权限级别：'."\n" ."\n" .'- 0 -- 私有'."\n" .'- 1 -- 协同编辑(旧)'."\n" .'- 11 -- 协同编辑——空间成员'."\n" .'- 12 -- 协同编辑——指定到人', 'type' => 'string', 'example' => '0', ], 'CreatorId' => [ 'title' => '创建人的Quick BI用户ID。', 'description' => '创建人的Quick BI用户ID。', 'type' => 'string', 'example' => 'U240****0880C6095', ], 'DsId' => [ 'title' => '数据源ID', 'description' => '数据源ID。', 'type' => 'string', 'example' => 'a201c85c-******', ], 'DsType' => [ 'title' => '数据源类型', 'description' => '数据源类型。', 'type' => 'string', 'enumValueTitles' => [ 'hive' => 'Hive 数据源', 'vertica' => 'Vertica 数据源', 'ppas' => 'RDS PPAS数据源', 'dm' => 'DM7数据源-达梦', 'tsdb' => 'TSDB数据源', 'tdsql' => 'TDSQL-H数据源', 'mysql_hybrid' => 'HybridDB for MySQL数据源', 'sqlserver' => 'sqlserver数据源', 'postgresql' => 'postgresql数据源', 'garuda' => 'garuda数据源', 'adb_spark' => 'adb数据源Spark引擎', 'greenplum' => 'greenplum数据源', 'phoenix_thin' => 'PHOENIX THIN 数据源', 'dla' => 'DataLake Analytics 数据源', 'starrocks' => 'StarRocks数据源', 'mysql' => 'mysql数据源', 'hana' => 'SAP HANA 数据源', 'mongodb' => 'MongoDB数据源', 'adb' => 'ADB', 'hbase' => 'HBASE数据源', 'oscar' => '神通数据源', 'gbase' => 'Gbase数据源', 'oracle' => 'oracle数据源', 'sybase' => ' SAP SYBASE IQ 数据源', 'dataphin' => 'DataPhin数据源-多引擎', 'odps' => 'odps数据源', 'db2' => 'IBM DB2数据源(LUW)', 'yida' => '宜搭应用数据源', 'clickhouse' => 'ClickHouse数据源', 'oceanbase_oracle' => 'OceanBase_Oracle模式数据源', 'presto' => 'presto数据源', 'polardb' => 'polardb数据源', 'dataphin_odps' => 'DataPhin数据源odps引擎', 'selectdb' => 'SelectDB数据源', ], 'example' => 'mysql', ], 'DsVersion' => [ 'title' => '数据源的版本', 'description' => '数据源的版本。', 'type' => 'string', 'example' => '5.7', ], 'Instance' => [ 'title' => '数据库实例，对应数据库名称，ODPS为project', 'description' => '数据库实例，对应数据库名称，ODPS为project。', 'type' => 'string', 'example' => 'rm*********t44ju1', ], 'InstanceId' => [ 'title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rm*********t44ju1', ], 'ModifyUser' => [ 'title' => '修改人的Quick BI用户ID。', 'description' => '修改人的Quick BI用户ID。', 'type' => 'string', 'example' => 'U240****0880C6095', ], 'NoSasl' => [ 'description' => 'impala数据源是否需要身份验证即可登录：'."\n" ."\n" .'- true-需要账户密码登录 '."\n" .'- false-不需要验证(默认)', 'type' => 'boolean', 'example' => 'true', ], 'ParentDsType' => [ 'title' => '多引擎数据源的主数据源类型', 'description' => '多引擎数据源的主数据源类型。', 'type' => 'string', 'example' => 'dataphin', ], 'Port' => [ 'title' => '端口', 'description' => '端口。', 'type' => 'string', 'example' => '3306', ], 'Project' => [ 'title' => '获取连接串详情时，odps供前端展示使用', 'description' => '获取连接串详情时，odps供前端展示使用。', 'type' => 'string', 'example' => 'prod-ossdoc', ], 'Schema' => [ 'title' => '数据库schema，仅对支持schema的数据库需要设置', 'description' => '数据库schema，仅对支持schema的数据库需要设置。', 'type' => 'string', 'example' => 'Analysis', ], 'ShowName' => [ 'title' => '数据源前端展示名称', 'description' => '数据源前端展示名称。', 'type' => 'string', 'example' => '0327', ], 'WorkspaceId' => [ 'title' => '数据源所属工作空间ID', 'description' => '数据源所属工作空间ID。', 'type' => 'string', 'example' => '0de6**2-d**-4720-8836-0cc****1394c', ], ], ], 'Success' => [ 'title' => '是否成功', 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The length of the parameter must not exceed 1000.', 'description' => '', ], [ 'errorCode' => 'Access.Forbidden', 'errorMessage' => 'Your instance version or access key is not allowed to call the API operation, only professional version supports calling.', 'description' => '', ], [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '', ], [ 'errorCode' => 'Instance.Expired', 'errorMessage' => 'Your instance has expired.', 'description' => '', ], [ 'errorCode' => 'Instance.Not.Exist', 'errorMessage' => 'The specified instance does not exist.', 'description' => '', ], [ 'errorCode' => 'Invalid.Organization', 'errorMessage' => 'The specified organizational unit does not exist.', 'description' => '', ], [ 'errorCode' => 'User.Not.In.Organization', 'errorMessage' => 'The specified user is not in the organizational unit.', 'description' => '', ], [ 'errorCode' => 'Invalid.Param.Error', 'errorMessage' => 'The parameter is invalid.', 'description' => '', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '', ], [ 'errorCode' => 'Datasource.NotFound.Error', 'errorMessage' => 'The specified data source does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'Application.Object.NotExist', 'errorMessage' => 'The object you are operating does not exist or has been deleted.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7AAB95D-*****-****-*4FC0C976\\",\\n \\"Result\\": {\\n \\"Address\\": \\"172.**.**.48\\",\\n \\"AuthLevel\\": \\"0\\",\\n \\"CreatorId\\": \\"U240****0880C6095\\",\\n \\"DsId\\": \\"a201c85c-******\\",\\n \\"DsType\\": \\"mysql\\",\\n \\"DsVersion\\": \\"5.7\\",\\n \\"Instance\\": \\"rm*********t44ju1\\",\\n \\"InstanceId\\": \\"rm*********t44ju1\\",\\n \\"ModifyUser\\": \\"U240****0880C6095\\",\\n \\"NoSasl\\": true,\\n \\"ParentDsType\\": \\"dataphin\\",\\n \\"Port\\": \\"3306\\",\\n \\"Project\\": \\"prod-ossdoc\\",\\n \\"Schema\\": \\"Analysis\\",\\n \\"ShowName\\": \\"0327\\",\\n \\"WorkspaceId\\": \\"0de6**2-d**-4720-8836-0cc****1394c\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取数据源信息', 'changeSet' => [ [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:GetDataSourceConnectionInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'GetMailTaskList' => [ 'summary' => '获取订阅任务列表信息，注意：当调用者ak的权限不能查看其他人的订阅任务时，则只能返回当前调用者有权限的列表。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '当前页码：'."\n" .'- 起始值：1'."\n" .'- 默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页行数：'."\n" ."\n" .'- 默认值：25', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], [ 'name' => 'UserNick', 'in' => 'query', 'schema' => [ 'description' => '订阅负责人的用户昵称，如果不传则查全部。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', ], ], [ 'name' => 'Paused', 'in' => 'query', 'schema' => [ 'description' => '订阅任务是否已暂停。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '0c52************8e1952a3', ], 'Result' => [ 'description' => '订阅任务的分页信息。', 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPages' => [ 'description' => '总页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Pre' => [ 'description' => '上一页，为NULL or 0，表示没有上一页。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', ], 'Next' => [ 'description' => '下一页，为NULL or 0，表示没有下一页。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', ], 'Data' => [ 'description' => '订阅任务信息模型数组。', 'type' => 'array', 'items' => [ 'description' => '订阅任务信息模型。', 'type' => 'object', 'properties' => [ 'MailId' => [ 'description' => '订阅任务的邮件ID。', 'type' => 'string', 'example' => '2342526', ], 'Paused' => [ 'description' => '任务是否暂停。'."\n" ."\n" .'- true -- 暂停'."\n" .'- false -- 未暂停', 'type' => 'boolean', 'example' => 'true', ], 'BizOwnerUserId' => [ 'description' => '负责人userId。', 'type' => 'string', 'example' => 'asag****2423', ], 'BizOwnerName' => [ 'description' => '负责人昵称。', 'type' => 'string', 'example' => 'test', ], 'SubscribeName' => [ 'description' => '订阅任务名称。', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" ."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'UserRoleConfig.NotContain.Function', 'errorMessage' => 'The user %s does not have permission to operate.', 'description' => '此用户%s没有权限操作。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '获取订阅任务列表信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0c52************8e1952a3\\",\\n \\"Result\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1,\\n \\"TotalPages\\": 1,\\n \\"Pre\\": 0,\\n \\"Next\\": 0,\\n \\"Data\\": [\\n {\\n \\"MailId\\": \\"2342526\\",\\n \\"Paused\\": true,\\n \\"BizOwnerUserId\\": \\"asag****2423\\",\\n \\"BizOwnerName\\": \\"test\\",\\n \\"SubscribeName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetMailTaskStatus' => [ 'summary' => '查看组织内邮件任务运行状态（实时状态非最终状态）。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'MailId', 'in' => 'query', 'schema' => [ 'title' => '邮件id', 'description' => '邮件id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd5a59a898b634d75be5584f8dc159c62', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务id'."\n" ."\n" .'> - 当任务id传参为空时，则默认返回最新的一条任务状态；'."\n" .'> - 当任务id传参不为空时，则按传参值返回任务状态。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '7218865303929605212', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '38C0FEC8-1510-415C-A9F1-9AE9422BDB65', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'execTime' => [ 'title' => '执行时间，时间格式为 yyyy-MM-dd HH:mm:ss', 'description' => '执行时间，时间格式为 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-09 17:34:11', ], 'mailId' => [ 'title' => '邮件id', 'description' => '邮件id', 'type' => 'string', 'example' => 'c38f73f4c5xxxxxc808c41b3f4d23b7852', ], 'status' => [ 'title' => '邮件状态，成功：SENT ，失败：FAILED ，进行中：PROCESSING', 'description' => '邮件状态。取值范围：'."\n" ."\n" .'- 成功：SENT'."\n" .'- 失败：FAILED '."\n" .'- 进行中：PROCESSING', 'type' => 'string', 'example' => 'SENT', ], 'taskId' => [ 'title' => '任务id', 'description' => '任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '1282xxx610816', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Mail.Forbidden.Access', 'errorMessage' => 'Forbidden Access On This Operation.', 'description' => '', ], [ 'errorCode' => 'Mail.Not.Found', 'errorMessage' => 'Mail not found.', 'description' => '', ], [ 'errorCode' => 'Mail.Subject.Error', 'errorMessage' => 'The mail subject is invalid.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"38C0FEC8-1510-415C-A9F1-9AE9422BDB65\\",\\n \\"Result\\": [\\n {\\n \\"execTime\\": \\"2024-10-09 17:34:11\\",\\n \\"mailId\\": \\"c38f73f4c5xxxxxc808c41b3f4d23b7852\\",\\n \\"status\\": \\"SENT\\",\\n \\"taskId\\": 0\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查看邮件任务运行状态', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:GetMailTaskStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'GetUserGroupInfo' => [ 'summary' => '根据用户组名称关键字搜索用户组信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '用户组名称关键字。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试用户组', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => 'D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5', ], 'Result' => [ 'description' => '用户组信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => '用户组创建时间。', 'type' => 'string', 'example' => '2021-03-15 17:13:55', ], 'CreateUser' => [ 'description' => '子用户组创建者。此处为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'example' => '46e5374665ba4b679ee22e2a2927****', ], 'IdentifiedPath' => [ 'description' => '用户组的目录层级。', 'type' => 'string', 'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****', ], 'ModifiedTime' => [ 'description' => '用户组最新修改时间。', 'type' => 'string', 'example' => '2021-03-15 20:36:40', ], 'ModifyUser' => [ 'description' => '用户组修改者。此处为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'example' => '46e5374665ba4b679ee22e2a2927****', ], 'ParentUsergroupId' => [ 'description' => '父用户组ID。', 'type' => 'string', 'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****', ], 'UsergroupDesc' => [ 'description' => '用户组备注。', 'type' => 'string', 'example' => '测试描述', ], 'UsergroupId' => [ 'description' => '用户组ID。', 'type' => 'string', 'example' => '34fd141d-4598-4093-8c33-8e066dcb****', ], 'UsergroupName' => [ 'description' => '用户组名称。', 'type' => 'string', 'example' => '测试用户组01', ], ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5\\",\\n \\"Result\\": [\\n {\\n \\"CreateTime\\": \\"2021-03-15 17:13:55\\",\\n \\"CreateUser\\": \\"46e5374665ba4b679ee22e2a2927****\\",\\n \\"IdentifiedPath\\": \\"2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****\\",\\n \\"ModifiedTime\\": \\"2021-03-15 20:36:40\\",\\n \\"ModifyUser\\": \\"46e5374665ba4b679ee22e2a2927****\\",\\n \\"ParentUsergroupId\\": \\"2fe4fbd8-588f-489a-b3e1-e92c7af0****\\",\\n \\"UsergroupDesc\\": \\"测试描述\\",\\n \\"UsergroupId\\": \\"34fd141d-4598-4093-8c33-8e066dcb****\\",\\n \\"UsergroupName\\": \\"测试用户组01\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5\\n \\n 2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****\\n 2fe4fbd8-588f-489a-b3e1-e92c7af0****\\n 2021-03-15 20:36:40\\n 46e5374665ba4b679ee22e2a2927****\\n 测试用户组01\\n 2021-03-15 17:13:55\\n 测试描述\\n 34fd141d-4598-4093-8c33-8e066dcb****\\n 46e5374665ba4b679ee22e2a2927****\\n \\n","errorExample":""}]', 'title' => '根据关键字获取用户组信息', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:GetUserGroupInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'GetWorksEmbedList' => [ 'summary' => '查询已嵌入报表列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WsId', 'in' => 'query', 'schema' => [ 'title' => '工作空间id', 'description' => '工作空间ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '919818-***-*****-wdasd', ], ], [ 'name' => 'WorksType', 'in' => 'query', 'schema' => [ 'title' => '报表类型'."\n" .'page, 仪表板'."\n" .'screen, 数据大屏'."\n" .'report, 电子表格'."\n" .'ANALYSIS, 即席分析'."\n" .'dashboardOfflineQuery, 自助取数'."\n" .'dataForm, 数据填报', 'description' => '报表类型'."\n" ."\n" .'- page, 仪表板'."\n" .'- screen, 数据大屏'."\n" .'- report, 电子表格'."\n" .'- ANALYSIS, 即席分析'."\n" .'- dashboardOfflineQuery, 自助取数'."\n" .'- dataForm, 数据填报', 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [ 'dataForm' => '数据填报', 'dashboardOfflineQuery' => '自助取数', 'report' => '电子表格', 'screen' => '数据大屏', 'ANALYSIS' => '即席分析', 'page' => ' 仪表板', ], 'example' => 'page', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'title' => '报表名称（模糊匹配）', 'description' => '报表名称（模糊匹配）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试数据集', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'title' => '页数（为空默认选1）', 'description' => '页数（为空默认选1）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页显示的条数（为空默认选10）', 'description' => '每页显示的条数（为空默认选10）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '38C0F*****0-415****9F1-*****422BDB65', ], 'Result' => [ 'description' => '报表数组对象', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '报表数组', 'type' => 'array', 'items' => [ 'description' => '报表对象', 'type' => 'object', 'properties' => [ 'EmbedTime' => [ 'title' => '嵌入时间', 'description' => '嵌入时间', 'type' => 'string', 'example' => 'YYYY-mm-DD hh:MM:ss', ], 'WorksId' => [ 'title' => '报表ID', 'description' => '报表ID', 'type' => 'string', 'example' => '897ce25e-****-****-af84-d13c5610****', ], 'WorksName' => [ 'title' => '报表名称', 'description' => '报表名称', 'type' => 'string', 'example' => '测试哦', ], 'WorksType' => [ 'title' => '报表类型', 'description' => '报表类型', 'type' => 'string', 'example' => 'page', ], 'WorkspaceId' => [ 'title' => '所属空间ID', 'description' => '所属空间ID', 'type' => 'string', 'example' => '87c6b145-****-43e1-9426-8f93be23****', ], ], ], ], 'PageNo' => [ 'title' => '页数', 'description' => '页数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'title' => '每页显示的条数', 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TotalNum' => [ 'title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '18', ], 'TotalPages' => [ 'title' => '总页码', 'description' => '总页码', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], 'Success' => [ 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"38C0F*****0-415****9F1-*****422BDB65\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"EmbedTime\\": \\"YYYY-mm-DD hh:MM:ss\\",\\n \\"WorksId\\": \\"897ce25e-****-****-af84-d13c5610****\\",\\n \\"WorksName\\": \\"测试哦\\",\\n \\"WorksType\\": \\"page\\",\\n \\"WorkspaceId\\": \\"87c6b145-****-43e1-9426-8f93be23****\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 18,\\n \\"TotalPages\\": 2\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取已经嵌入的报表', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:GetWorksEmbedList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListAccelerationOfWorkspace' => [ 'summary' => '获取空间下加速引擎管控页任务信息。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'CubeName', 'in' => 'query', 'schema' => [ 'description' => '数据集名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', ], ], [ 'name' => 'CreatorId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 QueryUserInfoByAccount 接口，获取 UserId。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1***************139', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '页数（为空默认选1）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的每页行数：'."\n" .'- 默认值：10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E****************05DF8D885', ], 'Result' => [ 'description' => '加速任务信息模型。', 'type' => 'object', 'properties' => [ 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18', ], 'PageNum' => [ 'description' => ' '."\n" .'页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Pre' => [ 'description' => '上一页, 为NULL or 0 ，表示没有上一页。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Next' => [ 'description' => '下一页 ，为NULL or 0，表示没有下一页。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', ], 'Data' => [ 'description' => '加速任务信息数组。', 'type' => 'array', 'items' => [ 'description' => '加速任务信息数组。', 'type' => 'object', 'properties' => [ 'CubeId' => [ 'description' => '数据集ID。', 'type' => 'string', 'example' => 'd14e*********fef8de29fd', ], 'CubeName' => [ 'description' => '数据集名称。', 'type' => 'string', 'example' => 'test', ], 'CreatorName' => [ 'description' => '创建者姓名', 'type' => 'string', 'example' => 'system', ], 'Size' => [ 'description' => '大小。', 'type' => 'string', 'example' => '47045632', ], 'LastModifyTime' => [ 'description' => '最近更新时间。', 'type' => 'string', 'example' => '20250911 00:00:00', ], 'EnableQuickindexTime' => [ 'description' => '启用加速时间。', 'type' => 'string', 'example' => '20250911 00:00:00', ], 'JobId' => [ 'description' => '加速任务ID。', 'type' => 'string', 'example' => 'b30b74**********b3b', ], 'JobStatus' => [ 'description' => '状态：'."\n" ."\n" .'- 0-待运行'."\n" .'- 1-运行中'."\n" .'- 2-正常结束'."\n" .'- 3-异常结束'."\n" .'- 4-取消'."\n" .'- 5-警告', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'JobHistoryId' => [ 'description' => '任务历史ID。', 'type' => 'string', 'example' => 'QWDAASG*******8SAD', ], ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '该空间不在组织内。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '获取空间下加速引擎管控页任务信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E****************05DF8D885\\",\\n \\"Result\\": {\\n \\"TotalPages\\": 1,\\n \\"TotalNum\\": 18,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Pre\\": 0,\\n \\"Next\\": 0,\\n \\"Data\\": [\\n {\\n \\"CubeId\\": \\"d14e*********fef8de29fd\\",\\n \\"CubeName\\": \\"test\\",\\n \\"CreatorName\\": \\"system\\",\\n \\"Size\\": \\"47045632\\",\\n \\"LastModifyTime\\": \\"20250911 00:00:00\\",\\n \\"EnableQuickindexTime\\": \\"20250911 00:00:00\\",\\n \\"JobId\\": \\"b30b74**********b3b\\",\\n \\"JobStatus\\": 0,\\n \\"JobHistoryId\\": \\"QWDAASG*******8SAD\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ListApiDatasource' => [ 'summary' => '查询API数据源列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89713491-cb4f-4579-b889-e82c35f1****', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => 'API数据源列表的当前页码：'."\n" ."\n" .'- 起始值：1'."\n" .'- 默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的每页行数：'."\n" ."\n" .'- 默认值：10'."\n" .'- 最大值：100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => [ 'description' => 'API数据源名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回查询结果。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '查询到的API数据源列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiId' => [ 'description' => 'API数据源的ID。', 'type' => 'string', 'example' => '0f2c3c6409be4dc0810f2a5785e816a8', ], 'Body' => [ 'description' => 'JSON格式的查询语句参数配置，用户可以自行定义。', 'type' => 'string', 'example' => '{"key1":"value1"}', ], 'DataSize' => [ 'description' => 'API数据源的数据量。'."\n" .'- 单位：KB', 'type' => 'number', 'format' => 'float', 'example' => '0.39746094', ], 'DateUpdateTime' => [ 'description' => 'API数据源最后同步时间。', 'type' => 'string', 'example' => '2022-05-25 16:19:43', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-05-25 16:19:43', ], 'GmtModified' => [ 'description' => '修改时间。', 'type' => 'string', 'example' => '2022-05-25 16:19:43', ], 'JobId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => 'REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8', ], 'Parameters' => [ 'description' => 'JSONArray格式的参数配置。'."\n" .'- name：参数名称'."\n" .'- value：参数值', 'type' => 'string', 'example' => '[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]', ], 'ShowName' => [ 'description' => 'API数据源的名称。', 'type' => 'string', 'example' => '测试数据源', ], 'StatusType' => [ 'description' => 'API数据源同步任务状态。', 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ '待运行', '运行中', '成功', '失败', ], 'example' => '2', ], ], ], ], 'PageNum' => [ 'description' => '请求获取的数据页码数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"ApiId\\": \\"0f2c3c6409be4dc0810f2a5785e816a8\\",\\n \\"Body\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}\\",\\n \\"DataSize\\": 0.39746094,\\n \\"DateUpdateTime\\": \\"2022-05-25 16:19:43\\",\\n \\"GmtCreate\\": \\"2022-05-25 16:19:43\\",\\n \\"GmtModified\\": \\"2022-05-25 16:19:43\\",\\n \\"JobId\\": \\"REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8\\",\\n \\"Parameters\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"token\\\\\\",\\\\\\"value\\\\\\":\\\\\\"xxxxxxxxxxxx\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"pageSize\\\\\\",\\\\\\"value\\\\\\":100}]\\",\\n \\"ShowName\\": \\"测试数据源\\",\\n \\"StatusType\\": 2\\n }\\n ],\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询API数据源列表', 'description' => '具体的参数说明详见[创建API数据源。](~~409330~~)', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApiDatasource', ], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListApiDatasource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListByUserGroupId' => [ 'summary' => '根据用户组ID批量查询用户组信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserGroupIds', 'in' => 'query', 'schema' => [ 'description' => '要查询的用户组ID，批量查询时用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '34fe-***-6dcb,84q9-****-4a274', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '返回用户组查询结果。', 'type' => 'object', 'properties' => [ 'FailedUserGroupIds' => [ 'type' => 'array', 'items' => [ 'description' => '查询失败的用户组ID。', 'type' => 'string', 'example' => '[]', ], ], 'UserGroupModels' => [ 'description' => '查询到的用户组详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-03-15 17:13:55', ], 'CreateUser' => [ 'description' => '创建者在Quick BI的UserID。', 'type' => 'string', 'example' => '46e5*******ee22e2a292704c8', ], 'IdentifiedPath' => [ 'description' => '用户组路径。', 'type' => 'string', 'example' => '2fe4fbd8-****-af083ea/34fd1-****-dcbc33f', ], 'ModifiedTime' => [ 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-03-15 20:36:40', ], 'ModifyUser' => [ 'description' => '修改者在Quick BI的UserID。', 'type' => 'string', 'example' => '46e5*******ee22e2a292704c8', ], 'ParentUsergroupId' => [ 'description' => '上级用户组的ID。', 'type' => 'string', 'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af083ea', ], 'UsergroupDesc' => [ 'description' => '用户组描述信息。', 'type' => 'string', 'example' => '描述信息', ], 'UsergroupId' => [ 'description' => '用户组ID。', 'type' => 'string', 'example' => '34fd141d-****-4093-8c33-8e066dcbc33f', ], 'UsergroupName' => [ 'description' => '用户组名称。', 'type' => 'string', 'example' => '测试用户组', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Usergroup.Not.Exist', 'errorMessage' => 'The user group does not exist.', 'description' => '用户组不存在。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": {\\n \\"FailedUserGroupIds\\": [\\n \\"[]\\"\\n ],\\n \\"UserGroupModels\\": [\\n {\\n \\"CreateTime\\": \\"2021-03-15 17:13:55\\",\\n \\"CreateUser\\": \\"46e5*******ee22e2a292704c8\\",\\n \\"IdentifiedPath\\": \\"2fe4fbd8-****-af083ea/34fd1-****-dcbc33f\\",\\n \\"ModifiedTime\\": \\"2021-03-15 20:36:40\\",\\n \\"ModifyUser\\": \\"46e5*******ee22e2a292704c8\\",\\n \\"ParentUsergroupId\\": \\"2fe4fbd8-588f-489a-b3e1-e92c7af083ea\\",\\n \\"UsergroupDesc\\": \\"描述信息\\",\\n \\"UsergroupId\\": \\"34fd141d-****-4093-8c33-8e066dcbc33f\\",\\n \\"UsergroupName\\": \\"测试用户组\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n \\n \\n 2fe4fbd8-****-af083ea/34fd1-****-dcbc33f\\n 2fe4fbd8-588f-489a-b3e1-e92c7af083ea\\n 2021-03-15 20:36:40\\n 46e5*******ee22e2a292704c8\\n 测试用户组\\n 2021-03-15 17:13:55\\n 描述信息\\n 34fd141d-****-4093-8c33-8e066dcbc33f\\n 46e5*******ee22e2a292704c8\\n \\n []\\n \\n","errorExample":""}]', 'title' => '批量查询用户组', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListByUserGroupId', ], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListByUserGroupId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListCollections' => [ 'summary' => '获取用户收藏的作品列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fe67f61a35a94b7da1a34ba174a7****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '收藏记录的主键 ID。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '162A632E-0A88-51CF-98F8-94FDEE82DB7D', ], 'Result' => [ 'description' => '用户收藏的报表列表详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FavoriteId' => [ 'description' => '收藏记录的主键 ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '12373', ], 'OwnerId' => [ 'description' => '作品所有者的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'example' => 'fe67f61a35a94b7da1a34ba174a7****', ], 'WorksId' => [ 'description' => '作品的ID。', 'type' => 'string', 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], 'WorksName' => [ 'description' => '作品的名称。', 'type' => 'string', 'example' => '奇异博士', ], 'WorksType' => [ 'description' => '作品类型。取值范围：'."\n" ."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格'."\n" .'- dataForm：数据填报'."\n" .'- dashboardOfflineQuery：自助取数', 'type' => 'string', 'example' => 'dashboardOfflineQuery', ], 'WorkspaceId' => [ 'description' => '工作空间ID。', 'type' => 'string', 'example' => '9337d121-a78f-4c1b-a8bc-f81de117****', ], 'WorkspaceName' => [ 'description' => '工作空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"162A632E-0A88-51CF-98F8-94FDEE82DB7D\\",\\n \\"Result\\": [\\n {\\n \\"FavoriteId\\": 12373,\\n \\"OwnerId\\": \\"fe67f61a35a94b7da1a34ba174a7****\\",\\n \\"WorksId\\": \\"95296e95-ca89-4c7d-8af9-dedf0ad0****\\",\\n \\"WorksName\\": \\"奇异博士\\",\\n \\"WorksType\\": \\"dashboardOfflineQuery\\",\\n \\"WorkspaceId\\": \\"9337d121-a78f-4c1b-a8bc-f81de117****\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 162A632E-0A88-51CF-98F8-94FDEE82DB7D\\n \\n 9337d121-a78f-4c1b-a8bc-f81de117****\\n dashboardOfflineQuery\\n 12373\\n 95296e95-ca89-4c7d-8af9-dedf0ad0****\\n 奇异博士\\n 测试工作空间\\n fe67f61a35a94b7da1a34ba174a7****\\n \\n","errorExample":""}]', 'title' => '获取用户收藏作品列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListCollections', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListCubeDataLevelPermissionConfig' => [ 'summary' => '获取指定数据集的行列权限配置列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-****-3c744528014b', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => '数据集行列权限类型。取值范围：'."\n" ."\n" .'- ROW_LEVEL：行级权限'."\n" .'- COLUMN_LEVEL：列级权限', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ROW_LEVEL', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '{'."\n" .' "isOpen": 1,'."\n" .' "extraConfigModel": { // 额外配置信息'."\n" .' "ruleType": "ROW_LEVEL", //行级权限类型'."\n" .' "missHitPolicy": "NONE", //命中规则策略：NONE无权限，ALL有权限'."\n" .' "cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" //数据集ID'."\n" .' },'."\n" .' "ruleType": "ROW_LEVEL", //行列权限类型 '."\n" .' "ruleModels": ['."\n" .' {'."\n" .' "ruleUsersModel": { // 针对的人群'."\n" .' "userGroups": ['."\n" .' "0d5fb19b-****-1248fc27ca51", // 用户组ID'."\n" .' "4aa3f089-****-85f0-0e8ac7c2dee9"'."\n" .' ],'."\n" .' "users": ['."\n" .' "HuangJia***2e3fa822", // 用户的UserID'."\n" .' "4334***84358"'."\n" .' ]'."\n" .' },'."\n" .' "ruleContentModel": {'."\n" .' "ruleContentType": "ROW_FIELD", //行列权限类型'."\n" .' "ruleContentJson": "{\\"conditionNode\\":{\\"caption\\":\\"周期\\",\\"isMeasure\\":false,\\"pathId\\":\\"7d3b073bc6\\",\\"relationOperator\\":\\"not-null\\",\\"name\\":\\"7d3b073bc6\\",\\"value\\":{\\"value\\":[\\"\\"],\\"valueType\\":\\"ENUM\\"}}}", //行列权限规则的JSON串'."\n" .' "ruleOriginConfigJson": "{\\"operator\\":\\"and\\",\\"operands\\":[{\\"labelName\\":\\"周期\\",\\"isValid\\":true,\\"uniqueId\\":\\"5\\",\\"fieldId\\":\\"7d3b073bc6\\",\\"error\\":false,\\"fieldType\\":\\"string\\",\\"defaultValue\\":{\\"selectType\\":\\"condition\\",\\"value\\":{\\"conditionOp\\":\\"not-null\\",\\"conditionValue\\":\\"\\"},\\"valueType\\":\\"ENUM\\"}}],\\"isRelation\\":true}"'."\n" .' }, //前端需求的固定格式JSON串'."\n" .' "isOpen": 1, // 行列权限配置的开关状态 1.开启 0.关闭'."\n" .' "hitTakeEffect": 1, // 针对列级权限，命中后规则是否生效 1生效、0不生效。'."\n" .' "ruleName": "测试行级权限_勿删", // 行列权限规则的名称'."\n" .' "ruleLevelType": "ROW_LEVEL", //行列权限类型'."\n" .' "ruleId": "a5bb24da-772f-45e8-a43c-a891683e14da", // 行列权限规则的ID'."\n" .' "cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b", // 数据集ID'."\n" .' "ruleTargetScope": "OTHERS" 规则生效范围：ALL所有人、OTHERS指定人'."\n" .' }'."\n" .' ],'."\n" .' "cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" // 数据集ID'."\n" .'}', 'type' => 'string', 'example' => '行列权限列表的JSON串，详情见描述。', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '数据集不存在。', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '没有权限使用新版行列权限。', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '对应的行级权限开关必须打开。', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '行级权限规则不存在：%s。', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '行级权限规则不属于当前数据集。', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '数据集模型不属于当前组织。', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": \\"行列权限列表的JSON串，详情见描述。\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n 行列权限列表的JSON串，详情见描述。\\n true\\n","errorExample":""}]', 'title' => '获取数据集行列权限配置列表', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:57.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCubeDataLevelPermissionConfig', ], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListCubeDataLevelPermissionConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListDataLevelPermissionWhiteList' => [ 'summary' => '根据行列权限种类，获取数据集行列权限的白名单列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3d5db23c-e4f2-49dd-a883-92285b48e14a', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => '白名单所属的行列权限类型：'."\n" ."\n" .'- ROW_LEVEL：行级权限'."\n" .'- COLUMN_LEVEL：列级权限', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ROW_LEVEL', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '指定行级权限类型的白名单列表。', 'type' => 'object', 'properties' => [ 'CubeId' => [ 'description' => '数据集ID。', 'type' => 'string', 'example' => '7c7223ae-****-3c744528014b', ], 'RuleType' => [ 'description' => '数据集行列权限类型。取值范围：'."\n" ."\n" .'- ROW_LEVEL：行级权限'."\n" .'- COLUMN_LEVEL：列级权限', 'type' => 'string', 'example' => 'ROW_LEVEL', ], 'UsersModel' => [ 'description' => '白名单信息。', 'type' => 'object', 'properties' => [ 'UserGroups' => [ 'type' => 'array', 'items' => [ 'description' => '用户组ID。', 'type' => 'string', 'example' => '0d5fb19b-***-1248fc27ca51', ], ], 'Users' => [ 'type' => 'array', 'items' => [ 'description' => 'Quick BI用户的UserID。', 'type' => 'string', 'example' => '4334***358', ], ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '', ], [ 'errorCode' => 'CubePermission.Columnlevel.VersionError', 'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.SwitchClose.Error', 'errorMessage' => 'The row level permission switch must be on.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotExsist', 'errorMessage' => 'The row level permission rule does not exist: %s.', 'description' => '', ], [ 'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube', 'errorMessage' => 'The row level permission rule does not belong to the current cube.', 'description' => '', ], [ 'errorCode' => 'Cube.NotBelongTo.CurrentOrganization', 'errorMessage' => 'The cube does not belong to the current organization %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": {\\n \\"CubeId\\": \\"7c7223ae-****-3c744528014b\\",\\n \\"RuleType\\": \\"ROW_LEVEL\\",\\n \\"UsersModel\\": {\\n \\"UserGroups\\": [\\n \\"0d5fb19b-***-1248fc27ca51\\"\\n ],\\n \\"Users\\": [\\n \\"4334***358\\"\\n ]\\n }\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n \\n 7c7223ae-****-3c744528014b\\n ROW_LEVEL\\n \\n 0d5fb19b-***-1248fc27ca51\\n 4334***358\\n \\n \\n","errorExample":""}]', 'title' => '获取数据集行列权限白名单列表', 'description' => '>：当前接口仅支持Quick BI新版行列权限模型。若您仍在使用老的行列权限，请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤：在组织管理-->安全配置-->行列权限升级新版中，单击**一键升级**，升级至新版行级权限。', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListDataLevelPermissionWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListDataSource' => [ 'summary' => '查询指定空间下的所有数据源。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '95296e95-******c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'DsType', 'in' => 'query', 'schema' => [ 'description' => '数据源类型。', 'type' => 'string', 'required' => false, 'example' => 'mysql', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '7FC9A6A6-****-5CED-B*****E891E4075', ], 'Result' => [ 'title' => '数据源信息数组', 'description' => '数据源信息数组。', 'type' => 'array', 'items' => [ 'title' => '数据源信息', 'description' => '数据源信息。', 'type' => 'object', 'properties' => [ 'CreatorId' => [ 'title' => '创建人的Quick BI用户ID。', 'description' => '创建人的Quick BI用户ID。', 'type' => 'string', 'example' => '281*****-485******-8', ], 'CreatorName' => [ 'title' => '所有者昵称', 'description' => '所有者昵称。', 'type' => 'string', 'example' => 'system', ], 'DatasourceId' => [ 'title' => '数据源的id', 'description' => '数据源ID。', 'type' => 'string', 'example' => '7FC9A6A6-****-5CED-B*****E891E4075', ], 'GmtCreate' => [ 'title' => '数据源创建时间，yyyy-MM-dd HH:mm:ss', 'description' => '数据源创建时间，yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'example' => '2024-04-16 13:17:39', ], 'GmtModified' => [ 'title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2024-08-15 10:06:31', ], 'ShowName' => [ 'title' => '数据源展示名称', 'description' => '数据源展示名称。', 'type' => 'string', 'example' => '0327', ], 'DsType' => [ 'title' => '数据源类型', 'description' => '数据源类型。', 'type' => 'string', 'example' => 'odps', ], 'ParentDsType' => [ 'title' => '多引擎数据源的主数据源类型', 'description' => '多引擎数据源的主数据源类型。', 'type' => 'string', 'example' => 'dataphin', ], ], ], ], 'Success' => [ 'title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'Workspace.Operation.LackRole', 'errorMessage' => 'Only the %s role can perform this operation. Contact the administrator to add this role.', 'description' => '', ], [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '', ], [ 'errorCode' => 'Invalid.Param.Error', 'errorMessage' => 'The parameter is invalid.', 'description' => '', ], [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'An error occurred while verifying parameters.', 'description' => '', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '', ], [ 'errorCode' => 'Parameter.Length.Exceed', 'errorMessage' => 'Parameter length exceeds maximum limit: [%s].', 'description' => '', ], [ 'errorCode' => 'Parameter.Error', 'errorMessage' => 'The input parameter is invalid.', 'description' => '', ], [ 'errorCode' => 'User.Not.In.Organization', 'errorMessage' => 'The specified user is not in the organizational unit.', 'description' => '', ], [ 'errorCode' => 'Invalid.User.Admin', 'errorMessage' => 'You are not an administrator of this organization.', 'description' => '', ], [ 'errorCode' => 'Invalid.Organization', 'errorMessage' => 'The specified organizational unit does not exist.', 'description' => '', ], [ 'errorCode' => 'Invalid.User.Organization', 'errorMessage' => 'The user is not in your organization.', 'description' => '', ], [ 'errorCode' => 'System.Param.Empty', 'errorMessage' => 'You must specify the %s parameter.', 'description' => '', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not in this workspace.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FC9A6A6-****-5CED-B*****E891E4075\\",\\n \\"Result\\": [\\n {\\n \\"CreatorId\\": \\"281*****-485******-8\\",\\n \\"CreatorName\\": \\"system\\",\\n \\"DatasourceId\\": \\"7FC9A6A6-****-5CED-B*****E891E4075\\",\\n \\"GmtCreate\\": \\"2024-04-16 13:17:39\\",\\n \\"GmtModified\\": \\"2024-08-15 10:06:31\\",\\n \\"ShowName\\": \\"0327\\",\\n \\"DsType\\": \\"odps\\",\\n \\"ParentDsType\\": \\"dataphin\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询指定空间下的所有数据源', 'requestParamsDescription' => '数据源类型码值：'."\n" .'- garuda -- garuda数据源'."\n" .'- adb -- ADB 3.0'."\n" .'- oracle -- oracle数据源'."\n" .'- mysql -- mysql数据源'."\n" .'- mysql_hybrid -- HybridDB for MySQL数据源'."\n" .'- odps -- odps数据源'."\n" .'- sqlserver -- sqlserver数据源'."\n" .'- greenplum -- greenplum数据源'."\n" .'- postgresql -- postgresql数据源'."\n" .'- ppas -- RDS PPAS数据源'."\n" .'- oscar -- 神通数据源'."\n" .'- hive -- Hive 数据源'."\n" .'- vertica -- Vertica 数据源'."\n" .'- db2 -- IBM DB2数据源(LUW)'."\n" .'- sybase -- SAP SYBASE IQ 数据源'."\n" .'- hana -- SAP HANA 数据源'."\n" .'- dla -- DataLake Analytics 数据源'."\n" .'- oss -- OSS 数据源'."\n" .'- drds -- DRDS 数据源'."\n" .'- clivia -- super-engine'."\n" .'- presto -- presto数据源'."\n" .'- polardb -- polardb数据源'."\n" .'- tsdb -- TSDB数据源'."\n" .'- lindorm_tsdb -- LindormTSDB数据源'."\n" .'- lindorm_wide_table_engine -- Lindorm宽表引擎数据源'."\n" .'- lindorm_multi_mode -- Lindorm多模SQL数据源'."\n" .'- hbase -- HBASE数据源'."\n" .'- phoenix_thin -- PHOENIX THIN 数据源'."\n" .'- dataphin -- DataPhin数据源-多引擎'."\n" .'- dataphin_odps -- DataPhin数据源odps引擎'."\n" .'- dataphin_hive -- DataPhin数据源hive引擎'."\n" .'- dataphin_v2_odps -- 新DataPhin数据源odps引擎'."\n" .'- dataphin_v2_hive -- 新DataPhin数据源hive引擎'."\n" .'- kbase -- KingBase数据源'."\n" .'- clickhouse -- ClickHouse数据源'."\n" .'- tdsql -- TDSQL-H数据源'."\n" .'- gbase -- Gbase数据源'."\n" .'- polardb_pg -- Polardb for pg数据源'."\n" .'- hologres -- Hologres数据源'."\n" .'- impala -- impala 数据源'."\n" .'- impala_v3 -- impala3.x数据源'."\n" .'- dingtalk -- 钉钉智能报表数据源'."\n" .'- snowflake -- snowflake数据源'."\n" .'- kylin -- kylin数据源'."\n" .'- multiDatasource -- 跨源'."\n" .'- oceanbase_mysql -- OceanBase_mysql模式数据源'."\n" .'- oceanbase_oracle -- OceanBase_Oracle模式数据源'."\n" .'- spark_sql -- Spark_SQL数据源'."\n" .'- starrocks -- StarRocks数据源'."\n" .'- apache_doris -- Apache_Doris数据源'."\n" .'- selectdb -- SelectDB数据源'."\n" .'- mongodb -- MongoDB数据源'."\n" .'- dm -- DM7数据源-达梦'."\n" .'- unicorn -- Unicorn数据源'."\n" .'- sls -- sls数据源'."\n" .'- gaussdb_dws -- GaussDB_DWS数据源'."\n" .'- gaussdb -- GaussDB数据源'."\n" .'- elasticsearch -- Elasticsearch'."\n" .'- dms -- DMS逻辑数仓'."\n" .'- yida -- 宜搭应用数据源'."\n" .'- relyt -- Relyt'."\n" .'- feishu_bitable -- 飞书多维表格'."\n" .'- feishu_spreadsheet -- 飞书电子表格'."\n" .'- tidb -- TiDB数据源'."\n" .'- mariadb -- MariaDB数据源'."\n" .'- adb_spark -- adb数据源Spark引擎', 'changeSet' => [ [ 'createdAt' => '2025-08-11T03:10:11.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListFavoriteReports' => [ 'summary' => '获取指定用户在首页看板中展示的收藏作品列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '要查询用户在Quick BI中的UserID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b5d8fd9348cc4327****afb604', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '作品名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '财务报表', ], ], [ 'name' => 'TreeType', 'in' => 'query', 'schema' => [ 'description' => '查询作品的类型（填空查询所有类型）。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PAGE', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '查询作品列表的行数：'."\n" .'默认值：10'."\n" .'最大值：9999', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回查询结果。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '查询到的作品列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Favorite' => [ 'description' => '查询用户是否收藏了该作品。'."\n", 'type' => 'boolean', 'example' => 'true', ], 'FavoriteDate' => [ 'description' => '作品收藏时间戳', 'type' => 'string', 'example' => '1640088615000', ], 'GmtCreate' => [ 'description' => '作品创建时间戳。', 'type' => 'string', 'example' => '1640088615000', ], 'GmtModified' => [ 'description' => '作品修改的时间戳。', 'type' => 'string', 'example' => '1640595729000', ], 'HasEditAuth' => [ 'description' => '查询用户是拥有作品的编辑权限。', 'type' => 'boolean', 'example' => 'true', ], 'HasViewAuth' => [ 'description' => '查询用户是拥有作品的查看权限。', 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'description' => '作品名称。', 'type' => 'string', 'example' => '测试报表', ], 'OwnerName' => [ 'description' => '作品所有者的阿里云账号名。', 'type' => 'string', 'example' => 'luyaotest的昵称非管理员', ], 'OwnerNum' => [ 'description' => '作品所有者的UserID。', 'type' => 'string', 'example' => '1365*****238860', ], 'PublishStatus' => [ 'description' => '作品的发布状态。取值范围：'."\n" ."\n" .'- 0：未发布'."\n" .'- 1：已发布'."\n" .'- 2：已修改保存未发布'."\n" .'- 3：已下线', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TreeId' => [ 'description' => '作品ID。', 'type' => 'string', 'example' => '977c7698-****-****-****-44b7304d20fc', ], 'Type' => [ 'description' => '作品类型。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'example' => 'PAGE', ], 'WorkspaceId' => [ 'description' => '作品所属的工作空间ID。', 'type' => 'string', 'example' => '523793cb-****-****-****-aa71c65ffa39', ], 'WorkspaceName' => [ 'description' => '作品所属的工作空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => ' '."\n" .'请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"Favorite\\": true,\\n \\"FavoriteDate\\": \\"1640088615000\\",\\n \\"GmtCreate\\": \\"1640088615000\\",\\n \\"GmtModified\\": \\"1640595729000\\",\\n \\"HasEditAuth\\": true,\\n \\"HasViewAuth\\": true,\\n \\"Name\\": \\"测试报表\\",\\n \\"OwnerName\\": \\"luyaotest的昵称非管理员\\",\\n \\"OwnerNum\\": \\"1365*****238860\\",\\n \\"PublishStatus\\": 1,\\n \\"TreeId\\": \\"977c7698-****-****-****-44b7304d20fc\\",\\n \\"Type\\": \\"PAGE\\",\\n \\"WorkspaceId\\": \\"523793cb-****-****-****-aa71c65ffa39\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ],\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n \\n 1\\n 1\\n 1\\n 10\\n \\n 977c7698-****-****-****-44b7304d20fc\\n PAGE\\n 测试报表\\n 1365*****238860\\n luyaotest的昵称非管理员\\n 1640088615000\\n 1640595729000\\n 1\\n true\\n true\\n true\\n 523793cb-****-****-****-aa71c65ffa39\\n 测试工作空间\\n \\n \\n true\\n","errorExample":""}]', 'title' => '首页看板收藏列表', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListFavoriteReports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListOrganizationRoleUsers' => [ 'summary' => '获取指定组织角色下的用户列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'RoleId', 'in' => 'query', 'schema' => [ 'description' => '组织角色ID，包括预置角色和自定义角色：'."\n" ."\n" .'- 组织管理员（预置角色）：111111111'."\n" .'- 权限管理员（预置角色）：111111112'."\n" .'- 普通用户（预置角色）：111111113'."\n" .'- 自定义角色：自定义角色对应的角色ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '111111111', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '页码。'."\n" ."\n" .'- 默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页行数。'."\n" .'- 默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '组织成员昵称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '小刘', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BCE45E6D-9304-4F94-86BB-5A772B1615FF', ], 'Result' => [ 'description' => '返回组织角色下的用户列表。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '用户列表。', 'type' => 'array', 'items' => [ 'description' => '用户详情。', 'type' => 'object', 'properties' => [ 'NickName' => [ 'description' => '组织成员的昵称。', 'type' => 'string', 'example' => '测试用户', ], 'UserId' => [ 'description' => '组织成员在Quick BI的UserID。', 'type' => 'string', 'example' => 'b5d8fd9348cc4327****afb604', ], ], ], ], 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'User.Role.NotExist', 'errorMessage' => 'User role not exist: %s.', 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCE45E6D-9304-4F94-86BB-5A772B1615FF\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"NickName\\": \\"测试用户\\",\\n \\"UserId\\": \\"b5d8fd9348cc4327****afb604\\"\\n }\\n ],\\n \\"PageNum\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalNum\\": 10,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取指定组织角色下的用户列表', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListOrganizationRoleUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListOrganizationRoles' => [ 'summary' => '获取组织角色列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7AAB95D7-2E11-4FE2-94BC-858E4FC0C976', ], 'Result' => [ 'description' => '返回组织角色列表。', 'type' => 'array', 'items' => [ 'description' => '角色配置详情。', 'type' => 'object', 'properties' => [ 'AuthConfigList' => [ 'description' => '角色的权限配置列表。', 'type' => 'array', 'items' => [ 'description' => '具体的权限配置。', 'type' => 'object', 'properties' => [ 'AuthKey' => [ 'description' => '权限类型：'."\n" .'- quick_monitor：指标监控'."\n" .'- subscription：订阅管理'."\n" .'- offline_download：自助取数'."\n" .'- resource_package：资源包管理'."\n" .'- organization_ask：组织识别码（AK/SK）'."\n" .'- developer_openapi：开放API'."\n" .'- data_service：数据服务'."\n" .'- admin_authorize3rd：嵌入分析'."\n" .'- component_manage：自定义组件'."\n" .'- template_open：自定义模版'."\n" .'- custom_driver：自定义驱动（仅独立部署支持）'."\n" .'- open_platform_custom_plugin：自定义插件（仅独立部署支持）'."\n" .'- enterprise_safety：企业安全', 'type' => 'string', 'example' => 'enterprise_safety', ], ], ], ], 'IsSystemRole' => [ 'description' => '是否是预置角色。取值范围：'."\n" ."\n" .'- true：是'."\n" .'- false：否', 'type' => 'boolean', 'example' => 'true', ], 'RoleId' => [ 'description' => '角色ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111', ], 'RoleName' => [ 'description' => '角色名称。', 'type' => 'string', 'example' => '组织管理员', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7AAB95D7-2E11-4FE2-94BC-858E4FC0C976\\",\\n \\"Result\\": [\\n {\\n \\"AuthConfigList\\": [\\n {\\n \\"AuthKey\\": \\"enterprise_safety\\"\\n }\\n ],\\n \\"IsSystemRole\\": true,\\n \\"RoleId\\": 111111111,\\n \\"RoleName\\": \\"组织管理员\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取组织角色列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListOrganizationRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListPortalMenuAuthorization' => [ 'summary' => '获取数据门户菜单的授权详情列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataPortalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d173abb53e84c8ca7495429163b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '门户菜单的授权详情列表。', 'type' => 'array', 'items' => [ 'description' => '门户菜单的授权详情列表。', 'type' => 'object', 'properties' => [ 'MenuId' => [ 'description' => '数据门户的叶子节点菜单ID。', 'type' => 'string', 'example' => '54kqgoa****', ], 'Receivers' => [ 'description' => '菜单所授权的对象详情。', 'type' => 'array', 'items' => [ 'description' => '菜单所授权的对象详情。', 'type' => 'object', 'properties' => [ 'ReceiverId' => [ 'description' => '授权对象ID。'."\n" .'> '."\n" .'> - 授权对象类型为组织时，该ID对应组织ID'."\n" .'> - 授权对象类型为空间时，该ID对应空间ID', 'type' => 'string', 'example' => '121344444790****', ], 'ReceiverType' => [ 'description' => '授权对象类型。取值范围：'."\n" ."\n" .'- 0：用户'."\n" .'- 1：用户组'."\n" .'- 2：组织'."\n" .'- 3：空间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AuthPointsValue' => [ 'description' => '菜单授权类型。取值范围：'."\n" ."\n" .'- 1：查看'."\n" .'- 11：编辑'."\n" .'- 3：导出和查看'."\n" .'- 10 ：管理填报数据', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], ], 'ShowOnlyWithAccess' => [ 'title' => '菜单授权类型。取值范围：'."\n" .'● 1：查看'."\n" .'● 11：编辑'."\n" .'● 3：导出和查看', 'description' => '是否仅授权可见。取值范围：'."\n" ."\n" .'- true：仅授权可见'."\n" .'- false：都可见', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": [\\n {\\n \\"MenuId\\": \\"54kqgoa****\\",\\n \\"Receivers\\": [\\n {\\n \\"ReceiverId\\": \\"121344444790****\\",\\n \\"ReceiverType\\": 0,\\n \\"AuthPointsValue\\": 1\\n }\\n ],\\n \\"ShowOnlyWithAccess\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\n \\n true\\n 54kqgoa****\\n \\n 121344444790****\\n 0\\n \\n \\n","errorExample":""}]', 'title' => '获取数据门户菜单的授权详情', 'changeSet' => [ [ 'createdAt' => '2025-08-11T03:10:11.000Z', 'description' => '响应参数发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListPortalMenuAuthorization', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListPortalMenus' => [ 'summary' => '获取具体数据门户下的分层菜单列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'DataPortalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0d173abb53e84c8ca7495429163b****', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI中的用户ID。传入时列表仅展示用户有权限的菜单。', 'type' => 'string', 'required' => false, 'example' => '1234567***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '75912036-5527-4B7E-9265-B481D6651AC2', ], 'Result' => [ 'description' => '分级门户菜单列表详情的JSON字符串。取值范围：'."\n" ."\n" .'- menuType：菜单类型。'."\n" .' - 0：仪表板'."\n" .' - 1：外链'."\n" .' - 2：电子表格'."\n" .' - 4：目录文件夹'."\n" .' - 5：表单填报'."\n" .' - 6：自助取数'."\n" .'- menuId：菜单ID'."\n" .'- uri： 菜单关联资源的ID或者URL'."\n" .'- showOnlyWithAccess：是否仅授权可见'."\n" .'- menuName：菜单显示名称'."\n" .'- dependentPermisson：菜单关联的报表资源是否有权限'."\n" .'- children：子菜单', 'type' => 'string', 'example' => '[{"children":[{"children":[{"children":[{"menuId":"54kqgoa****","menuName":"报表菜单","menuType":0,"showOnlyWithAccess":true,"dependentPermisson":false,"uri":"e5da4a3f-d7f9-4262-a39e-a840043c****"},{"menuId":"pg1n135****","menuName":"目录菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"23a7d5d8-e55a-4737-b6a1-3c585505****","menuName":"pop三级菜单","menuType":4,"showOnlyWithAccess":true,"dependentPermisson":true}],"menuId":"80764f3c-affd-45a1-aaa1-bb039d8a****","menuName":"pop二级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"277f968a-22ff-4ce6-83f0-a82950f4****","menuName":"pop一级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}]', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75912036-5527-4B7E-9265-B481D6651AC2\\",\\n \\"Result\\": \\"[{\\\\\\"children\\\\\\":[{\\\\\\"children\\\\\\":[{\\\\\\"children\\\\\\":[{\\\\\\"menuId\\\\\\":\\\\\\"54kqgoa****\\\\\\",\\\\\\"menuName\\\\\\":\\\\\\"报表菜单\\\\\\",\\\\\\"menuType\\\\\\":0,\\\\\\"showOnlyWithAccess\\\\\\":true,\\\\\\"dependentPermisson\\\\\\":false,\\\\\\"uri\\\\\\":\\\\\\"e5da4a3f-d7f9-4262-a39e-a840043c****\\\\\\"},{\\\\\\"menuId\\\\\\":\\\\\\"pg1n135****\\\\\\",\\\\\\"menuName\\\\\\":\\\\\\"目录菜单\\\\\\",\\\\\\"menuType\\\\\\":4,\\\\\\"showOnlyWithAccess\\\\\\":false,\\\\\\"dependentPermisson\\\\\\":true}],\\\\\\"menuId\\\\\\":\\\\\\"23a7d5d8-e55a-4737-b6a1-3c585505****\\\\\\",\\\\\\"menuName\\\\\\":\\\\\\"pop三级菜单\\\\\\",\\\\\\"menuType\\\\\\":4,\\\\\\"showOnlyWithAccess\\\\\\":true,\\\\\\"dependentPermisson\\\\\\":true}],\\\\\\"menuId\\\\\\":\\\\\\"80764f3c-affd-45a1-aaa1-bb039d8a****\\\\\\",\\\\\\"menuName\\\\\\":\\\\\\"pop二级菜单\\\\\\",\\\\\\"menuType\\\\\\":4,\\\\\\"showOnlyWithAccess\\\\\\":false,\\\\\\"dependentPermisson\\\\\\":true}],\\\\\\"menuId\\\\\\":\\\\\\"277f968a-22ff-4ce6-83f0-a82950f4****\\\\\\",\\\\\\"menuName\\\\\\":\\\\\\"pop一级菜单\\\\\\",\\\\\\"menuType\\\\\\":4,\\\\\\"showOnlyWithAccess\\\\\\":false,\\\\\\"dependentPermisson\\\\\\":true}]\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 75912036-5527-4B7E-9265-B481D6651AC2\\n [{\\"children\\":[{\\"children\\":[{\\"children\\":[{\\"menuId\\":\\"54kqgoa****\\",\\"menuName\\":\\"报表菜单\\",\\"menuType\\":0,\\"showOnlyWithAccess\\":true,\\"dependentPermisson\\":false,\\"uri\\":\\"e5da4a3f-d7f9-4262-a39e-a840043c****\\"},{\\"menuId\\":\\"pg1n135****\\",\\"menuName\\":\\"目录菜单\\",\\"menuType\\":4,\\"showOnlyWithAccess\\":false,\\"dependentPermisson\\":true}],\\"menuId\\":\\"23a7d5d8-e55a-4737-b6a1-3c585505****\\",\\"menuName\\":\\"pop三级菜单\\",\\"menuType\\":4,\\"showOnlyWithAccess\\":true,\\"dependentPermisson\\":true}],\\"menuId\\":\\"80764f3c-affd-45a1-aaa1-bb039d8a****\\",\\"menuName\\":\\"pop二级菜单\\",\\"menuType\\":4,\\"showOnlyWithAccess\\":false,\\"dependentPermisson\\":true}],\\"menuId\\":\\"277f968a-22ff-4ce6-83f0-a82950f4****\\",\\"menuName\\":\\"pop一级菜单\\",\\"menuType\\":4,\\"showOnlyWithAccess\\":false,\\"dependentPermisson\\":true}]\\n true\\n","errorExample":""}]', 'title' => '获取数据门户菜单列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:31.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListPortalMenus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListRecentViewReports' => [ 'summary' => '获取指定用户在首页看板中展示的常看和足迹列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '要查询的用户在Quick BI中的UserID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b5d8fd9348cc4327****afb604', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '作品名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '财务报表', ], ], [ 'name' => 'TreeType', 'in' => 'query', 'schema' => [ 'description' => '查询作品的类型（填空查询所有类型）。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PAGE', ], ], [ 'name' => 'QueryMode', 'in' => 'query', 'schema' => [ 'description' => '查询模式。取值范围：'."\n" ."\n" .'- 1：按访问次数排序'."\n" .'- 2：按最近访问时间排序', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '查询作品列表的行数：'."\n" ."\n" .'- 默认值：10'."\n" .'- 最大值：9999', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'OffsetDay', 'in' => 'query', 'schema' => [ 'description' => '查询最近多少天的数据（默认10天）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回查询结果。', 'type' => 'object', 'properties' => [ 'Attention' => [ 'type' => 'string', 'example' => '当前API返回的分页参数如TotalNum等即将下线，如有使用请及时修改', 'default' => '当前API返回的分页参数如TotalNum等即将下线，如有使用请及时修改', ], 'Data' => [ 'description' => '查询到的作品列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Favorite' => [ 'description' => '查询用户是否收藏了该作品。'."\n", 'type' => 'boolean', 'example' => 'true', ], 'GmtCreate' => [ 'description' => '作品创建时间戳。', 'type' => 'string', 'example' => '1496651577000', ], 'GmtModified' => [ 'description' => '作品修改的时间戳。', 'type' => 'string', 'example' => '1640595729000', ], 'HasEditAuth' => [ 'description' => '查询用户是拥有作品的编辑权限。', 'type' => 'boolean', 'example' => 'true', ], 'HasViewAuth' => [ 'description' => '查询用户是拥有作品的查看权限。', 'type' => 'boolean', 'example' => 'true', ], 'LatestViewTime' => [ 'description' => '作品最后一次被访问的时间戳。', 'type' => 'string', 'example' => '1642067498000', ], 'Name' => [ 'description' => '作品名称。', 'type' => 'string', 'example' => '测试报表', ], 'OwnerName' => [ 'description' => '作品所有者的阿里云账号名。', 'type' => 'string', 'example' => '李四', ], 'OwnerNum' => [ 'description' => '作品所有者的UserID。', 'type' => 'string', 'example' => '1365*****238860', ], 'PublishStatus' => [ 'description' => '作品的发布状态。取值范围：'."\n" .'- 0：未发布'."\n" .'- 1：已发布'."\n" .'- 2：已修改保存未发布'."\n" .'- 3：已下线', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TreeId' => [ 'description' => '作品ID。', 'type' => 'string', 'example' => '977c7698-****-****-****-44b7304d20fc', ], 'Type' => [ 'description' => '作品类型。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'example' => 'PAGE', ], 'ViewCount' => [ 'description' => '作品被访问的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'WorkspaceId' => [ 'description' => '作品所属的工作空间ID。', 'type' => 'string', 'example' => '523793cb-****-****-****-aa71c65ffa39', ], 'WorkspaceName' => [ 'description' => '作品所属的工作空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页显示的数据条数。'."\n" ."\n" .'- 默认为10条'."\n" .'- 最大为100条', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Attention\\": \\"当前API返回的分页参数如TotalNum等即将下线，如有使用请及时修改\\",\\n \\"Data\\": [\\n {\\n \\"Favorite\\": true,\\n \\"GmtCreate\\": \\"1496651577000\\",\\n \\"GmtModified\\": \\"1640595729000\\",\\n \\"HasEditAuth\\": true,\\n \\"HasViewAuth\\": true,\\n \\"LatestViewTime\\": \\"1642067498000\\",\\n \\"Name\\": \\"测试报表\\",\\n \\"OwnerName\\": \\"李四\\",\\n \\"OwnerNum\\": \\"1365*****238860\\",\\n \\"PublishStatus\\": 1,\\n \\"TreeId\\": \\"977c7698-****-****-****-44b7304d20fc\\",\\n \\"Type\\": \\"PAGE\\",\\n \\"ViewCount\\": 7,\\n \\"WorkspaceId\\": \\"523793cb-****-****-****-aa71c65ffa39\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ],\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n \\n 1\\n 1\\n 1\\n 10\\n \\n 977c7698-****-****-****-44b7304d20fc\\n PAGE\\n 测试报表\\n 1365*****238860\\n 李四\\n 1496651577000\\n 1640595729000\\n 1\\n true\\n true\\n true\\n 523793cb-****-****-****-aa71c65ffa39\\n 测试工作空间\\n 7\\n 1642067498000\\n \\n \\n true\\n","errorExample":""}]', 'title' => '获取首页看板常看和足迹列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListRecentViewReports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListSharedReports' => [ 'summary' => '获取指定用户在首页看板中展示的被授权的作品列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '要查询用户在Quick BI中的UserID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b5d8fd9348cc4327****afb604', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '作品名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试报表', ], ], [ 'name' => 'TreeType', 'in' => 'query', 'schema' => [ 'description' => '查询作品的类型（填空查询所有类型）。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PAGE', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '查询作品列表的行数：'."\n" ."\n" .'- 默认值：10'."\n" .'- 最大值：9999', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回查询结果。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '查询到的作品列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Favorite' => [ 'description' => '查询用户是否收藏了该作品。', 'type' => 'boolean', 'example' => 'true', ], 'GmtCreate' => [ 'description' => '作品创建时间戳。', 'type' => 'string', 'example' => '1640088615000', ], 'GmtModified' => [ 'description' => '作品修改的时间戳。', 'type' => 'string', 'example' => '1644373980000', ], 'HasEditAuth' => [ 'description' => '查询用户是拥有作品的编辑权限。', 'type' => 'boolean', 'example' => 'true', ], 'HasViewAuth' => [ 'description' => '查询用户是拥有作品的查看权限。', 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'description' => '作品名称。', 'type' => 'string', 'example' => '测试报表', ], 'OwnerName' => [ 'description' => '作品所有者的阿里云账号名。', 'type' => 'string', 'example' => 'test账号', ], 'OwnerNum' => [ 'description' => '作品所有者的UserID。', 'type' => 'string', 'example' => '1365*****238860', ], 'PublishStatus' => [ 'description' => '作品的发布状态。取值范围：'."\n" ."\n" .'- 0：未发布'."\n" .'- 1：已发布'."\n" .'- 2：已修改保存未发布'."\n" .'- 3：已下线', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TreeId' => [ 'description' => '作品ID。', 'type' => 'string', 'example' => '977c7698-****-****-****-44b7304d20fc', ], 'Type' => [ 'description' => '作品类型。取值范围 ：'."\n" .'- DATAPRODUCT：数据门户'."\n" .'- PAGE：仪表板'."\n" .'- REPORT：电子表格', 'type' => 'string', 'example' => 'PAGE', ], 'WorkspaceId' => [ 'description' => '作品所属的工作空间ID。', 'type' => 'string', 'example' => 'gfidm145-****-****-9426-8f93be23****', ], 'WorkspaceName' => [ 'description' => '作品所属的工作空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"Favorite\\": true,\\n \\"GmtCreate\\": \\"1640088615000\\",\\n \\"GmtModified\\": \\"1644373980000\\",\\n \\"HasEditAuth\\": true,\\n \\"HasViewAuth\\": true,\\n \\"Name\\": \\"测试报表\\",\\n \\"OwnerName\\": \\"test账号\\",\\n \\"OwnerNum\\": \\"1365*****238860\\",\\n \\"PublishStatus\\": 1,\\n \\"TreeId\\": \\"977c7698-****-****-****-44b7304d20fc\\",\\n \\"Type\\": \\"PAGE\\",\\n \\"WorkspaceId\\": \\"gfidm145-****-****-9426-8f93be23****\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ],\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D787E1A3-A93C-424A-B626-C2B05DF8D885\\n \\n 1\\n 1\\n 1\\n 10\\n \\n 977c7698-****-****-****-44b7304d20fc\\n PAGE\\n 测试报表\\n 1365*****238860\\n test账号\\n 1640088615000\\n 1644373980000\\n 1\\n true\\n true\\n true\\n gfidm145-****-****-9426-8f93be23****\\n 测试工作空间\\n \\n \\n true\\n","errorExample":""}]', 'title' => '获取首页看板被授权的作品列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSharedReports', ], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListSharedReports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListUserGroupsByUserId' => [ 'summary' => '根据用户的UserID，查询该用户所属的所有用户组信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '用户ID。此处为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '46e5374665ba4b679ee22e2a2927****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E2440604-3059-561A-AD68-DEDBC870EB2B', ], 'Result' => [ 'description' => '用户组信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => '用户组创建时间。', 'type' => 'string', 'example' => '2021-03-15 17:13:55', ], 'CreateUser' => [ 'description' => '用户组创建者。此处为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'example' => '46e5374665ba4b679ee22e2a2927****', ], 'IdentifiedPath' => [ 'description' => '用户组的目录层级。', 'type' => 'string', 'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****', ], 'ModifiedTime' => [ 'description' => '用户组最新修改时间。', 'type' => 'string', 'example' => '2021-03-15 20:36:40', ], 'ModifyUser' => [ 'description' => '用户组修改者。此处为Quick BI的UserID，而非阿里云的UID。', 'type' => 'string', 'example' => '46e5374665ba4b679ee22e2a2927****', ], 'ParentUsergroupId' => [ 'description' => '用户组ID。', 'type' => 'string', 'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****', ], 'UsergroupDesc' => [ 'description' => '用户组备注。', 'type' => 'string', 'example' => '备注', ], 'UsergroupId' => [ 'description' => '用户组ID。', 'type' => 'string', 'example' => '34fd141d-4598-4093-8c33-8e066dcb****', ], 'UsergroupName' => [ 'description' => '用户组名称。', 'type' => 'string', 'example' => '测试用户组', ], ], ], ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E2440604-3059-561A-AD68-DEDBC870EB2B\\",\\n \\"Result\\": [\\n {\\n \\"CreateTime\\": \\"2021-03-15 17:13:55\\",\\n \\"CreateUser\\": \\"46e5374665ba4b679ee22e2a2927****\\",\\n \\"IdentifiedPath\\": \\"2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****\\",\\n \\"ModifiedTime\\": \\"2021-03-15 20:36:40\\",\\n \\"ModifyUser\\": \\"46e5374665ba4b679ee22e2a2927****\\",\\n \\"ParentUsergroupId\\": \\"2fe4fbd8-588f-489a-b3e1-e92c7af0****\\",\\n \\"UsergroupDesc\\": \\"备注\\",\\n \\"UsergroupId\\": \\"34fd141d-4598-4093-8c33-8e066dcb****\\",\\n \\"UsergroupName\\": \\"测试用户组\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n E2440604-3059-561A-AD68-DEDBC870EB2B\\n \\n 2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****\\n 2fe4fbd8-588f-489a-b3e1-e92c7af0****\\n 2021-03-15 20:36:40\\n 46e5374665ba4b679ee22e2a2927****\\n 测试用户组\\n 2021-03-15 17:13:55\\n 备注\\n 34fd141d-4598-4093-8c33-8e066dcb****\\n 46e5374665ba4b679ee22e2a2927****\\n \\n","errorExample":""}]', 'title' => '查询用户所属的用户组信息列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2022-03-04T09:50:58.000Z', 'description' => 'OpenAPI 下线', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListUserGroupsByUserId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListWhitePortalMenu' => [ 'summary' => '获取数据门户菜单的白名单列表。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DataportalId', 'in' => 'query', 'schema' => [ 'description' => '数据门户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'asdagad***213425', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E1**********0DF67E2C3', ], 'Result' => [ 'description' => '白名单列表。', 'type' => 'array', 'items' => [ 'description' => '白名单信息。', 'type' => 'object', 'properties' => [ 'ReceiverId' => [ 'title' => '授权对象的ID。', 'description' => '授权对象的ID，当空间或组织级别时则返回空间ID或组织ID。', 'type' => 'string', 'example' => '8a4***********1e769', ], 'ReceiverType' => [ 'title' => '授权对象类型。取值范围：'."\n" .'● 0：用户 '."\n" .'● 1：用户组 ', 'description' => '授权对象类型。取值范围： '."\n" ."\n" .'- 0：用户 '."\n" .'- 1：用户组'."\n" .'- 3：空间或组织级别', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'AuthPointsValue' => [ 'title' => '菜单授权类型。取值范围：'."\n" .'● 1：查看'."\n" .'● 3：导出和查看', 'description' => '菜单授权类型。取值范围：'."\n" ."\n" .'- 1：查看'."\n" .'- 3：导出和查看', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Application.Object.NotExist', 'errorMessage' => 'The object you are operating does not exist or has been deleted.', 'description' => '操作组件不存在或已被删除。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'NoPermissionTo.Operate.Object', 'errorMessage' => 'You are not authorized to operate the objects.', 'description' => '您无权操作这些对象。', ], [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '该空间不在组织内。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '获取数据门户菜单的白名单列表', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC4E1**********0DF67E2C3\\",\\n \\"Result\\": [\\n {\\n \\"ReceiverId\\": \\"8a4***********1e769\\",\\n \\"ReceiverType\\": 0,\\n \\"AuthPointsValue\\": 1\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ListWorkspaceRoleUsers' => [ 'summary' => '获取指定空间角色下的用户列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'RoleId', 'in' => 'query', 'schema' => [ 'description' => '空间角色ID，包括预置角色和自定义角色：'."\n" ."\n" .'- 25：空间管理员（预置角色）'."\n" .'- 26：开发者（预置角色）'."\n" .'- 27：分析者（预置角色）'."\n" .'- 30：阅览者（预置角色）'."\n" .'- 自定义角色：自定义角色对应的角色ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '25', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID，非必填，不传时，返回所有空间的角色。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '726bee5a-****-43e1-9a8e-b550f0120f35', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的当前页：'."\n" ."\n" .'- 起始值：1'."\n" .'- 默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的每页行数：'."\n" ."\n" .'- 默认值：10'."\n" .'- 最大值：1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '用户昵称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试pop用户', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回空间角色下的用户列表。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '用户列表。', 'type' => 'array', 'items' => [ 'description' => '用户详情。', 'type' => 'object', 'properties' => [ 'NickName' => [ 'description' => '组织成员的昵称。', 'type' => 'string', 'example' => '测试用户', ], 'UserId' => [ 'description' => '组织成员在Quick BI的UserID。', 'type' => 'string', 'example' => 'b5d8fd9348cc4327****afb604'."\n", ], 'WorkspaceId' => [ 'description' => '工作空间ID。', 'type' => 'string', 'example' => '7350a155-0e94-4c6c-8620-57bbec38****', ], 'WorkspaceName' => [ 'description' => '工作空间名称。', 'type' => 'string', 'example' => '测试空间', ], ], ], ], 'PageNum' => [ 'description' => ' '."\n" .'页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '请求接口时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], [ 'errorCode' => 'User.Role.NotExist', 'errorMessage' => 'User role not exist: %s.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"NickName\\": \\"测试用户\\",\\n \\"UserId\\": \\"b5d8fd9348cc4327****afb604\\\\n\\",\\n \\"WorkspaceId\\": \\"7350a155-0e94-4c6c-8620-57bbec38****\\",\\n \\"WorkspaceName\\": \\"测试空间\\"\\n }\\n ],\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 1,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取指定空间角色下的用户列表', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListWorkspaceRoleUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListWorkspaceRoles' => [ 'summary' => '获取空间角色列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '空间角色列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AuthConfigList' => [ 'description' => '角色的权限配置列表。', 'type' => 'array', 'items' => [ 'description' => '具体的权限配置。', 'type' => 'object', 'properties' => [ 'ActionAuthKeys' => [ 'description' => '权限范围。', 'type' => 'array', 'items' => [ 'description' => '具体的权限：'."\n" .'- edit：新建'."\n" .'- use：使用'."\n" .'- list：展示列表', 'type' => 'string', 'example' => 'edit', ], ], 'AuthKey' => [ 'description' => '权限类型：'."\n" .'- portal_create：数据门户'."\n" .'- dashboard_create：仪表板'."\n" .'- report_create：电子表格'."\n" .'- screen_create：数据大屏'."\n" .'- analysis：即席分析'."\n" .'- offline_download：自助取数'."\n" .'- data_form：数据填报'."\n" .'- quick_etl：数据准备'."\n" .'- cube：数据集'."\n" .'- datasource：数据源', 'type' => 'string', 'example' => 'portal_create', ], ], ], ], 'IsSystemRole' => [ 'description' => '是否是预置角色。取值范围：'."\n" ."\n" .'- true：是'."\n" .'- false：否', 'type' => 'boolean', 'example' => 'true', ], 'RoleId' => [ 'description' => '空间角色ID，包括预置角色和自定义角色：'."\n" ."\n" .'- 25：空间管理员（预置角色）'."\n" .'- 26：开发者（预置角色）'."\n" .'- 27：分析者（预置角色）'."\n" .'- 30：阅览者（预置角色）'."\n" .'- 自定义角色：自定义角色对应的角色ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25', ], 'RoleName' => [ 'description' => '角色名称。', 'type' => 'string', 'example' => '空间管理员', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" ."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": [\\n {\\n \\"AuthConfigList\\": [\\n {\\n \\"ActionAuthKeys\\": [\\n \\"edit\\"\\n ],\\n \\"AuthKey\\": \\"portal_create\\"\\n }\\n ],\\n \\"IsSystemRole\\": true,\\n \\"RoleId\\": 25,\\n \\"RoleName\\": \\"空间管理员\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取空间角色列表', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:ListWorkspaceRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ListWorkspaceUserRolesByUserId' => [ 'summary' => '查询用户所有空间角色列表。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI 的 UserId，非您的阿里云账号 ID。 您可以调用 [QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=api-workbench.api_explorer.0.0.672f50daGq9ooV¶ms=%7B%7D&tab=DOC&sdkStyle=old&RegionId=cn-hangzhou) 接口，获取 UserId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'afas-********asfasg', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC4E***************F67E2C3', ], 'Result' => [ 'title' => '所有的空间角色信息列表。', 'description' => '所有的空间角色信息列表。', 'type' => 'array', 'items' => [ 'title' => '每个空间对象。', 'description' => '每个空间对象。', 'type' => 'object', 'properties' => [ 'WorkspaceId' => [ 'title' => '空间ID。', 'description' => '空间ID。', 'type' => 'string', 'example' => '9337d121-a78f-4c1b-a8bc-f81de117****', ], 'WorkspaceName' => [ 'title' => '空间名称。', 'description' => '空间名称。', 'type' => 'string', 'example' => 'test', ], 'RoleModel' => [ 'title' => '空间角色信息。', 'description' => '空间角色信息。', 'type' => 'object', 'properties' => [ 'RoleId' => [ 'title' => '空间角色ID，包括但不限于空间预置角色：'."\n" .'● 25：空间管理员（预置角色）'."\n" .'● 26：空间开发者（预置角色）'."\n" .'● 27：空间分析师（预置角色）'."\n" .'● 30：空间查看者（预置角色）', 'description' => '空间角色ID，包括但不限于空间预置角色：'."\n" ."\n" .'- 25：空间管理员（预置角色）'."\n" .'- 26：空间开发者（预置角色）'."\n" .'- 27：空间分析师（预置角色）'."\n" .'- 30：空间查看者（预置角色）', 'type' => 'string', 'example' => '111111111', ], 'RoleCode' => [ 'title' => '预置空间角色对应的编码，自定义角色不返回。', 'description' => '预置空间角色对应的编码，自定义角色不返回。', 'type' => 'string', 'example' => '34637***35', ], 'RoleName' => [ 'title' => '空间角色的名称。', 'description' => '空间角色的名称。', 'type' => 'string', 'example' => 'arms-admin', ], ], ], ], ], 'required' => true, ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'User.Not.In.Organization', 'errorMessage' => 'The specified user is not in the organizational unit.', 'description' => '该用户不在组织中。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC4E***************F67E2C3\\",\\n \\"Result\\": [\\n {\\n \\"WorkspaceId\\": \\"9337d121-a78f-4c1b-a8bc-f81de117****\\",\\n \\"WorkspaceName\\": \\"test\\",\\n \\"RoleModel\\": {\\n \\"RoleId\\": \\"111111111\\",\\n \\"RoleCode\\": \\"34637***35\\",\\n \\"RoleName\\": \\"arms-admin\\"\\n }\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询用户所有空间角色列表', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ManualRunMailTask' => [ 'summary' => '手动执行订阅的邮件任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'MailId', 'in' => 'query', 'schema' => [ 'title' => '订阅任务id', 'description' => '订阅管理界面的邮件id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3423423sdfa****sdadw', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'a4d1a221d-41za1-****', ], 'Result' => [ 'description' => '是否执行成功。', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Mail.Forbidden.Access', 'errorMessage' => 'Forbidden Access On This Operation.', 'description' => '', ], [ 'errorCode' => 'Mail.Not.Found', 'errorMessage' => 'The Subscription Task Does Not Exist.', 'description' => '', ], [ 'errorCode' => 'MailId.Is.Null', 'errorMessage' => 'The Mail Id Is Null.', 'description' => '', ], [ 'errorCode' => 'MailTask.Already.Running', 'errorMessage' => 'The Mail Task Is Already Running.', 'description' => '', ], [ 'errorCode' => 'MailApi.Beyond.ScheduleLimit', 'errorMessage' => 'Mail Subscription Openapi Requests Are Frequent. Please Try Again In %s Minutes.', 'description' => '', ], [ 'errorCode' => 'Timer.Schedule.Task', 'errorMessage' => 'An error occurred during timer task scheduling.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a4d1a221d-41za1-****\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '手动执行邮件任务', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:ManualRunMailTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ModifyApiDatasourceParameters' => [ 'summary' => '修改指定API数据源的配置。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'ApiId', 'in' => 'query', 'schema' => [ 'description' => 'API数据源的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b66a66de51f24d149116c17718138194', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '726bee5a-****-43e1-9a8e-b550f0120f35', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'JSONArray格式的API数据参数配置，修改的参数数量不能超过10个。'."\n" .'- name：普通参数或查询语句中的参数名称'."\n" .'- value：普通参数或查询语句中的参数值'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ApiDataSource.NotIn.Workspace', 'errorMessage' => 'Target apiId not in target workspace.', 'description' => '目标API不在工作空间内。', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'ApiDatasource.Not.Exist', 'errorMessage' => 'Api datasource not exist.', 'description' => 'API数据源不存在。', ], [ 'errorCode' => 'ApiDatasource.Param.IsNull', 'errorMessage' => 'Api datasource modify parameters is null.', 'description' => 'API数据源的修改参数parameters为空。', ], [ 'errorCode' => 'ApiDatasource.Param.Oversize', 'errorMessage' => 'The number of parameters of API data source exceeds the limit and cannot exceed %s.', 'description' => 'API数据源的参数数量超过限制，不能超过%s个。', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '修改API数据源配置', 'description' => '修改查询语句时，仅支持修改最上层的JsonObject，不支持多层嵌套内的参数修改。具体的参数说明详见[创建API数据源。](~~409330~~)', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiDatasourceParameters', ], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:ModifyApiDatasourceParameters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ModifyCopilotEmbedConfig' => [ 'summary' => '修改智能问数嵌入配置。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'CopilotId', 'in' => 'query', 'schema' => [ 'title' => '嵌入id', 'description' => '嵌入id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccd3428c-dd2xxxxxxxxxxxxdffee', ], ], [ 'name' => 'DataRange', 'in' => 'query', 'schema' => [ 'title' => '数据范围', 'description' => '数据范围。'."\n" .'>传参类型为jsonString，并且分析主题与问数资源只能生效一个开关，并且当全选开关为true时，已全选开关为准，推荐传参只传一个，其他注释>', 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [], 'example' => '如果客户要授权所有分析主题，则 {allTheme: true}'."\n" .'如果客户要授权所有问数资源，则 {allCube: true}'."\n" .'如果客户要授权部分问数资源，则 {llmCubes: [12314,12345]}'."\n" .'如果客户要授权部分分析主题，则 {themes: [12314,12345]}', ], ], [ 'name' => 'ModuleName', 'in' => 'query', 'schema' => [ 'title' => '模块名称', 'description' => '模块名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '小Q', ], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => [ 'title' => '机器人昵称', 'description' => '机器人昵称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '小Q', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '4BAA4694-CC27-555F-B15A-688AA9289FEE', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'UserRoleConfig.NotContain.Function', 'errorMessage' => 'The user %s does not have permission to operate.', 'description' => '此用户%s没有权限操作。', ], [ 'errorCode' => 'Copilot.Modulename.Error', 'errorMessage' => 'ModuleName max length limit 20.', 'description' => '模块名称最大长度是20。', ], [ 'errorCode' => 'Copilot.AgentName.Error', 'errorMessage' => 'AgentName max length limit 10.', 'description' => '机器人名称最大长度限制为10。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], [ 'errorCode' => 'CopilotEmbed.Config.NotFind', 'errorMessage' => 'Can not find copilot embed config with this copilot ID.', 'description' => '找不到此嵌入配置', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BAA4694-CC27-555F-B15A-688AA9289FEE\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => '修改智能问数嵌入配置', 'changeSet' => [ [ 'createdAt' => '2025-02-11T06:04:44.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCopilotEmbedConfig', ], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'quickbi-public:ModifyCopilotEmbedConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'ModifyDashboardNl2sqlStatus' => [ 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DashboardIds', 'in' => 'query', 'schema' => [ 'description' => '仪表板ID数组，多个以英文逗号分隔。'."\n" .'>要求size<=50>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'asda,sadaf', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '状态标识，0为关闭1为开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '46e537a5****', ], 'Result' => [ 'description' => '失败的仪表板ID列表。', 'type' => 'array', 'items' => [ 'description' => '仪表板ID。', 'type' => 'string', 'example' => 'ccd3428c-****-****-a608-26bae29dffee', ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 297 => [ [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'You must specify the parameter.', 'description' => '参数不能为空', ], ], 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '无效参数%s。', ], [ 'errorCode' => 'RobotNl2sql.Moudle.NotPurchase', 'errorMessage' => 'Please purchase Nl2sql module first.', 'description' => '请先购买智能问数模块。', ], [ 'errorCode' => 'ApiUser.Not.Exists', 'errorMessage' => 'The specified user does not exist.', 'description' => '用户不存在。', ], [ 'errorCode' => 'Parameter.Error', 'errorMessage' => 'The input parameter is invalid.', 'description' => '输入参数无效。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '批量编辑仪表板的小Q问数状态', 'summary' => '批量编辑仪表板的小Q问数状态。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46e537a5****\\",\\n \\"Result\\": [\\n \\"ccd3428c-****-****-a608-26bae29dffee\\"\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', ], 'QueryAccelerationLogByCubeId' => [ 'summary' => '获取指定数据集的加速任务运行日志。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7c7223ae-****-3c744528014b', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => '开始时间，格式：yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-04-15 00:00:00', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => '结束时间，格式：yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-05-15 00:00:00', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '页码。默认取值**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页行数。'."\n" .'- 默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D8749D********80FF3B4', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'object', 'properties' => [ 'TotalPages' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalNum' => [ 'description' => '总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNum' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Pre' => [ 'description' => '上一页, 为NULL or 0 ，表示没有上一页。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', ], 'Next' => [ 'description' => '下一页 ，为NULL or 0，表示没有下一页。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', ], 'Data' => [ 'description' => '加速任务日志数组。', 'type' => 'array', 'items' => [ 'description' => '加速任务日志。', 'type' => 'object', 'properties' => [ 'JobId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => 'REST_A***************6a8', ], 'JobHistoryId' => [ 'description' => '任务历史ID。', 'type' => 'string', 'example' => 'REST_A***************6a8', ], 'JonStartDate' => [ 'description' => '任务开始时间。', 'type' => 'string', 'example' => 'REST_A***************6a8', ], 'JobStatus' => [ 'description' => '状态：'."\n" ."\n" .'- 0-待运行'."\n" .'- 1-运行中'."\n" .'- 2-正常结束'."\n" .'- 3-异常结束'."\n" .'- 4-取消'."\n" .'- 5-警告', 'type' => 'string', 'example' => '0', ], 'Duration' => [ 'description' => '耗时，单位秒。', 'type' => 'string', 'example' => '123', ], 'Log' => [ 'description' => '日志。', 'type' => 'string', 'example' => 'asdav************', ], ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'Cube.Not.Exist', 'errorMessage' => 'The Cube does not exist.', 'description' => '数据集不存在。', ], [ 'errorCode' => 'Date.Format.Error', 'errorMessage' => 'Date format conversion error.', 'description' => '日期格式转换错误', ], [ 'errorCode' => 'Date.Check.Error', 'errorMessage' => 'The end date cannot be greater than the start date.', 'description' => '结束日期不能大于开始日期', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'title' => '获取指定数据集的加速任务运行日志', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D********80FF3B4\\",\\n \\"Result\\": {\\n \\"TotalPages\\": 1,\\n \\"TotalNum\\": 1,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Pre\\": 0,\\n \\"Next\\": 0,\\n \\"Data\\": [\\n {\\n \\"JobId\\": \\"REST_A***************6a8\\",\\n \\"JobHistoryId\\": \\"REST_A***************6a8\\",\\n \\"JonStartDate\\": \\"REST_A***************6a8\\",\\n \\"JobStatus\\": \\"0\\",\\n \\"Duration\\": \\"123\\",\\n \\"Log\\": \\"asdav************\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'QueryApprovalInfo' => [ 'summary' => '根据审批人获取相应的审批流信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'title' => '当前审批人用户ID，qbi用户id', 'description' => '当前审批人用户ID，qbi用户id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12352fasdavsa', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'title' => '审批状态。'."\n" .'● 0：待审批'."\n" .'● 1：已处理', 'description' => '审批状态：'."\n" .'- 0：待审批'."\n" .'- 1：已处理', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1', 'minimum' => '0', 'enumValueTitles' => [ '0', '1', ], 'example' => '0', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页多少行，默认1000', 'description' => '每页多少行，默认1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1000', ], ], [ 'name' => 'Page', 'in' => 'query', 'schema' => [ 'title' => '页数，默认1', 'description' => '页数，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'description' => '返回接口执行结果。', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '审批流信息数组。', 'description' => '审批流信息数组。', 'type' => 'array', 'items' => [ 'title' => '审批流信息对象', 'description' => '审批流信息对象。', 'type' => 'object', 'properties' => [ 'ApplicantId' => [ 'title' => '申请人userID，qbi用户id', 'description' => '申请人userID，qbi用户id。', 'type' => 'string', 'example' => '1359508', ], 'ApplicantName' => [ 'title' => '申请人昵称', 'description' => '申请人昵称。', 'type' => 'string', 'example' => '李飞', ], 'ApplicationId' => [ 'title' => '申请id', 'description' => '申请id。', 'type' => 'string', 'example' => '64813ef6da58e80eef8ed2f9', ], 'ApplyReason' => [ 'title' => '申请理由', 'description' => '申请理由。', 'type' => 'string', 'example' => '开发需要', ], 'ApproverId' => [ 'title' => '审批人userID，qbi用户id', 'description' => '审批人userID，qbi用户id。', 'type' => 'string', 'example' => 'sdasascasxasd', ], 'ApproverName' => [ 'title' => '审批人昵称', 'description' => '审批人昵称。', 'type' => 'string', 'example' => 'data_fusion_002', ], 'DeleteFlag' => [ 'title' => '资源是否已被删除', 'description' => '资源是否已被删除：'."\n" .'- true：已被删除'."\n" .'- false：未被删除', 'type' => 'boolean', 'example' => 'true', ], 'ExpireDate' => [ 'title' => '权限有效期限，时间戳', 'description' => '权限有效期限，时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1708568097135', ], 'FlagStatus' => [ 'title' => '权限审批状态：'."\n" .'● 0：审批中,对应请求参数中的0'."\n" .'● 1：审批通过，对应请求参数送1'."\n" .'● 2：审批拒绝，对应请求参数送1', 'description' => '权限审批状态：'."\n" .'- 0：审批中，对应请求参数中的0'."\n" .'- 1：审批通过，对应请求参数中的1'."\n" .'- 2：审批拒绝，对应请求参数中的1', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GmtCreate' => [ 'title' => '申请创建时间，时间戳', 'description' => '申请创建时间，时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687315758', ], 'GmtModified' => [ 'title' => '申请修改时间，时间戳', 'description' => '申请修改时间，时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1640595729000', ], 'HandleReason' => [ 'title' => '处理理由', 'description' => '处理理由。', 'type' => 'string', 'example' => '开发需要', ], 'ResourceId' => [ 'title' => '申请权限资源ID', 'description' => '申请权限资源ID。', 'type' => 'string', 'example' => 'acl-ct4t2e4u2x4ej1bzur', ], 'ResourceName' => [ 'title' => '申请权限资源名称(报表名、空间名...)', 'description' => '申请权限资源名称(报表名、空间名...)。', 'type' => 'string', 'example' => '测试资源', ], 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'example' => 'DASHBOARD', ], 'WorkspaceName' => [ 'title' => '空间名称', 'description' => '空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], 'Page' => [ 'title' => '当前页', 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '当前页请求记录数', 'description' => '当前页请求记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'Start' => [ 'title' => '当前页起始位置', 'description' => '当前页起始位置。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Total' => [ 'title' => '总数目', 'description' => '总数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'TotalPages' => [ 'title' => '总页码', 'description' => '总页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Success' => [ 'description' => '接口是否成功返回，取值范围：'."\n" .'- true：成功'."\n" .'- false：失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '', ], [ 'errorCode' => 'Invalid.User.Organization', 'errorMessage' => 'The user is not in your organization.', 'description' => '', ], [ 'errorCode' => 'Parameter.Error', 'errorMessage' => 'The input parameter is invalid.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": {\\n \\"Data\\": [\\n {\\n \\"ApplicantId\\": \\"1359508\\",\\n \\"ApplicantName\\": \\"李飞\\",\\n \\"ApplicationId\\": \\"64813ef6da58e80eef8ed2f9\\",\\n \\"ApplyReason\\": \\"开发需要\\",\\n \\"ApproverId\\": \\"sdasascasxasd\\",\\n \\"ApproverName\\": \\"data_fusion_002\\",\\n \\"DeleteFlag\\": true,\\n \\"ExpireDate\\": 1708568097135,\\n \\"FlagStatus\\": 0,\\n \\"GmtCreate\\": 1687315758,\\n \\"GmtModified\\": 1640595729000,\\n \\"HandleReason\\": \\"开发需要\\",\\n \\"ResourceId\\": \\"acl-ct4t2e4u2x4ej1bzur\\",\\n \\"ResourceName\\": \\"测试资源\\",\\n \\"ResourceType\\": \\"DASHBOARD\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"PageSize\\": 1000,\\n \\"Start\\": 0,\\n \\"Total\\": 3,\\n \\"TotalPages\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '根据审批人获取相应的审批流信息', 'changeSet' => [ [ 'createdAt' => '2025-02-11T06:04:44.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-12-30T02:38:46.000Z', 'description' => '错误码发生变更、请求参数发生变更', ], [ 'createdAt' => '2024-10-18T01:53:31.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:QueryApprovalInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryAuditLog' => [ 'summary' => '查询审计日志信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'LogType', 'in' => 'query', 'schema' => [ 'title' => '日志类型:'."\n" .'● dataView-访问类，'."\n" .'● function-操作类，'."\n" .'● permission-权限类', 'description' => '日志类型：'."\n" .'- dataView-访问类'."\n" .'- function-操作类'."\n" .'- permission-权限类', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [ 'function' => 'function', 'permission' => 'permission', 'dataView' => 'dataView', ], 'example' => 'function', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'title' => '工作空间ID，需要查询的日志所属工作空间ID', 'description' => '工作空间ID，需要查询的日志所属工作空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '查询开始时间，时间戳,不能早于当前时间90天', 'description' => '查询开始日期，格式（“yyyyMMdd”）,不能早于当前时间90天。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20240504', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '查询结束时间，时间戳', 'description' => '查询结束日期，格式（“yyyyMMdd”)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20240604', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型，参见作品类型', 'description' => '资源类型，参见作品类型。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cube', ], ], [ 'name' => 'OperatorId', 'in' => 'query', 'schema' => [ 'title' => '操作人userId。', 'description' => '操作人userId。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0***', ], ], [ 'name' => 'OperatorTypes', 'in' => 'query', 'schema' => [ 'title' => '权限/访问/操作类型，空-默认所有；'."\n" .'见审计日志码值,送多个请以英文逗号分割', 'description' => '权限/访问/操作类型，空-默认所有；'."\n" ."\n" .'见审计日志码值,送多个请以英文逗号分割。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'MODIFY', ], ], [ 'name' => 'UserAccessDevice', 'in' => 'query', 'schema' => [ 'title' => '访问设备', 'description' => '访问设备，参考码值：'."\n" ."\n" .'- MOBILE -- 移动端'."\n" .'- PC -- PC端', 'type' => 'string', 'required' => false, 'example' => 'PC', ], ], [ 'name' => 'AccessSourceFlag', 'in' => 'query', 'schema' => [ 'title' => '访问来源', 'description' => '访问来源，参考码值：'."\n" ."\n" .'- COMMON -- 普通访问'."\n" .'- IMBEDDED -- 嵌入报表'."\n" .'- PUBLIC -- 公开报表'."\n" .'- IMBEDDED_COMPONENT -- 嵌入卡片', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '78C1AA2D-9201-599E-A0BA-6FC462E57A95', ], 'Result' => [ 'description' => '日志数组。', 'type' => 'array', 'items' => [ 'description' => '日志对象。', 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'title' => '日志时间', 'description' => '日志时间。', 'type' => 'string', 'example' => '2024-04-16 13:17:39', ], 'OperatorAccountName' => [ 'title' => '操作者账号', 'description' => '操作者账号。', 'type' => 'string', 'example' => 'wukaibis', ], 'OperatorName' => [ 'title' => '操作者用户昵称', 'description' => '操作者用户昵称。', 'type' => 'string', 'example' => 'buc_344078', ], 'OperatorType' => [ 'title' => '操作类型', 'description' => '操作类型。', 'type' => 'string', 'example' => 'CREATE', ], 'TargetName' => [ 'title' => '操作目标名称', 'description' => '操作目标名称。', 'type' => 'string', 'example' => 'test', ], 'TargetType' => [ 'title' => '操作目标类型', 'description' => '操作目标类型。', 'type' => 'string', 'example' => 'USER', ], 'WorkspaceId' => [ 'title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '87c6b145-090c-43e1-9426-8f93be23****', ], 'TargetId' => [ 'title' => '操作对象ID', 'description' => '操作对象ID。', 'type' => 'string', 'example' => '1113***************8500', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Date.Format.Error', 'errorMessage' => 'Date format conversion error.', 'description' => '日期格式转换错误', ], [ 'errorCode' => 'Date.Check.Error', 'errorMessage' => 'The end date cannot be greater than the start date.', 'description' => '结束日期不能大于开始日期', ], [ 'errorCode' => 'Date.Exceed.Error', 'errorMessage' => 'The start date must be within 90 days from the current date.', 'description' => '开始日期不能早于当前日期90天', ], [ 'errorCode' => 'Log.Type.Error', 'errorMessage' => 'The log type is incorrect.', 'description' => '日志类型的格式错误', ], [ 'errorCode' => 'Invalid.Workspace', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '该空间不在组织内。', ], [ 'errorCode' => 'Invalid.User.Admin', 'errorMessage' => 'You are not an administrator of this organization.', 'description' => '没有权限，您不是组织管理员。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78C1AA2D-9201-599E-A0BA-6FC462E57A95\\",\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": \\"2024-04-16 13:17:39\\",\\n \\"OperatorAccountName\\": \\"wukaibis\\",\\n \\"OperatorName\\": \\"buc_344078\\",\\n \\"OperatorType\\": \\"CREATE\\",\\n \\"TargetName\\": \\"test\\",\\n \\"TargetType\\": \\"USER\\",\\n \\"WorkspaceId\\": \\"87c6b145-090c-43e1-9426-8f93be23****\\",\\n \\"TargetId\\": \\"1113***************8500\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询审计日志信息', 'changeSet' => [ [ 'createdAt' => '2025-07-02T03:20:55.000Z', 'description' => '请求参数发生变更', ], [ 'createdAt' => '2025-02-21T06:02:16.000Z', 'description' => '错误码发生变更', ], [ 'createdAt' => '2024-12-30T02:38:46.000Z', 'description' => '响应参数发生变更', ], [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'flowControl' => [ 'flowControlList' => [ [ 'threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAuditLog', ], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:QueryAuditLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryComponentPerformance' => [ 'summary' => '查询组件性能日志。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => '查询类型：'."\n" ."\n" .'- **lastDay**：昨天'."\n" .'- **sevenDays**：七天内'."\n" .'- **thirtyDays**：三十天内', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sevenDays', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89713491-cb4f-4579-b889-e82c35f1****', ], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => [ 'description' => '作品的ID。这里的作品包括数据门户，仪表板，电子表格，自助取数。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '6b407e50-e774-406b-9956-da2425c2****', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源类型。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'report', ], ], [ 'name' => 'CostTimeAvgMin', 'in' => 'query', 'schema' => [ 'description' => '平均耗时（分钟）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的每页行数：'."\n" .'- 默认值：10'."\n" .'- 最大值：1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '工作空间成员列表的当前页码：'."\n" ."\n" .'- 起始值：1'."\n" .'- 默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BCE45E6D-9304-4F94-86BB-5A772B1615FF', ], 'Result' => [ 'type' => 'array', 'items' => [ 'description' => '组件性能分析模型。', 'type' => 'object', 'properties' => [ 'CacheCostTimeAvg' => [ 'description' => '命中缓存平均耗时。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'CacheQueryCount' => [ 'description' => '命中缓存次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ComponentId' => [ 'description' => '组件ID。', 'type' => 'string', 'example' => '0696083a-ca72-4d89-8e7a-c017910e0***', ], 'ComponentName' => [ 'description' => '组件名称。', 'type' => 'string', 'example' => '线图', ], 'CostTimeAvg' => [ 'description' => '平均查询时间。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QueryCount' => [ 'description' => '查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'QueryCountAvg' => [ 'description' => '平均查询次数。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QueryOverFivePercentNum' => [ 'description' => '查询超过5s查询次数。', 'type' => 'number', 'format' => 'double', 'example' => '5', ], 'QueryOverFiveSecPercent' => [ 'description' => '查询超过5s占比。', 'type' => 'string', 'example' => '0.3', ], 'QueryOverTenSecPercent' => [ 'description' => '查询超过10s占比。', 'type' => 'string', 'example' => '0.3', ], 'QueryOverTenSecPercentNum' => [ 'description' => '查询超过10s查询次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QueryTimeoutCount' => [ 'description' => '图表查询超时次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'QueryTimeoutCountPercent' => [ 'description' => '图表查询超时次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QuickIndexCostTimeAvg' => [ 'description' => '命中Quick引擎平均查询耗时。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QuickIndexQueryCount' => [ 'description' => '命中Quick引擎次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'RepeatQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '0.3', ], 'RepeatQueryPercentNum' => [ 'description' => '重复查询数量。', 'type' => 'number', 'format' => 'double', 'example' => '2', ], 'RepeatSqlQueryCount' => [ 'description' => '重复查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RepeatSqlQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '0.3', ], 'ReportId' => [ 'description' => '作品ID。', 'type' => 'string', 'example' => '6b407e50-e774-406b-9956-da2425c2****', ], 'ReportName' => [ 'description' => '报告名称。', 'type' => 'string', 'example' => 'ClusterRiskReport', ], 'ReportType' => [ 'description' => '报表类型。', 'type' => 'string', 'example' => 'report', ], 'WorkspaceId' => [ 'description' => '空间唯一ID。', 'type' => 'string', 'example' => '89713491-cb4f-4579-b889-e82c35f1****', ], 'WorkspaceName' => [ 'description' => '空间名称。', 'type' => 'string', 'example' => '测试空间', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.Parameter.Error', 'errorMessage' => 'The parameter is invalid:%s.', 'description' => '', ], ], 500 => [ [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCE45E6D-9304-4F94-86BB-5A772B1615FF\\",\\n \\"Result\\": [\\n {\\n \\"CacheCostTimeAvg\\": 0.3,\\n \\"CacheQueryCount\\": 3,\\n \\"ComponentId\\": \\"0696083a-ca72-4d89-8e7a-c017910e0***\\",\\n \\"ComponentName\\": \\"线图\\",\\n \\"CostTimeAvg\\": 0.3,\\n \\"QueryCount\\": 5,\\n \\"QueryCountAvg\\": 0.3,\\n \\"QueryOverFivePercentNum\\": 5,\\n \\"QueryOverFiveSecPercent\\": \\"0.3\\",\\n \\"QueryOverTenSecPercent\\": \\"0.3\\",\\n \\"QueryOverTenSecPercentNum\\": 0.3,\\n \\"QueryTimeoutCount\\": 1,\\n \\"QueryTimeoutCountPercent\\": 0.3,\\n \\"QuickIndexCostTimeAvg\\": 0.3,\\n \\"QuickIndexQueryCount\\": 3,\\n \\"RepeatQueryPercent\\": \\"0.3\\",\\n \\"RepeatQueryPercentNum\\": 2,\\n \\"RepeatSqlQueryCount\\": 5,\\n \\"RepeatSqlQueryPercent\\": \\"0.3\\",\\n \\"ReportId\\": \\"6b407e50-e774-406b-9956-da2425c2****\\",\\n \\"ReportName\\": \\"ClusterRiskReport\\",\\n \\"ReportType\\": \\"report\\",\\n \\"WorkspaceId\\": \\"89713491-cb4f-4579-b889-e82c35f1****\\",\\n \\"WorkspaceName\\": \\"测试空间\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询组件性能日志', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:QueryComponentPerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryCopilotEmbedConfig' => [ 'summary' => '获取开通小Q嵌入的配置列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'title' => '嵌入配置模块名称', 'description' => '嵌入配置模块名称，模糊搜索。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '06-ELive', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1FC71085-D5FD-08E0-813A-4D4BD1031BC5', ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'Result' => [ 'description' => '嵌入配置列表。', 'type' => 'array', 'items' => [ 'description' => '嵌入配置对象。', 'type' => 'object', 'properties' => [ 'AgentName' => [ 'title' => '机器人昵称', 'description' => '机器人昵称。', 'type' => 'string', 'example' => '小Q', ], 'CopilotId' => [ 'title' => '嵌入id', 'description' => '嵌入id。', 'type' => 'string', 'example' => '9c079710-ddbe-48b3-b495-7c83c8d57cc4', ], 'CreateUser' => [ 'title' => '创建人userid', 'description' => '创建人userid。', 'type' => 'string', 'example' => 'qweqw12312423521', ], 'CreateUserName' => [ 'title' => '创建人的昵称', 'description' => '创建人的昵称。', 'type' => 'string', 'example' => '诸葛', ], 'DataRange' => [ 'title' => '数据范围（分析主题和数据集）', 'description' => '数据范围（分析主题和问数资源）。', 'type' => 'object', 'properties' => [ 'AllCube' => [ 'title' => '是否全选问数资源', 'description' => '是否全选问数资源。', 'type' => 'boolean', 'example' => 'true/false', ], 'AllTheme' => [ 'title' => '是否全选分析主题', 'description' => '是否全选分析主题。', 'type' => 'boolean', 'example' => 'true/false', ], 'LlmCubes' => [ 'title' => '数据集id集合', 'description' => '问数资源id集合。', 'type' => 'array', 'items' => [ 'description' => '问数资源id。', 'type' => 'string', 'example' => '123124,1231241', ], ], 'Themes' => [ 'title' => '分析主题的id集合', 'description' => '分析主题的id集合。', 'type' => 'array', 'items' => [ 'description' => '分析主题id。', 'type' => 'string', 'example' => '123124,1231241', ], ], ], ], 'ModifyUser' => [ 'title' => '修改人', 'description' => '修改人userId。', 'type' => 'string', 'example' => 'asda1231231dfs', ], 'ModuleName' => [ 'title' => '模块名称', 'description' => '模块名称。', 'type' => 'string', 'example' => '小Q', ], 'ShowName' => [ 'title' => '嵌入模块名称', 'description' => '嵌入模块名称。', 'type' => 'string', 'example' => '0327', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'UserRoleConfig.NotContain.Function', 'errorMessage' => 'The user %s does not have permission to operate.', 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FC71085-D5FD-08E0-813A-4D4BD1031BC5\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"AgentName\\": \\"小Q\\",\\n \\"CopilotId\\": \\"9c079710-ddbe-48b3-b495-7c83c8d57cc4\\",\\n \\"CreateUser\\": \\"qweqw12312423521\\",\\n \\"CreateUserName\\": \\"诸葛\\",\\n \\"DataRange\\": {\\n \\"AllCube\\": true,\\n \\"AllTheme\\": true,\\n \\"LlmCubes\\": [\\n \\"123124,1231241\\"\\n ],\\n \\"Themes\\": [\\n \\"123124,1231241\\"\\n ]\\n },\\n \\"ModifyUser\\": \\"asda1231231dfs\\",\\n \\"ModuleName\\": \\"小Q\\",\\n \\"ShowName\\": \\"0327\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取开通小Q嵌入的配置列表', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'quickbi-public:QueryCopilotEmbedConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryCubeOptimization' => [ 'summary' => '查询数据集优化建议。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885', ], 'Result' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AdviceType' => [ 'description' => '建议的类型，取值说明：'."\n" .'- **OPEN_CACHE**：开放缓存。'."\n" .'- **OPEN_QUICK_ENGINE**：开放快速缓存。'."\n" .'- **INCREASE_CACHE_TIME**：增长缓存时间。', 'type' => 'string', 'example' => 'OPENQUICKENGINE', ], 'CubePerformanceDiagnoseModel' => [ 'description' => '数据集诊断信息。', 'type' => 'object', 'properties' => [ 'CacheCostTimeAvg' => [ 'description' => '命中缓存平均耗时。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'CacheQueryCount' => [ 'description' => '命中缓存次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'CostTimeAvg' => [ 'description' => '平均查询时间。', 'type' => 'number', 'format' => 'double', 'example' => '1.0', ], 'CubeId' => [ 'description' => '数据集ID。', 'type' => 'string', 'example' => '3e45b61a-9ba8-4c7c-8248-8dbe69945636', ], 'CubeName' => [ 'description' => '数据集名称。', 'type' => 'string', 'example' => 'test', ], 'QueryCount' => [ 'description' => '查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'QueryCountAvg' => [ 'description' => '平均查询次数。', 'type' => 'number', 'format' => 'double', 'example' => '2', ], 'QueryOverFivePercentNum' => [ 'description' => '查询超过5s查询次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.1', ], 'QueryOverFiveSecPercent' => [ 'description' => '查询超过5s占比。', 'type' => 'string', 'example' => '0.5', ], 'QueryOverTenSecPercent' => [ 'description' => '查询超过10s占比。', 'type' => 'string', 'example' => '0.1', ], 'QueryOverTenSecPercentNum' => [ 'description' => '查询超过10s查询次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QueryTimeoutCount' => [ 'description' => '图表查询超时次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'QueryTimeoutCountPercent' => [ 'description' => '图表查询超时次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'QuickIndexCostTimeAvg' => [ 'description' => '命中Quick引擎平均查询耗时。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'QuickIndexQueryCount' => [ 'description' => '命中Quick引擎次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RepeatQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '0.1', ], 'RepeatQueryPercentNum' => [ 'description' => '重复查询数。', 'type' => 'number', 'format' => 'double', 'example' => '2', ], 'RepeatSqlQueryCount' => [ 'description' => '重复查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RepeatSqlQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '0.3', ], 'WorkspaceId' => [ 'description' => '工作空间ID。', 'type' => 'string', 'example' => '6ea74bff-c818-4188-b462-dbb45a24dbac', ], 'WorkspaceName' => [ 'description' => '工作空间名称。', 'type' => 'string', 'example' => 'eco0sh0prods', ], ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": [\\n {\\n \\"AdviceType\\": \\"OPENQUICKENGINE\\",\\n \\"CubePerformanceDiagnoseModel\\": {\\n \\"CacheCostTimeAvg\\": 1,\\n \\"CacheQueryCount\\": 2,\\n \\"CostTimeAvg\\": 1,\\n \\"CubeId\\": \\"3e45b61a-9ba8-4c7c-8248-8dbe69945636\\",\\n \\"CubeName\\": \\"test\\",\\n \\"QueryCount\\": 50,\\n \\"QueryCountAvg\\": 2,\\n \\"QueryOverFivePercentNum\\": 0.1,\\n \\"QueryOverFiveSecPercent\\": \\"0.5\\",\\n \\"QueryOverTenSecPercent\\": \\"0.1\\",\\n \\"QueryOverTenSecPercentNum\\": 0.3,\\n \\"QueryTimeoutCount\\": 1,\\n \\"QueryTimeoutCountPercent\\": 0.3,\\n \\"QuickIndexCostTimeAvg\\": 1,\\n \\"QuickIndexQueryCount\\": 2,\\n \\"RepeatQueryPercent\\": \\"0.1\\",\\n \\"RepeatQueryPercentNum\\": 2,\\n \\"RepeatSqlQueryCount\\": 2,\\n \\"RepeatSqlQueryPercent\\": \\"0.3\\",\\n \\"WorkspaceId\\": \\"6ea74bff-c818-4188-b462-dbb45a24dbac\\",\\n \\"WorkspaceName\\": \\"eco0sh0prods\\"\\n }\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询数据集优化建议', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:QueryCubeOptimization', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryCubePerformance' => [ 'summary' => '查询数据集性能日志。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => '查询类型：'."\n" ."\n" .'- **lastDay**：昨天'."\n" .'- **sevenDays**：七天内'."\n" .'- **thirtyDays**：三十天内', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sevenDays', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****', ], ], [ 'name' => 'CubeId', 'in' => 'query', 'schema' => [ 'description' => '数据集ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7c7223ae-****-3c744528014b', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '工作空间成员列表的当前页码：'."\n" ."\n" .'- 起始值：1'."\n" .'- 默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时的每页行数：'."\n" .'- 默认值：10'."\n" .'- 最大值：1000'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100', ], ], [ 'name' => 'CostTimeAvgMin', 'in' => 'query', 'schema' => [ 'description' => '平均耗时（分钟）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '685072a0-1fd5-40ef-ae6b-cf94e79e718f', ], 'Result' => [ 'type' => 'array', 'items' => [ 'description' => '数据集诊断信息。', 'type' => 'object', 'properties' => [ 'CacheCostTimeAvg' => [ 'description' => '命中缓存平均耗时。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'CacheQueryCount' => [ 'description' => '命中缓存次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CostTimeAvg' => [ 'description' => '平均查询时间。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'CubeId' => [ 'description' => '数据集ID。', 'type' => 'string', 'example' => '7c7223ae-****-3c744528014b', ], 'CubeName' => [ 'description' => '数据集名称。', 'type' => 'string', 'example' => 'test', ], 'QueryCount' => [ 'description' => '查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'QueryCountAvg' => [ 'description' => '平均查询次数。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'QueryOverFivePercentNum' => [ 'description' => '查询超过5s查询次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '1.0', ], 'QueryOverFiveSecPercent' => [ 'description' => '查询超过5s占比。', 'type' => 'string', 'example' => '1.0', ], 'QueryOverTenSecPercent' => [ 'description' => '查询超过10s占比。', 'type' => 'string', 'example' => '1.0', ], 'QueryOverTenSecPercentNum' => [ 'description' => '查询超过10s查询次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '1.0', ], 'QueryTimeoutCount' => [ 'description' => '图表查询超时次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'QueryTimeoutCountPercent' => [ 'description' => '图表查询超时次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'QuickIndexCostTimeAvg' => [ 'description' => '命中Quick引擎平均查询耗时。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'QuickIndexQueryCount' => [ 'description' => '命中Quick引擎次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RepeatQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '0.3', ], 'RepeatQueryPercentNum' => [ 'description' => '重复查询数。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'RepeatSqlQueryCount' => [ 'description' => '重复查询次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RepeatSqlQueryPercent' => [ 'description' => '重复查询占比。', 'type' => 'string', 'example' => '1', ], 'WorkspaceId' => [ 'description' => '作品所属工作空间的ID。', 'type' => 'string', 'example' => '87c6b145-090c-43e1-9426-8f93be23****', ], 'WorkspaceName' => [ 'description' => '空间名称。', 'type' => 'string', 'example' => '测试工作空间', ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685072a0-1fd5-40ef-ae6b-cf94e79e718f\\",\\n \\"Result\\": [\\n {\\n \\"CacheCostTimeAvg\\": 1,\\n \\"CacheQueryCount\\": 1,\\n \\"CostTimeAvg\\": 1,\\n \\"CubeId\\": \\"7c7223ae-****-3c744528014b\\",\\n \\"CubeName\\": \\"test\\",\\n \\"QueryCount\\": 50,\\n \\"QueryCountAvg\\": 1,\\n \\"QueryOverFivePercentNum\\": 1,\\n \\"QueryOverFiveSecPercent\\": \\"1.0\\",\\n \\"QueryOverTenSecPercent\\": \\"1.0\\",\\n \\"QueryOverTenSecPercentNum\\": 1,\\n \\"QueryTimeoutCount\\": 1,\\n \\"QueryTimeoutCountPercent\\": 1,\\n \\"QuickIndexCostTimeAvg\\": 1,\\n \\"QuickIndexQueryCount\\": 1,\\n \\"RepeatQueryPercent\\": \\"0.3\\",\\n \\"RepeatQueryPercentNum\\": 1,\\n \\"RepeatSqlQueryCount\\": 1,\\n \\"RepeatSqlQueryPercent\\": \\"1\\",\\n \\"WorkspaceId\\": \\"87c6b145-090c-43e1-9426-8f93be23****\\",\\n \\"WorkspaceName\\": \\"测试工作空间\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询数据集性能日志', 'changeSet' => [ [ 'createdAt' => '2024-10-18T01:53:30.000Z', 'description' => '错误码发生变更', ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'quickbi-public:QueryCubePerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ [ 'validationType' => 'always', 'product' => 'QuickBI', 'resourceType' => '全部资源', 'arn' => '*', ], ], ], ], ], ], 'QueryDashboardNl2sql' => [ 'summary' => '查询仪表板的问数资源信息。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3d7ebb8***********500078f4', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3d7ebb8***********500078f4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '46e537a5****,3dadsu****', ], 'Result' => [ 'description' => '接口执行结果。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'array', 'items' => [ 'description' => '返回接口执行结果。', 'type' => 'object', 'properties' => [ 'DashboardName' => [ 'title' => '仪表板名称', 'description' => '仪表板名称', 'type' => 'string', 'example' => '612b', ], 'DashboardNl2sqlId' => [ 'title' => '仪表板问数资源id', 'description' => '仪表板问数资源id', 'type' => 'string', 'example' => 'sasdas****sawdau', ], 'OwnerId' => [ 'title' => '仪表板创建者Userid', 'description' => '仪表板创建者Userid', 'type' => 'string', 'example' => '46e5374665ba4b679ee22e2a2927****', ], 'Authorities' => [ 'title' => '当该参数有值，并且包含"READ"时，表示该用户对该仪表板问数资源有问数权限', 'description' => '当该参数有值，并且包含"READ"时，表示该用户对该仪表板问数资源有问数权限。', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '当该参数有值，并且包含"READ"时，表示该用户对该仪表板问数资源有问数权限。', 'type' => 'string', 'example' => 'READ', ], ], ], ], ], 'Success' => [ 'description' => '是否请求成功。取值范围： '."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Internal.System.Error', 'errorMessage' => 'An internal system error occurred.', 'description' => '系统内部异常。', ], [ 'errorCode' => 'User.Not.In.Organization', 'errorMessage' => 'The specified user is not in the organizational unit.', 'description' => '该用户不在组织中。', ], [ 'errorCode' => 'Workspace.Not.Exist', 'errorMessage' => 'The group workspace does not exist.', 'description' => '群空间不存在。', ], [ 'errorCode' => 'Workspace.NotIn.Organization', 'errorMessage' => 'The workspace is not owned by the organization.', 'description' => '空间不在组织内。', ], [ 'errorCode' => 'UserRoleConfig.NotContain.Function', 'errorMessage' => 'The user %s does not have permission to operate.', 'description' => '此用户%s没有权限操作。', ], [ 'errorCode' => 'User.NotIn.Workspace', 'errorMessage' => 'The user is not a member of the group workspace.', 'description' => '该用户不在群空间中。', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46e537a5****,3dadsu****\\",\\n \\"Result\\": [\\n {\\n \\"DashboardName\\": \\"612b\\",\\n \\"DashboardNl2sqlId\\": \\"sasdas****sawdau\\",\\n \\"OwnerId\\": \\"46e5374665ba4b679ee22e2a2927****\\",\\n \\"Authorities\\": [\\n \\"READ\\"\\n ]\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询仪表板的问数资源信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'QueryData' => [ 'summary' => '对数据服务中已创建的API进行调用。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '老api，且接入bypass空鉴权。', ], 'parameters' => [ [ 'name' => 'ApiId', 'in' => 'query', 'schema' => [ 'description' => '数据服务中的API ID，请参见：[数据服务](~~144980~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4cc43bc3***', ], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => [ 'description' => 'Quick BI中的userId。如何获取userId，请参见：[根据账号查询用户信息接口](https://next.api.aliyun.com/document/quickbi-public/2022-01-01/QueryUserInfoByAccount)'."\n" .'> 该参数用于指定具体使用数据服务的人的身份，可结合数据集的行列权限配置使用'."\n" ."\n\n" ."\n" .'>参数不传、传空字符串、传null等情况，默认传入的userId为当前Quick BI组织的owner>', 'type' => 'string', 'required' => false, 'example' => 'b5d8fd9348cc4327****afb604', ], ], [ 'name' => 'Conditions', 'in' => 'query', 'schema' => [ 'description' => '数据服务的查询条件，以Key和Value的形式传入。map类型的字符串。其中，Key为请求参数的参数名，Value为请求参数的参数值。Key和Value必须成对出现。'."\n" ."\n" .'**说明：**'."\n" ."\n" .'- 请求参数的操作符设置为**枚举筛选**时支持value包含多个值，此时value值的格式是JSON形式的List。例如： `area=["华东","华北","华南"] ` '."\n" ."\n" .'- 对于日期，根据类型不同，提供不同的入参格式：'."\n" ."\n" .' - 年：2019'."\n" ."\n" .' - 季：2019Q1'."\n" ."\n" .' - 月：201901 （携带0）'."\n" .' '."\n" .' - 周：2019-52'."\n" ."\n" .' - 日：20190101'."\n" ."\n" .' - 时：14:00:00 （分、秒为00）'."\n" .' '."\n" .' - 分：14:12:00 （秒为00）'."\n" ."\n" .' - 秒：14:34:34', 'type' => 'string', 'required' => false, 'example' => '{ "area": ["test", "test"], "shopping_date": "2019Q1", }', ], ], [ 'name' => 'ReturnFields', 'in' => 'query', 'schema' => [ 'description' => '返回参数的参数名列表，List 类型字符串。', 'type' => 'string', 'required' => false, 'example' => '["area", "city", "price", "date"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否请求成功。取值范围：'."\n" ."\n" .'- true：请求成功'."\n" .'- false：请求失败', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'a4d1a221d-41za1-****', ], 'Result' => [ 'description' => '返回接口执行结果。取值范围：'."\n" ."\n" .'- true：执行成功'."\n" .'- false：执行失败', 'type' => 'object', 'properties' => [ 'Headers' => [ 'description' => '列头。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Aggregator' => [ 'description' => '聚合操作符。度量字段才会有，例如SUM、AVG和MAX。'."\n" .'- SUM：求和'."\n" .'- MAX：最大值'."\n" .'- MIN：最小值'."\n" .'- AVG：平均值'."\n" .'- COUNT：计数'."\n" .'- COUNTD：去重计数'."\n" .'- STDDEV_POP：总体标准差'."\n" .'- STDDEV_SAMP：样本标准差'."\n" .'- VAR_POP：样本标准差'."\n" .'- VAR_SAMP：样本方差', 'type' => 'string', 'example' => 'SUM', ], 'Column' => [ 'description' => '字段名，对应物理表字段名。', 'type' => 'string', 'example' => 'test', ], 'DataType' => [ 'description' => '字段的数据类型。一般有：'."\n" .'- number：数值'."\n" .'- string：字符串'."\n" .'- date：日期'."\n" .'- time：时间'."\n" .'- datetime：日期时间', 'type' => 'string', 'example' => 'string', ], 'Granularity' => [ 'description' => '维度字段的粒度。'."\n" .'当请求字段为日期维度或地理维度字段，才会返回该字段，取值范围：'."\n" ."\n" .'- 日期粒度：yearRegion（年）、 monthRegion（月）、weekRegion（周）、dayRegion（日）、hourRegion（时）、minRegion（分）、secRegion（秒）'."\n" ."\n" .'- 地理信息粒度：COUNTRY（"国际级"）、PROVINCE（"省级"）、CITY（"市级"）、XIAN（"区县"）、REGION（"区域"）', 'type' => 'string', 'example' => 'REGION', ], 'Label' => [ 'description' => '字段别名，结果参数values中map数据行的key。', 'type' => 'string', 'example' => 'area', ], 'Type' => [ 'description' => '字段类型，用于区分是字段类型为维度或度量字段。'."\n" .'- Dimension：维度'."\n" .'- Measure：度量', 'type' => 'string', 'example' => 'Dimension', ], 'OriginalColumn' => [ 'description' => '数据集里对应的字段原名。', 'type' => 'string', 'example' => 'area', ], ], ], ], 'Sql' => [ 'description' => '请求查询的 SQL。'."\n" .'> 返回的sql语句中的过滤条件除了当前接口的传参条件外，还会带上行列权限的配置信息', 'type' => 'string', 'example' => 'SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE \'%test%\' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10', ], 'Values' => [ 'description' => '返回查询到的结果。', 'type' => 'array', 'items' => [ 'description' => '返回数据的行和列。'."\n" ."\n" .'此参数为List