'1.0',
'info' => [
'style' => 'RPC',
'product' => 'quickbi-public',
'version' => '2022-01-01',
],
'directories' => [
[
'children' => [
[
'children' => [
'CheckOrganizationMember',
'BatchAddFeishuUsers',
'QueryUserInfoByAccount',
],
'type' => 'directory',
'title' => 'Organization User Management',
],
[
'children' => [
'ListWorkspaceUserRolesByUserId',
'ListOrganizationRoles',
],
'type' => 'directory',
'title' => 'Role Management',
],
],
'type' => 'directory',
'title' => 'Organization Management',
],
[
'children' => [
[
'children' => [
'ListPortalMenuAuthorization',
'ListWhitePortalMenu',
],
'type' => 'directory',
'title' => 'DataPortal Menu Authorization Management',
],
[
'children' => [
'SetDataLevelPermissionRuleConfig',
'AddDataLevelPermissionRuleUsers',
'AddDataLevelPermissionWhiteList',
'DeleteDataLevelRuleConfig',
'DeleteDataLevelPermissionRuleUsers',
'UpdateDataLevelPermissionStatus',
'SetDataLevelPermissionExtraConfig',
'QueryDatasetSwitchInfo',
],
'type' => 'directory',
'title' => 'Row-Level Permission Management',
],
],
'type' => 'directory',
'title' => 'Permission Management',
],
[
'children' => [
[
'children' => [
'UpdateEmbeddedStatus',
'QueryWorksByOrganization',
'QueryReadableResourcesListByUserIdV2',
],
'type' => 'directory',
'title' => 'Report Resource Management',
],
[
'children' => [
'CheckDatasetExisted',
'CreateCubeBySql',
'CreateDataset',
'AddDataSource',
'UpdateDataSource',
'UpdateCubeBySql',
'QueryLastAccelerationEngineJob',
'QueryDatasetInfo',
'QueryDatasetList',
'ListAccelerationOfWorkspace',
'QueryAccelerationLogByCubeId',
],
'type' => 'directory',
'title' => 'Dataset Resource Management',
],
[
'children' => [
'CreateWorkspace',
],
'type' => 'directory',
'title' => 'Workspace Management',
],
[
'children' => [
'ListCollections',
],
'type' => 'directory',
'title' => 'Collection Management',
],
[
'children' => [
'GetMailTaskList',
],
'type' => 'directory',
'title' => 'Subscription Management',
],
],
'type' => 'directory',
'title' => 'Resource Management',
],
[
'children' => [
[
'children' => [
'QueryData',
'QueryDataService',
],
'type' => 'directory',
'title' => 'Data Service',
],
],
'type' => 'directory',
'title' => 'Data Management',
],
[
'children' => [
[
'children' => [
'QueryAuditLog',
],
'type' => 'directory',
'title' => 'Resource Analysis',
],
],
'type' => 'directory',
'title' => 'Statistical Analysis',
],
[
'children' => [
[
'children' => [
'ModifyDashboardNl2sqlStatus',
'QueryDashboardNl2sql',
'SmartqAuthorize',
'QueryLlmCubeWithThemeListByUserId',
'QueryDatasetSmartqStatus',
'SmartqQueryAbility',
],
'type' => 'directory',
'title' => 'SmartQ Management',
],
],
'type' => 'directory',
'title' => 'SmartQ',
],
[
'children' => [
'AddShareReport',
'AddUser',
'AddUserGroupMember',
'AddUserGroupMembers',
'AddUserTagMeta',
'AddUserToWorkspace',
'AddWorkspaceUsers',
'AllotDatasetAccelerationTask',
'AuthorizeMenu',
'CancelAuthorizationMenu',
'CancelCollection',
'CancelReportShare',
'ChangeVisibilityModel',
'CheckReadable',
'CreateTicket',
'CreateTicket4Copilot',
'CreateUserGroup',
'DataSetBlood',
'DataSourceBlood',
'DelayTicketExpireTime',
'DeleteTicket',
'DeleteUser',
'DeleteUserFromWorkspace',
'DeleteUserGroup',
'DeleteUserGroupMember',
'DeleteUserGroupMembers',
'DeleteUserTagMeta',
'GetDataSourceConnectionInfo',
'GetMailTaskStatus',
'GetUserGroupInfo',
'GetWorksEmbedList',
'ListApiDatasource',
'ListByUserGroupId',
'ListCubeDataLevelPermissionConfig',
'ListDataLevelPermissionWhiteList',
'ListDataSource',
'ListFavoriteReports',
'ListOrganizationRoleUsers',
'ListPortalMenus',
'ListRecentViewReports',
'ListSharedReports',
'ListUserGroupsByUserId',
'ListWorkspaceRoleUsers',
'ListWorkspaceRoles',
'ManualRunMailTask',
'ModifyApiDatasourceParameters',
'ModifyCopilotEmbedConfig',
'QueryApprovalInfo',
'QueryComponentPerformance',
'QueryCopilotEmbedConfig',
'QueryCubeOptimization',
'QueryCubePerformance',
'QueryDataRange',
'QueryDataServiceList',
'QueryDatasetDetailInfo',
'QueryEmbeddedInfo',
'QueryEmbeddedStatus',
'QueryOrganizationRoleConfig',
'QueryOrganizationWorkspaceList',
'QueryReadableResourcesListByUserId',
'QueryReportPerformance',
'QueryShareList',
'QuerySharesToUserList',
'QuerySmartqPermissionByCubeId',
'QueryTicketInfo',
'QueryUserGroupListByParentId',
'QueryUserGroupMember',
'QueryUserInfoByUserId',
'QueryUserList',
'QueryUserRoleInfoInWorkspace',
'QueryUserTagMetaList',
'QueryUserTagValueList',
'QueryWorks',
'QueryWorksBloodRelationship',
'QueryWorksByWorkspace',
'QueryWorkspaceRoleConfig',
'QueryWorkspaceUserList',
'ResultCallback',
'SaveFavorites',
'SetDataLevelPermissionWhiteList',
'SmartqAuthTransfer',
'UpdateTicketNum',
'UpdateUser',
'UpdateUserGroup',
'UpdateUserTagMeta',
'UpdateUserTagValue',
'UpdateWorkspaceUserRole',
'UpdateWorkspaceUsersRole',
'WithdrawAllUserGroups',
],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddDataLevelPermissionRuleUsers' => [
'summary' => 'Adds specified users and user groups to a row-level permission rule.',
'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", // The ID of the row-level permission rule.'."\n"
.'"cubeId": "7c7223ae-***-3c744528014b", // The ID of the dataset.'."\n"
.'"addModel": {'."\n"
.'"userGroups": \\['."\n"
.'"0d5fb19b-***-1248fc27ca51", // The IDs of the user groups to add.'."\n"
.'"3d2c23d4-***-f6390f325c2d"'."\n"
.'],'."\n"
.'"users": \\['."\n"
.'"4334***358", // The user IDs of the users to add.'."\n"
.'"Huang***3fa822"'."\n"
.']'."\n"
.'}'."\n"
.'}',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'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' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'description' => 'The result of the API operation. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request fails.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request fails.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'CubePermission.Columnlevel.VersionError',
'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.',
'description' => 'You are not allowed to use new dataLevelPermission api.',
],
[
'errorCode' => 'RowLevelPermission.SwitchClose.Error',
'errorMessage' => 'The row level permission switch must be on.',
'description' => 'Row lever permission switch must be open.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotExsist',
'errorMessage' => 'The row level permission rule does not exist: %s.',
'description' => 'The row level permission rule does not exist: %s.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube',
'errorMessage' => 'The row level permission rule does not belong to the current cube.',
'description' => 'The row level permission rule does not belong to the current cube.',
],
[
'errorCode' => 'Cube.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The cube does not belong to the current organization %s.',
'description' => 'Cube do not belong to current organization:%s.',
],
[
'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The usergroup %s does not belong to the current organization.',
'description' => 'Usergroup %s is not belong to current organization.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'AddDataLevelPermissionRuleUsers',
'description' => '> This API operation supports only the new row-level permission model in Quick BI. If you are using the previous row-level permission model, you must migrate to the new model before you call this operation. To migrate, go to Organization Management > Security Settings > Upgrade Row-level Permissions, and then click **One-click Upgrade**.',
'changeSet' => [
[
'createdAt' => '2025-03-14T06:35:33.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'OpenAPI offline',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:AddDataLevelPermissionRuleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'AddDataLevelPermissionRuleUsers',
],
],
],
],
'AddDataLevelPermissionWhiteList' => [
'summary' => 'Modifies the whitelist for row-level and column-level permissions of a specified dataset.',
'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' => 'The ID of the dataset.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '7c7223ae-***-3c744528014b',
],
],
[
'name' => 'RuleType',
'in' => 'query',
'schema' => [
'description' => 'The type of permission. Valid values:'."\n"
."\n"
.'- ROW\\_LEVEL: row-level permission'."\n"
."\n"
.'- COLUMN\\_LEVEL: column-level permission',
'type' => 'string',
'required' => false,
'title' => '',
'example' => 'ROW_LEVEL',
],
],
[
'name' => 'OperateType',
'in' => 'query',
'schema' => [
'description' => 'The operation to perform. Valid values:'."\n"
."\n"
.'- ADD: adds users or user groups to the whitelist.'."\n"
."\n"
.'- DELETE: removes users or user groups from the whitelist.',
'type' => 'string',
'required' => false,
'title' => '',
'example' => 'ADD',
],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => [
'description' => 'The type of object to add to the whitelist. Valid values:'."\n"
."\n"
.'- 1: user'."\n"
."\n"
.'- 2: user group',
'type' => 'string',
'required' => false,
'title' => '',
'example' => '1',
],
],
[
'name' => 'TargetIds',
'in' => 'query',
'schema' => [
'description' => 'The IDs of the users or user groups to add to the whitelist.'."\n"
."\n"
.'- If you set TargetType to 1 (user), specify the user IDs.'."\n"
."\n"
.'- When `TargetType=2` (user group), the value is the user group ID.',
'type' => 'string',
'required' => false,
'title' => '',
'example' => '43342***435,1553a****41231',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'title' => '',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'description' => 'The execution result of the API operation. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'CubePermission.Columnlevel.VersionError',
'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.',
'description' => 'You are not allowed to use new dataLevelPermission api.',
],
[
'errorCode' => 'RowLevelPermission.SwitchClose.Error',
'errorMessage' => 'The row level permission switch must be on.',
'description' => 'Row lever permission switch must be open.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotExsist',
'errorMessage' => 'The row level permission rule does not exist: %s.',
'description' => 'The row level permission rule does not exist: %s.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube',
'errorMessage' => 'The row level permission rule does not belong to the current cube.',
'description' => 'The row level permission rule does not belong to the current cube.',
],
[
'errorCode' => 'Cube.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The cube does not belong to the current organization %s.',
'description' => 'Cube do not belong to current organization:%s.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'AddDataLevelPermissionWhiteList',
'description' => '> This API operation supports only the new permission model for row-level and column-level permissions in Quick BI. If you are using the old permission model, you must migrate to the new one before you call this operation. To perform a one-click migration, you can go to Organization Management > Security Configuration > Upgrade to New Row-level and Column-level Permissions and click **One-click Upgrade**.',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:AddDataLevelPermissionWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'AddDataLevelPermissionWhiteList',
],
],
],
],
'AddDataSource' => [
'summary' => 'Adds the connection information for a data source.',
'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' => 'To construct the request, you can impersonate the \\`restapi/datasource/detect\\` API call. This call is triggered when you click \\*\\*Test Connection\\*\\* on the Add Data Source page in the Quick BI console. Pass the same JSON payload model, and include a \\`userId\\` and workspace ID that exist in Quick BI.'."\n"
.'>Some data sources are not supported. If you pass the correct parameters but the data source is not added, this OpenAPI operation may not support that data source type.>'."\n"
.'>Do not pass the \\`encode\\` field. This OpenAPI operation does not support creating data sources in encryption mode. Authentication that requires file uploads is also not supported.>',
'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"
.'}',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1********DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Data source ID.',
'type' => 'string',
'example' => '472b241b-c651-****-****-ee719d6faf45',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
[
'errorCode' => 'User.NotIn.Workspace',
'errorMessage' => 'The user is not a member of the group workspace.',
'description' => 'The user is not a member of the group workspace.',
],
[
'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' => 'The name cannot be longer than% s characters.',
],
[
'errorCode' => 'Database.PortInvalid.Error',
'errorMessage' => 'The database port is invalid.',
'description' => 'The database port is invalid.',
],
[
'errorCode' => 'Xengnie.TaskExecute.Error',
'errorMessage' => 'Fail to execute task %s.',
'description' => 'Fail to execute task %s.',
],
[
'errorCode' => 'VpcInstance.Info.Error',
'errorMessage' => 'Get vpc instance info error.please check vpc config %s.',
'description' => 'Get VPC instance info error.please check VPC config %s.',
],
[
'errorCode' => 'VpcInstance.Info.EmptyError',
'errorMessage' => 'Not found instance. please check vpc config and authorization %s.',
'description' => 'Not found instance. please check VPC config and authorization %s.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'AddDataSource',
'requestParamsDescription' => 'Request parameter examples:'."\n"
."\n"
.'- adb:
'."\n"
.' {
'."\n"
.' "showName":"AnalyticDB adb3.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"
."\n"
.'- maxcompute:
'."\n"
.' {
'."\n"
.' "showName": "maxcompute",
'."\n"
.' "address": "http\\://service.xxx.xxx.com/api",
'."\n"
.' "port": null,
'."\n"
.' "dsType": "odps",
'."\n"
.' "username": "xxx (The AccessKey ID)",
'."\n"
.' "password": "xxx (The AccessKey secret)",
'."\n"
.' "schema": null,
'."\n"
.' "instance": "Project name (The name of the project)",
'."\n"
.' "project": "Project name",
'."\n"
.' "config": null,
'."\n"
.' "workspaceId": "xxx",
'."\n"
.' "userId": "xxx"
'."\n"
.' }
'."\n"
."\n"
.'- hive:
'."\n"
.' {'."\n"
.' "showName": "test",
'."\n"
.' "address": "192.168.0.1",
'."\n"
.' "port": "10000",
'."\n"
.' "dsType": "hive",
'."\n"
.' "instance": "hive (The name of the database)",
'."\n"
.' "userName": "xxx",
'."\n"
.' "password": "xxx",
'."\n"
.' "config": {
'."\n"
.' "category": "local"
'."\n"
.' }
'."\n"
.' }
'."\n"
."\n"
.'- gbase:
'."\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"
."\n"
.'- rds-mysql:
'."\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"
."\n"
.'- hologres:
'."\n"
.' {'."\n"
.' "showName": "Hologres data source",
'."\n"
.' "address": "hgprecn-cn-******-cn-shanghai.hologres.aliyuncs.com",\\'."\n"
.' "instance": "quickbi\\_test",\\'."\n"
.' "schema": "public",\\'."\n"
.' "port": "80",\\'."\n"
.' "dsType": "hologres",\\'."\n"
.' "userId": "fec0741\\'."\n"
.' \\'."\n"
.' \\'."\n"
.' \\'."\n"
.' \\
\\*\\*\\*\\*\\*061e6a951a2",\\'."\n"
.' "config": {\\'."\n"
.' "initialSql": "Set timezone = \'-10\'"\\'."\n"
.' },\\'."\n"
.' "workspaceId": "87f73904-\\'."\n"
.' \\'."\n"
.' \\'."\n"
.' \\
**\\*\\*-****-b1ee-5a3a03a8eb45",
'."\n"
.' "username": "LTAI4GD\\
\\*\\*\\***LEpsdxkW9",\\'."\n"
.' "password": "nVvUqwPUz\\
**\\*\\*\\*A3sCqockS7"
'."\n"
.' }
'."\n"
."\n"
.'- impala (LDAP authentication):
'."\n"
.' {
'."\n"
.' "workspaceId": "87f73904-****-****-b1ee-5a3a03a8eb45",
'."\n"
.' "userId": "fec0741\\*\\*\\*\\*\\*061e6a951a2",
'."\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"
.' }
'."\n"
."\n"
.'- impala:
'."\n"
.' {'."\n"
.' "showName": "impala-test",
'."\n"
.' "address": "192.168.0.1",
'."\n"
.' "port": "21050",
'."\n"
.' "dsType": "impala",
'."\n"
.' "dsVersion": "3.x (The Impala version. Valid values are 2.x and 3.x.)",
'."\n"
.' "instance": "test (The name of the database)",
'."\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"
.' }
'."\n"
."\n"
.'- dataphin (Connection method: Dataphin service data source. Engine type: ODPS):
'."\n"
.' {
'."\n"
.' "workspaceId": "87f73904-****-****-b1ee-5a3a03a8eb45",
'."\n"
.' "userId": "fec0741\\*\\*\\*\\*\\*061e6a951a2",
'."\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"
."\n"
.'- dataphin (Connection method: Dataphin service data source. Engine type: Hive):
'."\n"
.' {
'."\n"
.' "workspaceId": "87f73904-****-****-b1ee-5a3a03a8eb45",
'."\n"
.' "userId": "fec0741\\*\\*\\*\\*\\*061e6a951a2",
'."\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"
."\n"
.'- dataphin (Connection method: JDBC connection. AccessKey type: Dataphin platform):
'."\n"
.' {
'."\n"
.' "workspaceId": "87f73904-****-****-b1ee-5a3a03a8eb45",
'."\n"
.' "userId": "fec0741\\*\\*\\*\\*\\*061e6a951a2",
'."\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"
."\n"
.'- dataphin (Connection method: JDBC connection. AccessKey type: Personal user):
'."\n"
.' {
'."\n"
.' "workspaceId": "87f73904-****-****-b1ee-5a3a03a8eb45",
'."\n"
.' "userId": "fec0741\\*\\*\\*\\*\\*061e6a951a2",
'."\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"
.' }
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1********DF8D885\\",\\n \\"Result\\": \\"472b241b-c651-****-****-ee719d6faf45\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'AddShareReport' => [
'summary' => 'Add a sharing configuration for data works.',
'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' => 'The ID of the shared work. The works here include BI portal, dashboards, spreadsheets, and self-service access.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6b407e50-e774-406b-9956-da2425c2****',
'title' => '',
],
],
[
'name' => 'ShareToId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'The ID of the person to be shared, which may be the user ID of the Quick BI or the user group ID.'."\n"
."\n"
.'* If ShareToType is 0 (user), ShareTo is the user ID.'."\n"
.'* When ShareToType is set to 1 (user group), ShareTo is the user group ID.'."\n"
.'* When ShareToType=2 (organization), ShareTo is the ID of the organization.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
[
'name' => 'ShareToType',
'in' => 'query',
'schema' => [
'description' => 'The share type of the template. Valid values:'."\n"
."\n"
.'* 0: user'."\n"
.'* 1: user group'."\n"
.'* 2: organization'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '2',
'minimum' => '0',
'example' => '0',
'title' => '',
],
],
[
'name' => 'ExpireDate',
'in' => 'query',
'schema' => [
'description' => 'The validity period of the share. The value is a timestamp in milliseconds.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1608202110838',
'title' => '',
],
],
[
'name' => 'AuthPoint',
'in' => 'query',
'schema' => [
'description' => 'The scope of authorization. Valid values:'."\n"
."\n"
.'* 1: view only'."\n"
.'* 3: View and export'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '3',
'minimum' => '1',
'example' => '3',
'enum' => [
'1',
'3',
],
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => '05739b8e-3de0-4204-9669-7f04f02522b9',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Report.NotExist.Error',
'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.',
'description' => 'This work does not exist. It may have been deleted. Work ID is %s. ',
],
[
'errorCode' => 'Workspace.Not.Exist',
'errorMessage' => 'The group workspace does not exist.',
'description' => 'The group workspace does not exist.',
],
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'Workspace.Share.Forbidden',
'errorMessage' => 'Content in the current group workspace cannot be shared.',
'description' => 'Content in the current group workspace cannot be shared.',
],
[
'errorCode' => 'Workspace.OutsideShare.Forbidden',
'errorMessage' => 'Content in the current group workspace cannot be shared with another organization.',
'description' => 'Content in the current group workspace cannot be shared with another organization.',
],
[
'errorCode' => 'Usergroup.Not.Exist',
'errorMessage' => 'The user group does not exist.',
'description' => 'The user group does not exist.',
],
[
'errorCode' => 'UserGroup.NotIn.Organization',
'errorMessage' => 'The user group is not in the current organization.',
'description' => 'Usergroup is not belong to current organization.',
],
[
'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' => 'Add data work sharing configuration',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-10-24T07:01:04.000Z',
'description' => 'Request parameters changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'AddUser' => [
'summary' => 'Add an organization member.',
'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' => 'Whether to assign the organization administrator role. Value range: '."\n"
."\n"
.'- true: Yes '."\n"
.'- false: No'."\n"
."\n"
.'This parameter is deprecated and not recommended for use. It is invalid when RoleIds is provided.',
'type' => 'boolean',
'deprecated' => true,
'required' => false,
'docRequired' => false,
'example' => 'true',
'title' => '',
],
],
[
'name' => 'AuthAdminUser',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'Whether to assign the organization permission administrator role. Value range: '."\n"
."\n"
.'- true: Yes '."\n"
.'- false: No'."\n"
."\n"
.'This parameter is deprecated and not recommended for use. It is invalid when RoleIds is provided.',
'type' => 'boolean',
'deprecated' => true,
'required' => false,
'docRequired' => false,
'example' => 'true',
'title' => '',
],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => 'The user type of the organization member. Value range:'."\n"
.'- 1: Developer'."\n"
.'- 2: Visitor'."\n"
.'- 3: Analyst',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '10',
'minimum' => '1',
'example' => '1',
'enum' => [
'1',
'2',
'3',
],
'title' => '',
],
],
[
'name' => 'AccountId',
'in' => 'query',
'schema' => [
'description' => 'Aliyun account ID.'."\n"
.'>For versions of Quick BI released after December 31, 2024, AccountId will be a required parameter. Please modify your API before this date.>'."\n"
."\n"
.'Published only on the China site',
'type' => 'string',
'deprecated' => false,
'required' => false,
'docRequired' => false,
'example' => '191476xxxxx23754',
'title' => '',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => 'Aliyun account name.'."\n"
."\n"
.'- Note: If it is a sub-account, the format should be \'primary account: sub-account\'. For example: master_test@aliyun.com:subaccount'."\n"
.'- Format check: Maximum length of 50 characters.',
'type' => 'string',
'deprecated' => true,
'required' => false,
'docRequired' => false,
'example' => 'xxxxxx@163.com',
'title' => '',
],
],
[
'name' => 'NickName',
'in' => 'query',
'schema' => [
'description' => 'Aliyun account nickname.'."\n"
."\n"
.'- Format check: Maximum length of 50 characters.'."\n"
.'- Special format validation: Chinese and English characters, numbers, _ \\ / | () ] \\[',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '张三',
'title' => '',
],
],
[
'name' => 'RoleIds',
'in' => 'formData',
'schema' => [
'description' => 'Preset or custom organization role IDs bound to the user, separated by commas, with a maximum of 3. Value range:'."\n"
.'- Organization Administrator (preset role): 111111111'."\n"
.'- Permission Administrator (preset role): 111111112'."\n"
.'- Regular User (preset role): 111111113',
'type' => 'string',
'required' => false,
'example' => '111111111,456',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Returns detailed information about the newly added Aliyun user.',
'type' => 'object',
'properties' => [
'AccountName' => [
'description' => 'Aliyun account.',
'type' => 'string',
'example' => 'xxxxxx@163.com',
'title' => '',
],
'AdminUser' => [
'description' => 'Whether the organization administrator role is assigned. Value range: '."\n"
."\n"
.'- true: Yes'."\n"
.'- false: No'."\n"
."\n"
.'This parameter is deprecated and not recommended for use. It is invalid when RoleIdList is provided.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'AuthAdminUser' => [
'description' => 'Whether the permission administrator role is assigned. Value range: '."\n"
."\n"
.'- true: Yes'."\n"
.'- false: No'."\n"
."\n"
.'This parameter is deprecated and not recommended for use. It is invalid when RoleIdList is provided.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'NickName' => [
'description' => 'Aliyun account nickname.',
'type' => 'string',
'example' => '张三',
'title' => '',
],
'RoleIdList' => [
'description' => 'List of organization role IDs bound to the user.',
'type' => 'array',
'items' => [
'description' => 'Organization role IDs, up to 3, including but not limited to preset roles: '."\n"
."\n"
.'- Organization Administrator (preset role): 111111111'."\n"
.'- Permission Administrator (preset role): 111111112'."\n"
.'- Regular User (preset role): 111111113',
'type' => 'integer',
'format' => 'int64',
'example' => '111111111',
'title' => '',
],
'title' => '',
'example' => '',
],
'UserId' => [
'description' => 'UserID in Quick BI.',
'type' => 'string',
'example' => 'b5d8fd9348cc4327****afb604',
'title' => '',
],
'UserType' => [
'description' => 'User type of the organization member. Value range: '."\n"
.'- 1: Developer '."\n"
.'- 2: Visitor '."\n"
.'- 3: Analyst',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Organization.Developers.ReachedTheUpperLimit',
'errorMessage' => 'The developers of the organization have reached the upper limit:%s',
'description' => 'The developers of the organization have reached the upper limit:%s',
],
[
'errorCode' => 'Organization.Viewers.ReachedTheUpperLimit',
'errorMessage' => 'The visitors of the organization have reached the upper limit:%s.',
'description' => 'The visitors of the organization have reached the upper limit:%s.',
],
[
'errorCode' => 'Organization.Analysts.ReachedTheUpperLimit',
'errorMessage' => 'The analysts of the organization have reached the upper limit:%s.',
'description' => 'The analysts of the organization have reached the upper limit:%s.',
],
[
'errorCode' => 'NickName.AlreadyIn.Organization',
'errorMessage' => 'The alias already exists.',
'description' => 'The alias already exists.',
],
[
'errorCode' => 'User.AlreadyIn.Organization',
'errorMessage' => 'This user is already a member of the current organization.',
'description' => 'This user is already a member of the current organization.',
],
[
'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' => 'The group workspace does not exist.',
],
[
'errorCode' => 'Workspace.Type.Error',
'errorMessage' => 'The type of group workspace is invalid.',
'description' => 'The type of group workspace is invalid.',
],
[
'errorCode' => 'Viewer.AddInTo.Workspace',
'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
'description' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
],
[
'errorCode' => 'User.AlreadyIn.Workspace',
'errorMessage' => 'This user already exists.',
'description' => 'This user already exists.',
],
[
'errorCode' => 'User.AlreadyIn.Role',
'errorMessage' => 'The user is already assigned this role.',
'description' => 'The user is already assigned this role.',
],
[
'errorCode' => 'User.OrganizationRole.NotExist',
'errorMessage' => 'User %s must have role in organization.',
'description' => 'User %s must have role in organization.',
],
[
'errorCode' => 'Viewer.CannotHave.CustomRole',
'errorMessage' => 'Organization viewer cannot have custom roles.',
'description' => 'Organization viewer cannot have custom roles.',
],
[
'errorCode' => 'UserAnalyst.NotSupport.ThisRole',
'errorMessage' => 'This role has permissions that analysts cannot grant.',
'description' => 'This role has permissions that analysts cannot grant.',
],
[
'errorCode' => 'RoleCount.ExceedsLimit.Error',
'errorMessage' => 'The user role cannot exceed three.',
'description' => 'The user role cannot exceed three.',
],
[
'errorCode' => 'BindRole.NotExist.Error',
'errorMessage' => 'Bind role not exist, %s.',
'description' => 'Bind role not exist, %s.',
],
[
'errorCode' => 'DirtyData.Duplicate.User',
'errorMessage' => 'Dirty data,duplicate user: %s.',
'description' => '',
],
],
],
'title' => 'Add Organization Member',
'changeSet' => [
[
'createdAt' => '2025-03-18T08:50:40.000Z',
'description' => 'Request parameters changed',
],
[
'createdAt' => '2025-03-14T06:35:33.000Z',
'description' => 'Request parameters changed',
],
[
'createdAt' => '2024-11-26T11:47:12.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-02-26T09:29:01.000Z',
'description' => 'Error codes changed, Request parameters changed, Response parameters changed',
],
[
'createdAt' => '2023-08-07T06:37:07.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'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":""}]',
'translator' => 'machine',
],
'AddUserGroupMember' => [
'summary' => 'Adds an organization member to a specified user group.',
'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' => 'The ID of the user group.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '555c4cd****',
'title' => '',
],
],
[
'name' => 'UserIdList',
'in' => 'query',
'schema' => [
'description' => 'The ID of the Quick BI user. Separate multiple IDs with commas (,). Example: abc,efg. You can enter a maximum of 1000 entries.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46e537a5****,3dadsu****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3',
'title' => '',
],
'Result' => [
'description' => 'The result of adding members to a user group is returned. Valid values:'."\n"
."\n"
.'* true: The task is added.'."\n"
.'* false: The tag failed to be added.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid.User',
'errorMessage' => 'The user does not exist and cannot be added to a user group.',
'description' => 'The user does not exist and cannot be added to the user group.',
],
[
'errorCode' => 'Usergroup.Not.Exist',
'errorMessage' => 'The user group does not exist.',
'description' => 'The user group does not exist.',
],
[
'errorCode' => 'Parameter.Length.Exceed',
'errorMessage' => 'Parameter length exceeds maximum limit: [%s].',
'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\\": \\"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' => 'AddUserGroupMember',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-09-18T02:06:59.000Z',
'description' => 'Response parameters changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'AddUserGroupMembers' => [
'summary' => 'Add users to a specified user group at a time.',
'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' => 'The user ID of the Quick BI.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46e5****37a5',
'title' => '',
],
],
[
'name' => 'UserGroupIds',
'in' => 'query',
'schema' => [
'description' => 'The IDs of the user groups. Separate the IDs with commas (,). Example: aGroupId,bGroupId,cGroupIds'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0d5fb19b-****-****-99da-1248fc27ca51',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '',
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'title' => '',
'description' => 'The execution result of the interface. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'title' => '',
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid.User',
'errorMessage' => 'The user does not exist and cannot be added to a user group.',
'description' => 'The user does not exist and cannot be added to the user group.',
],
[
'errorCode' => 'Usergroup.Not.Exist',
'errorMessage' => 'The user group does not exist.',
'description' => 'The user group does not exist.',
],
[
'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' => 'AddUserGroupMembers',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-09-18T02:06:59.000Z',
'description' => 'Response parameters changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'AddUserTagMeta' => [
'summary' => 'Add organization member tag metadata.',
'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' => 'Tag name. Format check:'."\n"
.'- Maximum length of 50 characters.'."\n"
.'- Only Chinese, English, numbers, and /\\|[]() symbols are allowed.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '职位',
'title' => '',
],
],
[
'name' => 'TagDescription',
'in' => 'query',
'schema' => [
'description' => 'Tag description. Format check: maximum length of 255 characters.',
'type' => 'string',
'required' => false,
'example' => '部门内的职位',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Returns the ID of the successfully added tag.',
'type' => 'string',
'example' => '0822a7d9-****-****-****-f20163ab9b0d',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
.'- true: The request succeeded '."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TagName.Repeat',
'errorMessage' => 'The tag name is duplicated.',
'description' => 'tag name duplicate added.',
],
[
'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' => 'The name cannot be longer than% s characters.',
],
[
'errorCode' => 'UserTag.Exceed.Limit',
'errorMessage' => 'The number of user tags cannot exceed %s, you have reached the upper limit.',
'description' => 'The number of user tags cannot exceed %s, you have reached the upper limit..',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'Add Organization Member Tag Metadata',
'changeSet' => [
[
'createdAt' => '2025-05-28T03:27:58.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2025-03-14T06:35:33.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:AddUserTagMeta',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'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":""}]',
'translator' => 'machine',
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'AddUserTagMeta',
],
],
],
],
'AddUserToWorkspace' => [
'summary' => 'Add a member to the specified workspace.',
'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' => 'The ID of the workspace.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the Quick BI user to be added.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => [
'description' => 'The preset space role ID. Value range:'."\n"
."\n"
.'- 25: Space Administrator'."\n"
."\n"
.'- 26: Space Developer'."\n"
."\n"
.'- 27: Space Analyst'."\n"
."\n"
.'- 30: Space Viewer',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '25',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of the interface execution. Value range:'."\n"
."\n"
.'- true: Execution successful'."\n"
."\n"
.'- false: Execution failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
."\n"
.'- true: Request successful'."\n"
."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'User.RoleType.Valid',
'errorMessage' => 'The role ID is invalid.',
'description' => 'The role ID is invalid.',
],
[
'errorCode' => 'Workspace.Not.Exist',
'errorMessage' => 'The group workspace does not exist.',
'description' => 'The group workspace does not exist.',
],
[
'errorCode' => 'Workspace.Type.Error',
'errorMessage' => 'The type of group workspace is invalid.',
'description' => 'The type of group workspace is invalid.',
],
[
'errorCode' => 'Viewer.AddInTo.Workspace',
'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
'description' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
],
[
'errorCode' => 'User.AlreadyIn.Workspace',
'errorMessage' => 'This user already exists.',
'description' => 'This user already exists.',
],
[
'errorCode' => 'User.AlreadyIn.Role',
'errorMessage' => 'The user is already assigned this role.',
'description' => 'The user is already assigned this role.',
],
[
'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' => 'This role has permissions that analysts cannot grant.',
],
[
'errorCode' => 'Viewer.CannotHave.CustomRole',
'errorMessage' => 'Organization viewer cannot have custom roles.',
'description' => 'Organization viewer cannot have custom roles.',
],
[
'errorCode' => 'BindRole.NotExist.Error',
'errorMessage' => 'Bind role not exist, %s.',
'description' => 'Bind role not exist, %s.',
],
],
],
'title' => 'Add Member to Workspace',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-08-07T06:37:07.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'AddWorkspaceUsers' => [
'summary' => 'Batch add members to the workspace.',
'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' => 'Workspace ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
[
'name' => 'UserIds',
'in' => 'query',
'schema' => [
'description' => 'User ID. This is the UserID for Quick BI, not the Alibaba Cloud UID.'."\n"
."\n"
.'- Supports batch parameters, with user IDs separated by commas (,).',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => [
'description' => 'Preset space role ID. Value range:'."\n"
.'- 25: Space Administrator'."\n"
.'- 26: Space Developer'."\n"
.'- 27: Space Analyst'."\n"
.'- 30: Space Viewer',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '30',
'minimum' => '25',
'example' => '25',
'enum' => [
'25',
'26',
'27',
'30',
],
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
.'- true: The request was successful. There may be cases where some members are added successfully and others fail. For the reasons of failure, refer to the FailureDetail in the response.'."\n"
.'- false: The request failed, and no data will be persisted.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => '7AAB95D7-2E11-4FE2-94BC-858E4FC0C976',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of the API execution.',
'type' => 'object',
'properties' => [
'Failure' => [
'description' => 'Number of users that failed to be added.',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'FailureDetail' => [
'description' => 'Reasons for the failures.',
'type' => 'object',
'example' => '{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}',
'title' => '',
],
'Success' => [
'description' => 'Number of users that were added successfully.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'Total' => [
'description' => 'Total number of users being added.',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Batch Add Members to Workspace',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-08-07T06:37:07.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:AddWorkspaceUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'AllotDatasetAccelerationTask' => [
'summary' => 'Trigger the collection acceleration of the Quick engine for datasets.',
'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' => '',
'description' => 'The dataset ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7c7223ae-****-3c744528014b',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '',
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'title' => '',
'description' => 'Indicates whether the IP address whitelist is updated. Valid values:'."\n"
."\n"
.'* true: The task is triggered.'."\n"
.'* false: The task fails to be triggered.'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'AllotDatasetAccelerationTask',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-02-26T09:29:01.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'quickbi-public:AllotDatasetAccelerationTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'AuthorizeMenu' => [
'summary' => 'Batch authorization of BI portal menu will be skipped automatically.',
'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' => 'The ID of the BI portal.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0d173abb53e84c8ca7495429163b****',
'title' => '',
],
],
[
'name' => 'MenuIds',
'in' => 'query',
'schema' => [
'description' => 'The menu ID of the BI portal leaf node.'."\n"
."\n"
.'* The directory menu cannot be authorized.'."\n"
.'* You can upload multiple parameters at a time. Separate multiple IDs with commas (,). The maximum number of parameters that can be modified at a time is 100.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '54kqgoa****,pg1n135****',
'title' => '',
],
],
[
'name' => 'UserGroupIds',
'in' => 'query',
'schema' => [
'description' => 'The IDs of the user groups.'."\n"
."\n"
.'* You can upload multiple parameters at a time. Separate multiple IDs with commas (,). The maximum number of parameters that can be modified at a time is 200.'."\n"
.'* UserGroupIds and UserIds cannot be empty at the same time'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****',
'title' => '',
],
],
[
'name' => 'UserIds',
'in' => 'query',
'schema' => [
'description' => 'The IDs of the end users. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.'."\n"
."\n"
.'* You can upload multiple parameters at a time. Separate multiple IDs with commas (,). The maximum number of parameters that can be modified at a time is 200.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '204627493484****,121344444790****',
'title' => '',
],
],
[
'name' => 'AuthPointsValue',
'in' => 'query',
'schema' => [
'description' => 'Authorizes the permissions of the menu. Valid values:'."\n"
."\n"
.'* 1: view'."\n"
.'* 3: View + Export (default)'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => '188F0B12-00EF-41B3-944A-FB7EF06C9F43',
'title' => '',
],
'Result' => [
'description' => 'The number of authorized menus.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'AuthorizeMenu',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:AuthorizeMenu',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'BatchAddFeishuUsers' => [
'summary' => 'Batch add Feishu users.',
'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' => 'Whether the user is an authorization administrator'."\n"
."\n"
.'- true'."\n"
.'- false'."\n"
."\n"
.'Default is false if not provided',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'example' => 'true',
'title' => '',
],
],
[
'name' => 'IsAdmin',
'in' => 'query',
'schema' => [
'description' => 'Whether the user is an admin user:'."\n"
.'- true'."\n"
.'- false'."\n"
."\n"
.'Default is false if not provided',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'example' => 'False',
'title' => '',
],
],
[
'name' => 'FeishuUsers',
'in' => 'query',
'schema' => [
'description' => 'Information of the users to be added',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '{"ad****fd": "张三", "82****5a": "李四"}"',
'title' => '',
],
],
[
'name' => 'UserGroupIds',
'in' => 'query',
'schema' => [
'description' => 'User group ID(s)',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"',
'title' => '',
],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => 'User type'."\n"
.'- Developer: 1'."\n"
.'- Visitor: 2'."\n"
.'- Analyst: 3',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => 'Result of adding members to the user group. Possible values:'."\n"
."\n"
.'- true: Addition successful'."\n"
.'- false: Addition failed',
'type' => 'object',
'properties' => [
'FailCount' => [
'description' => 'Number of failed validations.',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'FailResults' => [
'description' => 'Details of the failures.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FailInfos' => [
'description' => 'Reasons for errors.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'Error code.',
'type' => 'string',
'example' => 'ACCOUNT_EXIST',
'title' => '',
],
'CodeDesc' => [
'description' => 'Description of the error code.',
'type' => 'string',
'example' => '账号已存在',
'title' => '',
],
'Input' => [
'description' => 'Incorrect input value.',
'type' => 'string',
'example' => '20',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'OkCount' => [
'description' => 'Count of successes.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'example' => 'True',
'title' => '',
],
'Success' => [
'description' => 'Whether the request was successful. Possible values:'."\n"
."\n"
.'- true: Request successful'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'True',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Batch Add Feishu Users',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:BatchAddFeishuUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'CancelAuthorizationMenu' => [
'summary' => 'Cancel the authorization records for specified users and user groups based on the portal menu 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' => 'The ID of the data portal.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0d173abb53e84c8ca7495429163b****',
'title' => '',
],
],
[
'name' => 'MenuIds',
'in' => 'query',
'schema' => [
'description' => 'The leaf node menu IDs of the data portal.'."\n"
."\n"
.'- Supports batch parameters, with IDs separated by commas (,). The maximum number for batch modification is 100.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '54kqgoa****,pg1n135****',
'title' => '',
],
],
[
'name' => 'UserGroupIds',
'in' => 'query',
'schema' => [
'description' => 'List of user group IDs.'."\n"
."\n"
.'- Supports batch parameters, with IDs separated by commas (,). The maximum number for batch modification is 200.'."\n"
.'- UserGroupIds and UserIds cannot both be empty.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****',
'title' => '',
],
],
[
'name' => 'UserIds',
'in' => 'query',
'schema' => [
'description' => 'List of user IDs. These are Quick BI UserIDs, not Alibaba Cloud UIDs.'."\n"
."\n"
.'- Supports batch parameters, with IDs separated by commas (,). The maximum number for batch modification is 200.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '204627493484****,121344444790****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => 'Number of menus successfully unauthorized.',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Report.NotExist.Error',
'errorMessage' => 'This work does not exist. It may have been deleted. Work ID is %s.',
'description' => 'This work does not exist. It may have been deleted. Work ID is %s. ',
],
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'AccessMenu.NotMatch.Portal',
'errorMessage' => 'The menu does not match the BI portal.',
'description' => 'The menu does not match the BI portal.',
],
[
'errorCode' => 'FolderMenu.CanNot.Authorize',
'errorMessage' => 'The folder type menu cannot be authorized. Menu ID: %s.',
'description' => 'Folder type menu cannot be authorized or unauthorized,menuId:%s.',
],
[
'errorCode' => 'Menu.NotBelongTo.CurrentDataportal',
'errorMessage' => 'Menu %s does not belong to the current data portal %s.',
'description' => 'menu %s are/is not belong to current dataportal %s.',
],
[
'errorCode' => 'User.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The user %s does not belong to the current organization.',
'description' => 'User %s is not belong to current organization.',
],
[
'errorCode' => 'Usergroup.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The usergroup %s does not belong to the current organization.',
'description' => 'Usergroup %s is not belong to current organization.',
],
],
],
'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' => 'Batch Cancel Data Portal Menu Authorization',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CancelCollection' => [
'summary' => 'Cancel the data works from the user\'s collection.',
'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' => 'The ID of the work to cancel the collection.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '5d6ae4e7-cede-43cd-b4d3-d2fd442a9202',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the favorite user. The user ID is the UserID of the Quick BI, not the UID of Alibaba Cloud.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '121344444790****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => '7c7223ae-****-3c744528014b',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'CancelCollection',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:CancelCollection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CancelReportShare' => [
'summary' => 'Delete a share authorization for a data work.',
'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' => 'The ID of the work. The works here include BI portal, dashboards, spreadsheets, and self-service access.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6b407e50-e774-406b-9956-da2425c2****',
'title' => '',
],
],
[
'name' => 'ShareToIds',
'in' => 'query',
'schema' => [
'description' => 'The ID of the person to be shared, which may be the user ID of the Quick BI or the user group ID.'."\n"
."\n"
.'* If ShareToType is 0 (user), ShareTo is the user ID.'."\n"
.'* When ShareToType is set to 1 (user group), ShareTo is the user group ID.'."\n"
.'* When ShareToType=2 (organization), ShareTo is the ID of the organization.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
[
'name' => 'ShareToType',
'in' => 'query',
'schema' => [
'description' => 'The deletion method. Valid values:'."\n"
."\n"
.'* 0: Delete by user'."\n"
.'* 1: Delete by user group'."\n"
.'* 2: Delete by organization'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '0',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'CancelReportShare',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:CancelReportShare',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ChangeVisibilityModel' => [
'summary' => 'Modifies the visibility mode of the BI portal menu and whether the menu is only authorized to be visible.',
'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' => 'The ID of the BI portal.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0d173abb53e84c8ca7495429163b****',
'title' => '',
],
],
[
'name' => 'MenuIds',
'in' => 'query',
'schema' => [
'description' => 'The menu ID of the BI portal leaf node.'."\n"
."\n"
.'* The directory menu cannot be authorized.'."\n"
.'* You can upload multiple parameters at a time. Separate multiple IDs with commas (,). The maximum number of parameters that can be modified at a time is 100.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '54kqgoa****,pg1n135****',
'title' => '',
],
],
[
'name' => 'ShowOnlyWithAccess',
'in' => 'query',
'schema' => [
'description' => 'Whether only authorization is visible. Valid values:'."\n"
."\n"
.'* true: Only the authorization is visible.'."\n"
.'* false: Both are visible.'."\n",
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The number of menus that are successfully modified.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'ChangeVisibilityModel',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-04-06T10:12:47.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'quickbi-public:ChangeVisibilityModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CheckDatasetExisted' => [
'summary' => 'Checks whether a dataset with the specified CubeId exists.',
'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' => 'The ID of the dataset.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '7c7223ae-****-3c744528014b',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'title' => '',
'example' => 'C67ABB*********682B0B214',
],
'Result' => [
'description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- true: The call was successful.'."\n"
."\n"
.'- false: The call failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C67ABB*********682B0B214\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'CheckDatasetExisted',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CheckOrganizationMember' => [
'summary' => 'Checks if a user is a member of an organization.',
'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' => 'The ID of the Quick BI user. This is not your Alibaba Cloud account ID. Call the [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) operation to obtain the user ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'adfssd-sdf****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'D787E1A**********DF8D885',
],
'Result' => [
'description' => 'Indicates whether the API call succeeded. Valid values:'."\n"
."\n"
.'- true: The call succeeded.'."\n"
."\n"
.'- false: The call failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A**********DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'CheckOrganizationMember',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CheckReadable' => [
'summary' => 'Queries whether a user has permissions to view data works, such as dashboards and workbooks.',
'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' => 'The ID of the work. Resources here include BI portal, dashboards, spreadsheets, and self-service access.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The user ID of the Quick BI to be checked.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'CheckReadable',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:CheckReadable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CreateCubeBySql' => [
'summary' => 'Creates a dataset from a custom SQL statement.',
'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' => 'The custom SQL statement.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'select * from qqq',
],
],
[
'name' => 'Caption',
'in' => 'query',
'schema' => [
'description' => 'The name of the custom dataset.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'test',
],
],
[
'name' => 'DsId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the data source.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '7AAB95D-*****-****-*4FC0C976',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the workspace.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of a Quick BI user with permissions to create datasets. This is not your Alibaba Cloud account ID. Call the [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) operation to obtain the user ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'asdaf-asda*****asd',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => '05739b************02522b9',
],
'Result' => [
'description' => 'The result of the API call. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'string',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.User.Organization',
'errorMessage' => 'The user is not in your organization.',
'description' => 'The user is not in your organization.',
],
[
'errorCode' => 'User.NotIn.Workspace',
'errorMessage' => 'The user is not in this workspace.',
'description' => 'The user is not in this workspace.',
],
[
'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' => 'The specified data source does not exist: %s.',
],
[
'errorCode' => 'DatasourceId.IsNull.Error',
'errorMessage' => 'You must select a data source before selecting the table.',
'description' => 'You must select a data source before selecting the table.',
],
[
'errorCode' => 'Name.RegularExpression.Error',
'errorMessage' => 'Name format validation failed.',
'description' => '',
],
[
'errorCode' => 'NameExceeded.MaxLength.Error',
'errorMessage' => 'The name cannot exceed %s characters in length.',
'description' => 'The name cannot be longer than% s characters.',
],
[
'errorCode' => 'Cube.DuplicatedName.Error',
'errorMessage' => 'The dataset name already exists. Modify the name before saving.',
'description' => 'The dataset name already exists. Modify the name before saving.',
],
[
'errorCode' => 'Directory.NotExist.Error',
'errorMessage' => 'The directory does not exist.',
'description' => 'The directory does not exist.',
],
[
'errorCode' => 'Xengnie.TaskExecute.Error',
'errorMessage' => 'Fail to execute task %s.',
'description' => 'Fail to execute task %s.',
],
[
'errorCode' => 'Datasource.Sql.ExecuteFailed',
'errorMessage' => 'Failed to execute the SQL statement in the data source.',
'description' => '',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05739b************02522b9\\",\\n \\"Result\\": \\"true\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'CreateCubeBySql',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateDataset' => [
'summary' => 'Creates a dataset from a physical table.',
'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' => 'The ID of the data source.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '7AAB95D-*****-****-*4FC0C976',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => 'The name of the table.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'st_trd_user_purchase_day_inc',
],
],
[
'name' => 'UserDefineCubeName',
'in' => 'query',
'schema' => [
'description' => 'The name of the dataset.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'test',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the workspace.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '726bee5a-****-43e1-9a8e-b550f0120f35',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The user ID of a Quick BI user who has permissions to create datasets. This is not your Alibaba Cloud account ID. To obtain the user ID, call the [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) operation.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '726bee5a-****-43e1-9a8e-b550f0120f35',
],
],
[
'name' => 'TargetDirectoryId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the destination folder.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'title' => '',
'example' => 'asah-fsdfsf*****92342',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The schema of the response.',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'title' => '',
'example' => 'F68B***********A3DF743',
],
'Result' => [
'description' => 'The result of the operation. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request fails.',
'type' => 'string',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request fails.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'Invalid.User.Organization',
'errorMessage' => 'The user is not in your organization.',
'description' => 'The user is not in your organization.',
],
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'Datasource.NotFound.Error',
'errorMessage' => 'The specified data source does not exist: %s.',
'description' => 'The specified data source does not exist: %s.',
],
[
'errorCode' => 'DatasourceId.IsNull.Error',
'errorMessage' => 'You must select a data source before selecting the table.',
'description' => 'You must select a data source before selecting the table.',
],
[
'errorCode' => 'Name.RegularExpression.Error',
'errorMessage' => 'Name format validation failed.',
'description' => '',
],
[
'errorCode' => 'NameExceeded.MaxLength.Error',
'errorMessage' => 'The name cannot exceed %s characters in length.',
'description' => 'The name cannot be longer than% s characters.',
],
[
'errorCode' => 'User.NotIn.Workspace',
'errorMessage' => 'The user is not a member of the group workspace.',
'description' => 'The user is not a member of the group workspace.',
],
[
'errorCode' => 'Cube.DuplicatedName.Error',
'errorMessage' => 'The dataset name already exists. Modify the name before saving.',
'description' => 'The dataset name already exists. Modify the name before saving.',
],
[
'errorCode' => 'Directory.NotExist.Error',
'errorMessage' => 'The directory does not exist.',
'description' => 'The directory does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F68B***********A3DF743\\",\\n \\"Result\\": \\"true\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'CreateDataset',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateTicket' => [
'summary' => 'Generate a ticket for third-party embedding.',
'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' => 'The ID of the report to be embedded. Currently supports dashboards, spreadsheets, data screens, self-service data retrieval, ad-hoc analysis, and data entry.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a206f5f3-****-e9b17c835b03',
'title' => '',
],
],
[
'name' => 'CmptId',
'in' => 'query',
'schema' => [
'description' => 'Component ID. This is the ID of a component within the above-mentioned dashboard; other types of works do not support this.'."\n"
.'Refer to [QueryWorksBloodRelationship](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryWorksBloodRelationship?spm=a2c4g.11186623.0.0.15615d7aWVvWAl\\¶ms=%7B%7D\\&lang=JAVA\\&tab=DOC\\&sdkStyle=old) for the API to get the component ID.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '0fc6a275c7f64f17b1****a306ce0f31',
'title' => '',
],
],
[
'name' => 'TicketNum',
'in' => 'query',
'schema' => [
'description' => 'The number of tickets. Each time a ticket is used, the number of tickets decreases by 1.'."\n"
."\n"
.'- Default value: 1'."\n"
."\n"
.'- Recommended value: 1'."\n"
."\n"
.'- Maximum value: 99999',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'Quick BI\'s UserId, which is not your Alibaba Cloud account ID.'."\n"
.'You can call the [QueryUserInfoByAccount](https://next.api.aliyun.com/api/quickbi-public/2022-01-01/QueryUserInfoByAccount?spm=a2c4g.11186623.0.0.15615d7aWVvWAl\\¶ms=%7B%7D\\&tab=DOC\\&sdkStyle=old) interface to obtain the UserId. An example of a UserId is fe67f61a35a94b7da1a34ba174a7\\*\\*\\*\\*.'."\n"
."\n"
.'> Only one of UserId and AccountName needs to be filled in. If neither is filled in, it will default to binding the report\'s Owner, and the report will be accessed with that user\'s identity. If you need to configure row-level permissions, please refer to [Row-Level Permissions](~~322783~~).',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '46e537466****92704c8',
'title' => '',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => 'The user\'s account name.'."\n"
."\n"
.'- If the user is an Alibaba Cloud primary account **wangwu**, the format is **\\[Primary Account]**, for example, **wangwu**.'."\n"
."\n"
.'- If the user is a RAM account **zhangsan**@aliyun.cn\\*\\*, the format is **\\[Primary Account: Sub-Account]**, for example, **wangwu:zhangsan**.'."\n"
."\n"
.'> Only one of UserId and AccountName needs to be filled in. If neither is filled in, it will default to binding the report\'s Owner, and the report will be accessed with that user\'s identity. If you need to configure row-level permissions, please refer to [Row-Level Permissions](~~322783~~).',
'type' => 'string',
'deprecated' => true,
'required' => false,
'docRequired' => false,
'example' => 'test',
'title' => '',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => 'The type of the user\'s account.'."\n"
."\n"
.'- 1: Alibaba Cloud account'."\n"
."\n"
.'- 3: Quick BI self-built account'."\n"
."\n"
.'- 4: DingTalk'."\n"
."\n"
.'- 5: RAM sub-account'."\n"
."\n"
.'- 9: WeCom'."\n"
."\n"
.'- 10: Feishu'."\n"
."\n"
.'> If AccountName is not empty, then AccountType must also not be empty.',
'type' => 'integer',
'format' => 'int32',
'deprecated' => true,
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => 'Expiration time'."\n"
."\n"
.'- Unit: minutes'."\n"
."\n"
.'- Default: 240',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '200',
'title' => '',
],
],
[
'name' => 'WatermarkParam',
'in' => 'query',
'schema' => [
'description' => 'Watermark parameters for the report.'."\n"
."\n"
.'- Must not exceed 50 characters.'."\n"
."\n"
.'- When the report type is a large screen, watermark parameter passing is not supported.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ticket embed',
'title' => '',
],
],
[
'name' => 'GlobalParam',
'in' => 'query',
'schema' => [
'description' => 'Global parameters for the report filter conditions.'."\n"
."\n"
.'- A string in JsonArray format.'."\n"
."\n"
.'> If you need to use global parameter capabilities, please contact the [Quick BI Operations Manager](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"}]}]',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The generated ticket value.',
'type' => 'string',
'example' => 'ccd3428c-****-****-a608-26bae29dffee',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
."\n"
.'- true: Request succeeded'."\n"
."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch',
'errorMessage' => 'The report bound by the ticket mismatches the actual report.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.Expired',
'errorMessage' => 'Ticket [%s] has expired.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken',
'errorMessage' => 'The request [%s] has no token.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.NotExist',
'errorMessage' => 'Ticket %s does not exist.',
'description' => '',
],
[
'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' => 'This work does not exist. It may have been deleted. Work ID is %s. ',
],
[
'errorCode' => 'Authorize3Rd.Report.Unauthorized',
'errorMessage' => 'The report is not enabled for third party embedding.',
'description' => 'This report is not enabled for 3rd party embedding.',
],
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'Datasource.NotFound.Error',
'errorMessage' => 'The specified data source does not exist: %s.',
'description' => 'The specified data source does not exist: %s.',
],
[
'errorCode' => 'Report.NotExist',
'errorMessage' => 'The dashboard does not exist.',
'description' => 'The dashboard does not exist.',
],
[
'errorCode' => 'Organization.Workspace.Inconformity',
'errorMessage' => 'The workspace does not match the organization.',
'description' => 'workspace inconformity with organization.',
],
[
'errorCode' => 'Parameter.Length.Exceed',
'errorMessage' => 'Parameter length exceeds maximum limit: [%s].',
'description' => '',
],
[
'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' => 'Screen embed does not support watermark parameters.',
],
[
'errorCode' => 'NoPermissionTo.Operate.Object',
'errorMessage' => 'You are not authorized to operate the objects.',
'description' => 'You are not authorized to do this.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": \\"ccd3428c-****-****-a608-26bae29dffee\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Generate Report Embedding Ticket',
'description' => 'For detailed usage, please refer to [Report Embedding Data Permission Control and Parameter Passing Security Enhancement Solution](~~391291~~).',
'changeSet' => [
[
'createdAt' => '2025-03-17T08:55:41.000Z',
'description' => 'Request parameters changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-10-24T07:01:04.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'Error codes changed',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CreateTicket4Copilot' => [
'summary' => 'Generate an embedding ticket for Smart Q.',
'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' => 'ID of the Smart Q module to be embedded.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ccd3428c-dd23-460c-a608-26bae29dffee',
'title' => '',
],
],
[
'name' => 'TicketNum',
'in' => 'query',
'schema' => [
'description' => 'Range of ticket quantity:'."\n"
."\n"
.'- Default value is 1.'."\n"
."\n"
.'- Recommended value is 1.'."\n"
."\n"
.'- Maximum value is 99999.'."\n"
."\n"
.'Each time a ticket is used, the ticket count decreases by 1.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'Quick BI\'s UserId.'."\n"
."\n"
.'- You can obtain this by calling [3.1.7 Get User Details Based on Third-Party Account] or other relevant APIs.'."\n"
."\n"
.'Note: Only one of userId and accountName needs to be filled in. If neither is provided, it will default to the report owner, and the report will be accessed with that user\'s identity.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '9c-asdawf-casxcasd-asdasd',
'title' => '',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => 'User\'s account name.'."\n"
.'Note: Only one of userId and accountName needs to be filled in. If neither is provided, it will default to the report owner, and the report will be accessed with that user\'s identity.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '测试用户',
'title' => '',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => 'User\'s account type:'."\n"
."\n"
.'- 1: Alibaba Cloud Primary Account'."\n"
."\n"
.'- 3: Quick BI Self-built Account'."\n"
."\n"
.'- 4: DingTalk'."\n"
."\n"
.'- 5: Alibaba Cloud RAM Account'."\n"
."\n"
.'- 6: Third-party Account (SAML, OAuth, etc.)'."\n"
."\n"
.'- 9: WeCom'."\n"
."\n"
.'- 10: Feishu'."\n"
."\n"
.'Note: If accountName is not empty, then accountType must also be provided.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [],
'example' => '1',
'title' => '',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => 'Expiration time.'."\n"
."\n"
.'- Unit: minutes, maximum 240 (4 hours).'."\n"
."\n"
.'- Default: 240.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '200',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'ID of the Smart Q module to be embedded.',
'type' => 'string',
'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request succeeded'."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'CopilotEmbed.Config.NotFind',
'errorMessage' => 'Can not find copilot embed config with this copilot ID.',
'description' => 'Cannot find this embedded configuration',
],
[
'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' => 'The parameter is invalid.',
],
[
'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' => 'Generate Smart Q Embedding Ticket',
'changeSet' => [
[
'createdAt' => '2025-03-14T06:35:33.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:CreateTicket4Copilot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'CreateTicket4Copilot',
],
],
],
],
'CreateUserGroup' => [
'summary' => 'Create a user group. You can specify a parent user group.',
'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' => 'The unique ID of the user group.'."\n"
."\n"
.'* If you specify the UserGroupId parameter, the system automatically generates the UserGroupId parameter. If you specify the UserGroupId parameter, the user ID is used as the user group ID. You must ensure that the user ID is unique within the organization.'."\n"
.'* Format verification: Maximum length 64, cannot be -1,'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'pop0001',
'title' => '',
],
],
[
'name' => 'UserGroupName',
'in' => 'query',
'schema' => [
'description' => 'The name of the RAM user group.'."\n"
."\n"
.'* Format verification: Maximum length 255'."\n"
.'* Special format verification: Chinese and English digits\\_ \\ / | () ] \\['."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '杭州财报',
'title' => '',
],
],
[
'name' => 'UserGroupDescription',
'in' => 'query',
'schema' => [
'description' => 'The description of the user group.'."\n"
."\n"
.'* Format verification: Maximum length 255'."\n"
.'* Special format verification: Chinese and English digits\\_ \\ / | () ] \\['."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '用户分组描述',
'title' => '',
],
],
[
'name' => 'ParentUserGroupId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the parent user group. You can add new user groups to this group:'."\n"
."\n"
.'* If you enter the ID of a parent user group, the new user group is added to the user group with the ID.'."\n"
.'* If you enter -1, the new user group is added to the root directory.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3d2c23d4-2b41-4af8-a1f5-f6390f32****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => '36829379-0C38-5BC0-830A-92665BF77D4F',
'title' => '',
],
'Result' => [
'description' => 'The ID of the added user group is returned. An empty string \'\' is returned if the add fails.'."\n",
'type' => 'string',
'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'CreateUserGroup',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'quickbi-public:CreateUserGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'CreateWorkspace' => [
'summary' => 'Creates a workspace.',
'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' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The name of the workspace.',
'title' => '',
'example' => 'test',
],
],
[
'name' => 'WorkspaceDescription',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => false,
'description' => 'The description of the workspace.',
'title' => '',
'example' => 'test',
],
],
[
'name' => 'UseComment',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether to use table remarks when you create a dataset in the workspace. Default value: true.',
'title' => '',
'example' => 'true',
],
],
[
'name' => 'AllowShare',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether reports in the workspace can be shared. Default value: true.',
'title' => '',
'example' => 'true',
],
],
[
'name' => 'AllowPublish',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether reports in the workspace can be made public. Default value: true.',
'title' => '',
'example' => 'true',
],
],
[
'name' => 'AllowViewAll',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether the workspace is in collaboration mode. Default value: true.',
'title' => '',
'example' => 'true',
],
],
[
'name' => 'DefaultShareToAll',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether to grant read permissions on the works in the workspace to all workspace members by default. Default value: false.',
'title' => '',
'example' => 'false',
],
],
[
'name' => 'OnlyAdminCreateDatasource',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether only administrators can create data sources in the workspace. Default value: false.',
'title' => '',
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The request ID.',
'title' => '',
'example' => '685072****************4e79e718f',
],
'Result' => [
'type' => 'string',
'description' => 'The workspace ID.',
'title' => '',
'example' => '12423twfasva********',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'- true: The request is successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'CreateWorkspace.Exceeds.Limits',
'errorMessage' => 'The number of create workspace exceeds the maximum number limit:%s.',
'description' => 'The number of create workspace exceeds the maximum number limit:%s.',
],
[
'errorCode' => 'UserRoleConfig.NotContain.Function',
'errorMessage' => 'The user %s does not have permission to operate.',
'description' => 'The user %s does not have permission to operate.',
],
[
'errorCode' => 'Duplicate.WorkSpaceName.Error',
'errorMessage' => 'There is already a workspace with the same name %s, please rename it before saving.',
'description' => '',
],
[
'errorCode' => 'Transfer.Not.Allowed',
'errorMessage' => 'Transfer to users with lower space permissions is not allowed.',
'description' => 'Transfer to users with lower space permissions is not allowed.',
],
[
'errorCode' => 'Transfer.TargetUser.NotExist',
'errorMessage' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.',
'description' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'CreateWorkspace',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685072****************4e79e718f\\",\\n \\"Result\\": \\"12423twfasva********\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DataSetBlood' => [
'summary' => 'Query works information under the specified dataset.',
'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' => 'List of dataset IDs, separated by English commas.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '234235234,234235235,234235235',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'title' => '指定报表所属owner ，为userId',
'description' => 'Specify the owner of the report, which is the 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' => 'Specify the type of report:'."\n"
.'- REPORT: Workbooks'."\n"
.'- dashboardOfflineQuery: Downloads'."\n"
.'- DASHBOARD: Dashboard'."\n"
.'- ANALYSIS: Ad Hoc Analysis'."\n"
.'- SCREEN: Visualization Screen'."\n"
.'- PAGE: Old dashboard',
'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' => 'Request ID.',
'type' => 'string',
'example' => '46e537a5****,3dadsu****',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Result' => [
'description' => 'Array of works.',
'type' => 'array',
'items' => [
'description' => 'Work object.',
'type' => 'object',
'properties' => [
'WorksId' => [
'title' => '作品id',
'description' => 'Work ID.',
'type' => 'string',
'example' => 'ccd3428c-****-****-a608-26bae29dffee',
],
'WorksType' => [
'title' => '作品类型：'."\n"
.'● REPORT:电子表格'."\n"
.'● dashboardOfflineQuery：自助取数'."\n"
.'● DASHBOARD:仪表板'."\n"
.'● ANALYSIS:即席分析'."\n"
.'● SCREEN:数据大屏'."\n"
.'● PAGE:老仪表板',
'description' => 'Work types: - REPORT: '."\n"
.'- REPORT: Workbooks'."\n"
.'- dashboardOfflineQuery: Downloads'."\n"
.'- DASHBOARD: Dashboard'."\n"
.'- ANALYSIS: Ad Hoc Analysis'."\n"
.'- SCREEN: Visualization Screen'."\n"
.'- PAGE: Old dashboard',
'type' => 'string',
'example' => 'PAGE',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
],
],
'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' => 'DataSetBlood',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DataSourceBlood' => [
'summary' => 'Query dataset information under the specified data source',
'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' => 'Data source 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' => 'Request ID.',
'type' => 'string',
'example' => '46e537a5****,3dadsu****',
],
'Success' => [
'title' => '是否请求成功。取值范围：'."\n"
.'● true：请求成功'."\n"
.'● false：请求失败',
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful'."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'title' => '数据集id数组。',
'description' => 'Array of dataset IDs.',
'type' => 'array',
'items' => [
'description' => 'Dataset ID.',
'type' => 'string',
'example' => 'sdfasdaw234234235',
'title' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Query dataset information under the specified data source',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:DataSourceBlood',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DelayTicketExpireTime' => [
'summary' => 'Update the expiration time of the ticket embedded in the report.',
'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' => 'The value of the third-party embedded ticket, that is, the accessTicket value in the URL.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '040e6f79d33444838e*****c7206c070',
'title' => '',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => 'The time to postpone.'."\n"
."\n"
.'- Unit: minutes. Valid values: 0 to 240. Unit: minutes. Valid values: 4 hours.'."\n"
."\n"
.'- Expired bills cannot be extended.',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '200',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Whether the extension is successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch',
'errorMessage' => 'The report bound by the ticket mismatches the actual report.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.Expired',
'errorMessage' => 'Ticket [%s] has expired.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken',
'errorMessage' => 'The request [%s] has no token.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.NotExist',
'errorMessage' => 'Ticket %s does not exist.',
'description' => '',
],
[
'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' => 'You are not authorized to do this.',
],
],
],
'title' => 'DelayTicketExpireTime',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataLevelPermissionRuleUsers' => [
'summary' => 'Deletes specified users from a row-level permission rule.',
'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", // The ID of the row-level permission rule.'."\n"
.'"cubeId": "7c7223ae-***-3c744528014b", // The ID of the dataset.'."\n"
.'"delModel": {'."\n"
.'"userGroups": \\['."\n"
.'"0d5fb19b-***-1248fc27ca51", // The ID of the user group to remove.'."\n"
.'"3d2c23d4-***-f6390f325c2d"'."\n"
.'],'."\n"
.'"users": \\['."\n"
.'"4334***358", // The ID of the user to remove.'."\n"
.'"Huang***3fa822"'."\n"
.']'."\n"
.'}'."\n"
.'}',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'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' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'description' => 'The result of the API call. Valid values:'."\n"
."\n"
.'- true: The call was successful.'."\n"
."\n"
.'- false: The call failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'CubePermission.Columnlevel.VersionError',
'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.',
'description' => 'You are not allowed to use new dataLevelPermission api.',
],
[
'errorCode' => 'RowLevelPermission.SwitchClose.Error',
'errorMessage' => 'The row level permission switch must be on.',
'description' => 'Row lever permission switch must be open.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotExsist',
'errorMessage' => 'The row level permission rule does not exist: %s.',
'description' => 'The row level permission rule does not exist: %s.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube',
'errorMessage' => 'The row level permission rule does not belong to the current cube.',
'description' => 'The row level permission rule does not belong to the current cube.',
],
[
'errorCode' => 'Cube.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The cube does not belong to the current organization %s.',
'description' => 'Cube do not belong to current organization:%s.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'DeleteDataLevelPermissionRuleUsers',
'description' => '> This API supports only the new row-level permission model of Quick BI. If you use the old row-level permissions, you must migrate to the new model before you call this API. To migrate, go to Organization Management > Security Settings > Upgrade to New Row-level Permissions and click **One-click Upgrade**.',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteDataLevelPermissionRuleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'DeleteDataLevelPermissionRuleUsers',
],
],
],
],
'DeleteDataLevelRuleConfig' => [
'summary' => 'Deletes a row-level permission rule.',
'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' => 'The ID of the dataset.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '7c7223ae-****-3c744528014b',
],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the row-level permission rule.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'a5bb24da-****-a891683e14da',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'description' => 'The execution result of the operation. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'CubePermission.Columnlevel.VersionError',
'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.',
'description' => 'You are not allowed to use new dataLevelPermission api.',
],
[
'errorCode' => 'RowLevelPermission.SwitchClose.Error',
'errorMessage' => 'The row level permission switch must be on.',
'description' => 'Row lever permission switch must be open.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotExsist',
'errorMessage' => 'The row level permission rule does not exist: %s.',
'description' => 'The row level permission rule does not exist: %s.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube',
'errorMessage' => 'The row level permission rule does not belong to the current cube.',
'description' => 'The row level permission rule does not belong to the current cube.',
],
[
'errorCode' => 'Cube.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The cube does not belong to the current organization %s.',
'description' => 'Cube do not belong to current organization:%s.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'DeleteDataLevelRuleConfig',
'description' => '> This operation supports only the new Quick BI row-level permission model. If you are using the old model, you must upgrade before you call this operation. To upgrade, go to Organization Management > Security Configurations > Upgrade Row-level Permissions and click **Upgrade Now**.',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteDataLevelRuleConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'DeleteDataLevelRuleConfig',
],
],
],
],
'DeleteTicket' => [
'summary' => 'Delete Third-Party Embedded 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' => 'The value of the third-party embedded ticket, which is the `accessTicket` in the URL.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '040e6f79d****7d283c7206c070',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Indicates whether the deletion was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful'."\n"
."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful'."\n"
."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Authorize3rdTicket.BindedWorks.Mismatch',
'errorMessage' => 'The report bound by the ticket mismatches the actual report.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.Expired',
'errorMessage' => 'Ticket [%s] has expired.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.HasNo.LoginToken',
'errorMessage' => 'The request [%s] has no token.',
'description' => '',
],
[
'errorCode' => 'Authorize3rdTicket.NotExist',
'errorMessage' => 'Ticket %s does not exist.',
'description' => '',
],
[
'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' => 'You are not authorized to do this.',
],
],
],
'title' => 'Delete Embedded Ticket',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D787E1A3-A93C-424A-B626-C2B05DF8D885\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteUser' => [
'summary' => 'Delete the specified organization user.',
'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' => 'The ID of the user to be deleted. This user ID is the Quick BI UserID, not the Alibaba Cloud UID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'fe67f61a35a94b7da1a34ba174a7****',
'title' => '',
],
],
[
'name' => 'TransferUserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the successor. If not empty, the report resources in the workspace of the deleted user will be transferred to the successor; otherwise, they will be transferred to the space owner.'."\n"
.'- The successor cannot be an organization visitor'."\n"
.'- The permissions of the successor in the workspace must not be less than those of the deleted user, with management permissions > development permissions > sharing permissions > viewing permissions'."\n"
.'- If the successor is not in the workspace, they will be automatically added to the workspace',
'type' => 'string',
'required' => false,
'example' => 'f5****afccd9e434a274',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3',
'title' => '',
],
'Result' => [
'description' => 'Returns the execution result of the interface. Possible values:'."\n"
."\n"
.'- true: Execution succeeded'."\n"
.'- false: Execution failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful - false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'CannotRemove.OrganizationOwner',
'errorMessage' => 'You cannot remove the organization owner from the organization.',
'description' => 'You cannot remove the organization owner from the organization.',
],
[
'errorCode' => 'Member.ExistInWorkspace.Error',
'errorMessage' => 'You cannot remove a user who is a member of a group workspace.',
'description' => 'You cannot remove a user who is a member of a group workspace.',
],
[
'errorCode' => 'Workspace.Not.Exist',
'errorMessage' => 'The group workspace does not exist.',
'description' => 'The group workspace does not exist.',
],
[
'errorCode' => 'Workspace.Type.Error',
'errorMessage' => 'The type of group workspace is invalid.',
'description' => 'The type of group workspace is invalid.',
],
[
'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' => 'You are not a role administrator of the organization and do not have the permission to perform the operation.',
],
[
'errorCode' => 'Works.Transfer.Error',
'errorMessage' => 'You are not authorized to transfer this item.',
'description' => 'You are not authorized to transfer this item.',
],
[
'errorCode' => 'CanNot.Remove.WorkspaceOwner',
'errorMessage' => 'You cannot remove the group workspace owner from the group.',
'description' => 'You cannot remove the group workspace owner from the group.',
],
[
'errorCode' => 'User.NotIn.Workspace',
'errorMessage' => 'The user is not a member of the group workspace.',
'description' => 'The user is not a member of the group workspace.',
],
[
'errorCode' => 'Transfer.TargetUser.NotExist',
'errorMessage' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.',
'description' => 'The new owner does not exist. Please ensure that the target user has logged on to the system.',
],
[
'errorCode' => 'User.RoleType.Valid',
'errorMessage' => 'The role ID is invalid.',
'description' => 'The role ID is invalid.',
],
[
'errorCode' => 'Viewer.AddInTo.Workspace',
'errorMessage' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
'description' => 'Organization members with viewer type are not allowed to add to workspace: %s.',
],
[
'errorCode' => 'UserAnalyst.NotSupport.ThisRole',
'errorMessage' => 'This role has permissions that analysts cannot grant.',
'description' => 'This role has permissions that analysts cannot grant.',
],
[
'errorCode' => 'Transfer.Not.Allowed',
'errorMessage' => 'Transfer to users with lower space permissions is not allowed.',
'description' => 'Transfer to users with lower space permissions is not allowed.',
],
],
],
'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' => 'Delete Organization User',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2025-03-14T06:35:33.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2023-08-07T06:37:07.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DeleteUserFromWorkspace' => [
'summary' => 'Delete a member from the specified workspace.',
'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' => 'The ID of the workspace.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the user to be deleted. Note that this UserID is for Quick BI, not the Alibaba Cloud UID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de4bc5f9429141cc8091cdd1c15b****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of the API execution. Possible values:'."\n"
."\n"
.'- true: Execution succeeded'."\n"
.'- false: Execution failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
.'- true: The request succeeded - false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Remove Workspace Member',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteUserFromWorkspace',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DeleteUserGroup' => [
'summary' => 'Deletes a user group in an organization.',
'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' => 'The ID of the user group.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'f5eeb52e-d9c2-4a8b-80e3-47ab55c2****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'F2775AB6-DE99-5FA6-86A4-72EA0A8AFEE3',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'DeleteUserGroup',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteUserGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DeleteUserGroupMember' => [
'summary' => 'Deletes a specified member from a specified user group.',
'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' => 'The ID of the user group.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46e537****',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The user ID of the Quick BI.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2fe4fbd8****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'DC4E1E63-B337-44F8-8C22-6F00DF67E2C3',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of deleting a user group member. Valid values:'."\n"
."\n"
.'* true: The task is deleted.'."\n"
.'* false: The deletion failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'DeleteUserGroupMember',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteUserGroupMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DeleteUserGroupMembers' => [
'summary' => 'Batch remove specified users from user groups.',
'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' => 'The UserID of the user to be removed from the user group. Note that this UserID refers to the Quick BI UserID, not the Alibaba Cloud UID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '204627493484****',
'title' => '',
],
],
[
'name' => 'UserGroupIds',
'in' => 'query',
'schema' => [
'description' => 'The ID of the user group(s) to exit.'."\n"
."\n"
.'- Supports batch parameters, separate IDs with a comma (,).',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '34fd141d-4598-4093-8c33-8e066dcb****,3d2c23d4-2b41-4af8-a1f5-f6390f32****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'ABBAD906-3925-5D18-B23D-714053AB0AA2',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of the interface execution. Possible values:'."\n"
."\n"
.'- true: Execution succeeded'."\n"
.'- false: Execution failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'DeleteUserGroupMembers',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteUserGroupMembers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'DeleteUserTagMeta' => [
'summary' => 'Deletes the tag metadata of an organization member.',
'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' => 'The ID of the tag to be deleted.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pop_001',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the deleted tag is returned. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request fails.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'DeleteUserTagMeta',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:31.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'quickbi-public:DeleteUserTagMeta',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'GetDataSourceConnectionInfo' => [
'summary' => 'Get Data Source Information',
'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' => '',
'description' => 'Data source ID.',
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => '7AAB95D-*****-****-*4FC0C976',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '',
'description' => 'Request ID.',
'type' => 'string',
'example' => '7AAB95D-*****-****-*4FC0C976',
],
'Result' => [
'title' => '',
'description' => 'Data source information.',
'type' => 'object',
'properties' => [
'Address' => [
'title' => '',
'description' => 'Database connection string address (domain or IP).',
'type' => 'string',
'example' => '172.**.**.48',
],
'AuthLevel' => [
'title' => '',
'description' => 'Permission level:'."\n"
."\n"
.'- 0 -- Private'."\n"
.'- 1 -- Collaborative Editing (old)'."\n"
.'- 11 -- Collaborative Editing - Space Members'."\n"
.'- 12 -- Collaborative Editing - Specified to Individuals',
'type' => 'string',
'example' => '0',
],
'CreatorId' => [
'title' => '',
'description' => 'Quick BI user ID of the creator.',
'type' => 'string',
'example' => 'U240****0880C6095',
],
'DsId' => [
'title' => '',
'description' => 'Data source ID.',
'type' => 'string',
'example' => 'a201c85c-******',
],
'DsType' => [
'title' => '',
'description' => 'Data source type.',
'type' => 'string',
'enumValueTitles' => [
'hive' => 'Hive Data Source',
'vertica' => 'Vertica Data Source',
'ppas' => 'RDS PPAS Data Source',
'dm' => 'DM7 Data Source-Dameng',
'tsdb' => 'TSDB Data Source',
'tdsql' => 'TDSQL-H Data Source',
'mysql_hybrid' => 'HybridDB for MySQL Data Source',
'sqlserver' => 'sqlserver Data Source',
'postgresql' => 'postgresql Data Source',
'garuda' => 'garuda Data Source',
'adb_spark' => 'adb Data Source Spark Engine',
'greenplum' => 'greenplum Data Source',
'phoenix_thin' => 'PHOENIX THIN Data Source',
'dla' => 'DataLake Analytics Data Source',
'starrocks' => 'StarRocks Data Source',
'mysql' => 'mysql Data Source',
'hana' => 'SAP HANA Data Source',
'mongodb' => 'MongoDB Data Source',
'adb' => 'ADB',
'hbase' => 'HBASE Data Source',
'oscar' => 'Sheng Tong Data Source',
'gbase' => 'Gbase Data Source',
'oracle' => 'oracle Data Source',
'sybase' => ' SAP SYBASE IQ Data Source',
'dataphin' => 'DataPhin Data Source-Multi-engine',
'odps' => 'odps Data Source',
'db2' => 'IBM DB2 Data Source(LUW)',
'yida' => 'yida Application Data Source',
'clickhouse' => 'ClickHouse Data Source',
'oceanbase_oracle' => 'OceanBase_Oracle Data Source',
'presto' => 'presto Data Source',
'polardb' => 'polardb Data Source',
'dataphin_odps' => 'DataPhin Data Source odps Engine',
'selectdb' => 'SelectDB Data Source',
],
'example' => 'mysql',
],
'DsVersion' => [
'title' => '',
'description' => 'Version of the data source.',
'type' => 'string',
'example' => '5.7',
],
'Instance' => [
'title' => '',
'description' => 'Database instance, corresponding to the database name, and for ODPS, it is the project.',
'type' => 'string',
'example' => 'rm*********t44ju1',
],
'InstanceId' => [
'title' => '',
'description' => 'Instance ID.',
'type' => 'string',
'example' => 'rm*********t44ju1',
],
'ModifyUser' => [
'title' => '',
'description' => 'Quick BI user ID of the modifier.',
'type' => 'string',
'example' => 'U240****0880C6095',
],
'NoSasl' => [
'description' => 'Whether the impala data source requires authentication to log in:'."\n"
."\n"
.'- true - Requires account and password login '."\n"
.'- false - No authentication required (default)',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'ParentDsType' => [
'title' => '',
'description' => 'Primary data source type for multi-engine data sources.',
'type' => 'string',
'example' => 'dataphin',
],
'Port' => [
'title' => '',
'description' => 'Port.',
'type' => 'string',
'example' => '3306',
],
'Project' => [
'title' => '',
'description' => 'Used for front-end display when obtaining connection details for ODPS.',
'type' => 'string',
'example' => 'prod-ossdoc',
],
'Schema' => [
'title' => '',
'description' => 'Database schema, only needs to be set for databases that support schemas.',
'type' => 'string',
'example' => 'Analysis',
],
'ShowName' => [
'title' => '',
'description' => 'Display name of the data source on the front end.',
'type' => 'string',
'example' => '0327',
],
'WorkspaceId' => [
'title' => '',
'description' => 'Workspace ID to which the data source belongs.',
'type' => 'string',
'example' => '0de6**2-d**-4720-8836-0cc****1394c',
],
],
'example' => '',
],
'Success' => [
'title' => '',
'description' => 'Indicates whether the operation was successful.',
'type' => 'boolean',
'example' => 'true',
],
],
'example' => '',
],
],
],
'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' => 'GetDataSourceConnectionInfo',
'changeSet' => [
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:GetDataSourceConnectionInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'GetMailTaskList' => [
'summary' => 'Retrieves a list of tracking tasks. Note: If the caller\'s AccessKey (AK) does not have permission to view tracking tasks of other users, this operation returns only the tasks that the caller is authorized to access.',
'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' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The page number.'."\n"
."\n"
.'- Starts from: 1'."\n"
."\n"
.'- Default value: 1',
'title' => '',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The number of entries to return on each page.'."\n"
."\n"
.'- Default value: 25',
'title' => '',
'example' => '10',
],
],
[
'name' => 'UserNick',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => false,
'description' => 'The nickname of the user who owns the tracking task. If this parameter is not specified, all tasks are returned.',
'title' => '',
'example' => 'test',
],
],
[
'name' => 'Paused',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'description' => 'Specifies whether the tracking task is paused.',
'title' => '',
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The ID of the request.',
'title' => '',
'example' => '0c52************8e1952a3',
],
'Result' => [
'type' => 'object',
'properties' => [
'PageNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The page number.',
'title' => '',
'example' => '1',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The number of entries per page that was set for the request.',
'title' => '',
'example' => '10',
],
'TotalNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of entries.',
'title' => '',
'example' => '1',
],
'TotalPages' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of pages.',
'title' => '',
'example' => '1',
],
'Pre' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The previous page number. A value of null or 0 indicates that there is no previous page.',
'title' => '',
'example' => 'null',
],
'Next' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The next page number. A value of null or 0 indicates that there is no next page.',
'title' => '',
'example' => 'null',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MailId' => [
'type' => 'string',
'description' => 'The mail ID of the tracking task.',
'title' => '',
'example' => '2342526',
],
'Paused' => [
'type' => 'boolean',
'description' => 'Indicates whether the task is paused.'."\n"
."\n"
.'- true: The task is paused.'."\n"
."\n"
.'- false: The task is not paused.',
'title' => '',
'example' => 'true',
],
'BizOwnerUserId' => [
'type' => 'string',
'description' => 'The user ID of the owner.',
'title' => '',
'example' => 'asag****2423',
],
'BizOwnerName' => [
'type' => 'string',
'description' => 'The nickname of the owner.',
'title' => '',
'example' => 'test',
],
'SubscribeName' => [
'type' => 'string',
'description' => 'The name of the tracking task.',
'title' => '',
'example' => 'test',
],
],
'description' => 'The tracking task model.',
'title' => '',
'example' => '',
],
'description' => 'An array of tracking task models.',
'title' => '',
'example' => '',
],
],
'description' => 'The paging information for the tracking tasks.',
'title' => '',
'example' => '',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'UserRoleConfig.NotContain.Function',
'errorMessage' => 'The user %s does not have permission to operate.',
'description' => 'The user %s does not have permission to operate.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'GetMailTaskList',
'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' => 'Check the running status of mail tasks within an organization',
'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' => 'Mail ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd5a59a898b634d75be5584f8dc159c62',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'title' => '任务id',
'description' => 'Task ID'."\n"
."\n"
.'> - If the task ID is not provided, the latest task status will be returned by default;'."\n"
.'> - If the task ID is provided, the status of the specified task will be returned.',
'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' => 'Request ID.',
'type' => 'string',
'example' => '38C0FEC8-1510-415C-A9F1-9AE9422BDB65',
'title' => '',
],
'Result' => [
'description' => 'Return result.',
'type' => 'array',
'items' => [
'description' => 'Return result.',
'type' => 'object',
'properties' => [
'execTime' => [
'title' => '执行时间，时间格式为 yyyy-MM-dd HH:mm:ss',
'description' => 'Execution time, in the format yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2024-10-09 17:34:11',
],
'mailId' => [
'title' => '邮件id',
'description' => 'Mail ID',
'type' => 'string',
'example' => 'c38f73f4c5xxxxxc808c41b3f4d23b7852',
],
'status' => [
'title' => '邮件状态，成功：SENT ，失败：FAILED ，进行中：PROCESSING',
'description' => 'Mail status. Possible values:'."\n"
."\n"
.'- Success: SENT'."\n"
.'- Failure: FAILED '."\n"
.'- In Progress: PROCESSING',
'type' => 'string',
'example' => 'SENT',
],
'taskId' => [
'title' => '任务id',
'description' => 'Task ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1282xxx610816',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful. '."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'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' => 'GetMailTaskStatus',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:GetMailTaskStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'GetUserGroupInfo' => [
'summary' => 'Search for user group information based on the keyword of the user group name.',
'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' => 'Keyword of the user group name.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '测试用户组',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5',
'title' => '',
],
'Result' => [
'description' => 'User group information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => 'Creation time of the user group.',
'type' => 'string',
'example' => '2021-03-15 17:13:55',
'title' => '',
],
'CreateUser' => [
'description' => 'Creator of the sub-user group. This is the UserID in Quick BI, not the UID in Alibaba Cloud.',
'type' => 'string',
'example' => '46e5374665ba4b679ee22e2a2927****',
'title' => '',
],
'IdentifiedPath' => [
'description' => 'Directory level of the user group.',
'type' => 'string',
'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****',
'title' => '',
],
'ModifiedTime' => [
'description' => 'Last modified time of the user group.',
'type' => 'string',
'example' => '2021-03-15 20:36:40',
'title' => '',
],
'ModifyUser' => [
'description' => 'Modifier of the user group. This is the UserID in Quick BI, not the UID in Alibaba Cloud.',
'type' => 'string',
'example' => '46e5374665ba4b679ee22e2a2927****',
'title' => '',
],
'ParentUsergroupId' => [
'description' => 'Parent user group ID.',
'type' => 'string',
'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****',
'title' => '',
],
'UsergroupDesc' => [
'description' => 'Description of the user group.',
'type' => 'string',
'example' => '测试描述',
'title' => '',
],
'UsergroupId' => [
'description' => 'User group ID.',
'type' => 'string',
'example' => '34fd141d-4598-4093-8c33-8e066dcb****',
'title' => '',
],
'UsergroupName' => [
'description' => 'Name of the user group.',
'type' => 'string',
'example' => '测试用户组01',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Get User Group Information by Keyword',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:GetUserGroupInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'GetWorksEmbedList' => [
'summary' => 'Query the list of embedded reports',
'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' => 'Workspace 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' => 'Report type'."\n"
."\n"
.'- page, Dashboard'."\n"
.'- screen, Data Screen'."\n"
.'- report, Spreadsheet'."\n"
.'- ANALYSIS, Ad-hoc Analysis'."\n"
.'- dashboardOfflineQuery, Self-service Data Retrieval'."\n"
.'- dataForm, Data Entry Form',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [
'dataForm' => '',
'dashboardOfflineQuery' => 'Self-service Data Retrieval',
'report' => 'Spreadsheet',
'screen' => 'Data Screen',
'ANALYSIS' => 'Ad-hoc Analysis',
'page' => 'Dashboard',
],
'example' => 'page',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'title' => '报表名称（模糊匹配）',
'description' => 'Report name (fuzzy match)',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '测试数据集',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'title' => '页数（为空默认选1）',
'description' => 'Page number (defaults to 1 if empty)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '每页显示的条数（为空默认选10）',
'description' => 'Number of items per page (defaults to 10 if empty)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Request ID',
'type' => 'string',
'example' => '38C0F*****0-415****9F1-*****422BDB65',
],
'Result' => [
'description' => 'Array of report objects',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'Array of reports',
'type' => 'array',
'items' => [
'description' => 'Report object',
'type' => 'object',
'properties' => [
'EmbedTime' => [
'title' => '嵌入时间',
'description' => 'Embed time',
'type' => 'string',
'example' => 'YYYY-mm-DD hh:MM:ss',
],
'WorksId' => [
'title' => '报表ID',
'description' => 'Report ID',
'type' => 'string',
'example' => '897ce25e-****-****-af84-d13c5610****',
],
'WorksName' => [
'title' => '报表名称',
'description' => 'Report name',
'type' => 'string',
'example' => '测试哦',
],
'WorksType' => [
'title' => '报表类型',
'description' => 'Report type',
'type' => 'string',
'example' => 'page',
],
'WorkspaceId' => [
'title' => '所属空间ID',
'description' => 'Workspace ID',
'type' => 'string',
'example' => '87c6b145-****-43e1-9426-8f93be23****',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNo' => [
'title' => '页数',
'description' => 'Page number',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'title' => '每页显示的条数',
'description' => 'Number of items per page',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TotalNum' => [
'title' => '总条数',
'description' => 'Total number of items',
'type' => 'integer',
'format' => 'int64',
'example' => '18',
],
'TotalPages' => [
'title' => '总页码',
'description' => 'Total number of pages',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Whether the request was successful',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Get Embedded Reports',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:GetWorksEmbedList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListAccelerationOfWorkspace' => [
'summary' => 'Retrieves information about acceleration tasks in a workspace.',
'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' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The workspace ID.',
'title' => '',
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
],
],
[
'name' => 'CubeName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => false,
'description' => 'The name of the dataset.',
'title' => '',
'example' => 'test',
],
],
[
'name' => 'CreatorId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => false,
'description' => 'The user ID in Quick BI. This is not your Alibaba Cloud account ID. Call the QueryUserInfoByAccount operation to obtain the user ID.',
'title' => '',
'example' => '1***************139',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The page number. If this parameter is left empty, the default value is 1.',
'title' => '',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The number of rows on each page for a paged query.'."\n"
."\n"
.'- Default value: 10.',
'title' => '',
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The request ID.',
'title' => '',
'example' => 'D787E****************05DF8D885',
],
'Result' => [
'type' => 'object',
'properties' => [
'TotalPages' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of pages.',
'title' => '',
'example' => '1',
],
'TotalNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of rows.',
'title' => '',
'example' => '18',
],
'PageNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The page number.',
'title' => '',
'example' => '1',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The number of rows per page that you set when you call the operation.',
'title' => '',
'example' => '10',
],
'Pre' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The previous page. A value of NULL or 0 indicates that there is no previous page.',
'title' => '',
'example' => '0',
],
'Next' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The next page. A value of NULL or 0 indicates that there is no next page.',
'title' => '',
'example' => 'null',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CubeId' => [
'type' => 'string',
'description' => 'The dataset ID.',
'title' => '',
'example' => 'd14e*********fef8de29fd',
],
'CubeName' => [
'type' => 'string',
'description' => 'The dataset name.',
'title' => '',
'example' => 'test',
],
'CreatorName' => [
'type' => 'string',
'description' => 'The name of the creator.',
'title' => '',
'example' => 'system',
],
'Size' => [
'type' => 'string',
'description' => 'The size.',
'title' => '',
'example' => '47045632',
],
'LastModifyTime' => [
'type' => 'string',
'description' => 'The time when the task was last modified.',
'title' => '',
'example' => '20250911 00:00:00',
],
'EnableQuickindexTime' => [
'type' => 'string',
'description' => 'The time when acceleration was enabled.',
'title' => '',
'example' => '20250911 00:00:00',
],
'JobId' => [
'type' => 'string',
'description' => 'The acceleration task ID.',
'title' => '',
'example' => 'b30b74**********b3b',
],
'JobStatus' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The status of the task. Valid values:'."\n"
."\n"
.'- 0: Pending'."\n"
."\n"
.'- 1: Running'."\n"
."\n"
.'- 2: Succeeded'."\n"
."\n"
.'- 3: Failed'."\n"
."\n"
.'- 4: Canceled'."\n"
."\n"
.'- 5: Warning',
'title' => '',
'example' => '0',
],
'JobHistoryId' => [
'type' => 'string',
'description' => 'The task history ID.',
'title' => '',
'example' => 'QWDAASG*******8SAD',
],
],
'description' => 'An array of acceleration task information.',
'title' => '',
'example' => '',
],
'description' => 'An array of acceleration task information.',
'title' => '',
'example' => '',
],
],
'description' => 'The acceleration task model.',
'title' => '',
'example' => '',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'The schema of the response.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
[
'errorCode' => 'Invalid.Workspace',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => '',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'ListAccelerationOfWorkspace',
'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' => 'Queries API data sources.',
'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' => 'The workspace ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '89713491-cb4f-4579-b889-e82c35f1****',
'title' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'Current page number for API data source list:'."\n"
."\n"
.'* Pages start from page 1.'."\n"
.'* Default value: 1.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of rows per page in a paged query.'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Valid values: 1 to 100.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'title' => '',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => 'The keyword of the API data source name.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '测试',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The information returned.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The query results are returned.'."\n",
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The list of API data sources that were queried.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => [
'description' => 'The ID of the API data source.'."\n",
'type' => 'string',
'example' => '0f2c3c6409be4dc0810f2a5785e816a8',
'title' => '',
],
'Body' => [
'description' => 'The parameter configuration of the query statement in JSON format. You can customize the parameter configuration.'."\n",
'type' => 'string',
'example' => '{"key1":"value1"}',
'title' => '',
],
'DataSize' => [
'description' => 'The data volume of the API data source.'."\n"
."\n"
.'* Unit: Kbit/s'."\n",
'type' => 'number',
'format' => 'float',
'example' => '0.39746094',
'title' => '',
],
'DateUpdateTime' => [
'description' => 'The last synchronization time of the API data source.'."\n",
'type' => 'string',
'example' => '2022-05-25 16:19:43',
'title' => '',
],
'GmtCreate' => [
'description' => 'The time when the quota plan was created.'."\n",
'type' => 'string',
'example' => '2022-05-25 16:19:43',
'title' => '',
],
'GmtModified' => [
'description' => 'The time when the optimization job was modified.'."\n",
'type' => 'string',
'example' => '2022-05-25 16:19:43',
'title' => '',
],
'JobId' => [
'description' => 'The job ID.'."\n",
'type' => 'string',
'example' => 'REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8',
'title' => '',
],
'Parameters' => [
'description' => 'The parameter configurations in the JSONArray format.'."\n"
."\n"
.'* name: parameter name'."\n"
.'* value: the parameter value'."\n",
'type' => 'string',
'example' => '[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]',
'title' => '',
],
'ShowName' => [
'description' => 'The name of the API data source.'."\n",
'type' => 'string',
'example' => '测试数据源',
'title' => '',
],
'StatusType' => [
'description' => 'The status of the API data source synchronization task.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'* 0: the to be run.'."\n"
.'* 1: The is running.'."\n"
.'* 2: The is successfully.'."\n"
.'* 3: failed.'."\n",
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [
'',
'',
'',
'',
],
'example' => '2',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'PageSize' => [
'description' => 'The number of rows per page set when the interface is requested.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalNum' => [
'description' => 'The total number of rows.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
],
],
'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' => 'ListApiDatasource',
'description' => 'For more information about the parameters, see [Create an API data source](~~409330~~).'."\n",
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListByUserGroupId' => [
'summary' => 'Queries user group information at a time by user group 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' => 'The ID of the user group that you want to query. Separate multiple user groups with commas (,).'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '34fe-***-6dcb,84q9-****-4a274',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => 'The user group query result is returned.'."\n",
'type' => 'object',
'properties' => [
'FailedUserGroupIds' => [
'type' => 'array',
'items' => [
'description' => 'Query the failed user group ID.',
'type' => 'string',
'example' => '[]',
'title' => '',
],
'description' => 'List of failed user groups.',
'title' => '',
'example' => '',
],
'UserGroupModels' => [
'description' => 'The details of the user group that was queried.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => 'The time when the Secret was created.'."\n",
'type' => 'string',
'example' => '2021-03-15 17:13:55',
'title' => '',
],
'CreateUser' => [
'description' => 'The UserID of the creator in the Quick BI.'."\n",
'type' => 'string',
'example' => '46e5*******ee22e2a292704c8',
'title' => '',
],
'IdentifiedPath' => [
'description' => 'The path of the user group.'."\n",
'type' => 'string',
'example' => '2fe4fbd8-****-af083ea/34fd1-****-dcbc33f',
'title' => '',
],
'ModifiedTime' => [
'description' => 'The time when the protection policy was last modified.'."\n",
'type' => 'string',
'example' => '2021-03-15 20:36:40',
'title' => '',
],
'ModifyUser' => [
'description' => 'The UserID of the modifier in the Quick BI.'."\n",
'type' => 'string',
'example' => '46e5*******ee22e2a292704c8',
'title' => '',
],
'ParentUsergroupId' => [
'description' => 'The ID of the parent user group.'."\n",
'type' => 'string',
'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af083ea',
'title' => '',
],
'UsergroupDesc' => [
'description' => 'The description of the user group.'."\n",
'type' => 'string',
'example' => '描述信息',
'title' => '',
],
'UsergroupId' => [
'description' => 'The ID of the user group.'."\n",
'type' => 'string',
'example' => '34fd141d-****-4093-8c33-8e066dcbc33f',
'title' => '',
],
'UsergroupName' => [
'description' => 'The name of the user group.'."\n",
'type' => 'string',
'example' => '测试用户组',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Usergroup.Not.Exist',
'errorMessage' => 'The user group does not exist.',
'description' => 'The user group does not exist.',
],
],
],
'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' => 'ListByUserGroupId',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListCollections' => [
'summary' => 'Retrieve the list of works that a user has favorited.',
'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' => 'User ID. This refers to the UserID in Quick BI, not the Alibaba Cloud UID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'fe67f61a35a94b7da1a34ba174a7****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'The primary key ID of the favorite record.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => '162A632E-0A88-51CF-98F8-94FDEE82DB7D',
'title' => '',
],
'Result' => [
'description' => 'Details of the list of reports favored by the user.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FavoriteId' => [
'description' => 'The primary key ID of the favorite record.',
'type' => 'integer',
'format' => 'int32',
'example' => '12373',
'title' => '',
],
'OwnerId' => [
'description' => 'The user ID of the work owner. This refers to the UserID in Quick BI, not the Alibaba Cloud UID.',
'type' => 'string',
'example' => 'fe67f61a35a94b7da1a34ba174a7****',
'title' => '',
],
'WorksId' => [
'description' => 'The ID of the work.',
'type' => 'string',
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
'WorksName' => [
'description' => 'The name of the work.',
'type' => 'string',
'example' => '奇异博士',
'title' => '',
],
'WorksType' => [
'description' => 'The type of the work. Possible values:'."\n"
."\n"
.'- DATAPRODUCT: Data Portal'."\n"
.'- PAGE: Dashboard'."\n"
.'- REPORT: Spreadsheet'."\n"
.'- dataForm: Data Entry Form'."\n"
.'- dashboardOfflineQuery: Self-service Data Extraction',
'type' => 'string',
'example' => 'dashboardOfflineQuery',
'title' => '',
],
'WorkspaceId' => [
'description' => 'Workspace ID.',
'type' => 'string',
'example' => '9337d121-a78f-4c1b-a8bc-f81de117****',
'title' => '',
],
'WorkspaceName' => [
'description' => 'Workspace Name.',
'type' => 'string',
'example' => '测试工作空间',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'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' => 'ListCollections',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListCollections',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'ListCubeDataLevelPermissionConfig' => [
'summary' => 'You can this operation to obtain a list of row and column permission configurations for a specified dataset.',
'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' => 'The ID of the training dataset that you want to remove from the specified custom linguistic model.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7c7223ae-****-3c744528014b',
'title' => '',
],
],
[
'name' => 'RuleType',
'in' => 'query',
'schema' => [
'description' => 'The type of the dataset row and column permission. Valid values:'."\n"
."\n"
.'* ROW_LEVEL: row-level permissions'."\n"
.'* COLUMN_LEVEL: column-level permissions'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ROW_LEVEL',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => '{ "isOpen": 1, "extraConfigModel": { // Additional configuration information "ruleType": "ROW_LEVEL", // The row-level permission type. "missHitPolicy": "NONE", // The hit rule policy: NONE has no permissions, and ALL has permissions. "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b" // The ID of the dataset. }, "ruleType": "ROW_LEVEL", // Row-column permission type\\'."\n"
.'"ruleModels": \\[ { "ruleUsersModel": { // The target population. "userGroups": \\[ "0d5fb19b- ****-1248 fc27ca51", // The ID of the user group. "4aa3f089-****-85f0-0e8ac7c2dee9" ], "users": \\[ "HuangJia ***2e3fa822", // The ID of the user. "4334***84358" ] }, "ruleContentModel": { "ruleContentType": "ROW_FIELD", // The row-column permission type. "ruleContentJson": "{"conditionNode":{"caption": " Period ","isMeasure":false,"pathId":"7d3b073bc6","relationOperator":"not-null","name":"7d3b073bc6","value":{"value":\\[""}UM]," ENueType "} // The JSON string of the row-column permission rule. "ruleOriginConfigJson": "{"operator":"and","operands":\\[{"labelName": " Period ","isValid":true,"uniqueId":"5","fieldId":"7d3b073bc6","error":false,"fieldType":"string",": default "" value":{"conditionOp":"not-null","conditionValue":""},"valueType":"ENUM"}}],"isRelation":true}" }, // The fixed-format JSON string required by the frontend "isOpen": 1, // The status of the row-column permission configuration. 1. On. 0. Off. "hitTakeEffect": 1, // Specifies whether the rule takes effect after a column-level permission is hit. 1 takes effect and 0 takes effect. "ruleName": "Test row-level permission_Do not delete", // The name of the row-column permission rule. "ruleLevelType": "ROW_LEVEL", // The row-column permission type. "ruleId": "a5bb24 da-772f-45e8-a43c-a891683e14da", // The ID of the row-column permission rule. "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b", // The ID of the dataset. "ruleTargetScope": "OTHERS" rule takes effect: ALL owner and OTHERS designated owner. } ], "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b" // The ID of the dataset. }'."\n",
'type' => 'string',
'example' => '行列权限列表的JSON串，详情见描述。',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'CubePermission.Columnlevel.VersionError',
'errorMessage' => 'You are not allowed to use the new dataLevelPermission API.',
'description' => 'You are not allowed to use new dataLevelPermission api.',
],
[
'errorCode' => 'RowLevelPermission.SwitchClose.Error',
'errorMessage' => 'The row level permission switch must be on.',
'description' => 'Row lever permission switch must be open.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotExsist',
'errorMessage' => 'The row level permission rule does not exist: %s.',
'description' => 'The row level permission rule does not exist: %s.',
],
[
'errorCode' => 'RowLevelPermission.Rule.NotBelongToCube',
'errorMessage' => 'The row level permission rule does not belong to the current cube.',
'description' => 'The row level permission rule does not belong to the current cube.',
],
[
'errorCode' => 'Cube.NotBelongTo.CurrentOrganization',
'errorMessage' => 'The cube does not belong to the current organization %s.',
'description' => 'Cube do not belong to current organization:%s.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": \\"行列权限列表的JSON串，详情见描述。\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'ListCubeDataLevelPermissionConfig',
'description' => '> : You can only Quick BI the new row-column permission model. If you are still using the old row-column permission model, migrate to the new row-column permission model before you call this operation. To migrate row-level permissions to the new row-level permission model, perform the following steps: Choose Organizations> Security Configurations> Upgrade Row-Level Permissions. On the Upgrade Row-Level Permissions page, click **Upgrade**.'."\n",
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:57.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListDataLevelPermissionWhiteList' => [
'summary' => 'Retrieve the whitelist for dataset row and column permissions based on the type of permission.',
'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' => 'Dataset ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3d5db23c-e4f2-49dd-a883-92285b48e14a',
'title' => '',
],
],
[
'name' => 'RuleType',
'in' => 'query',
'schema' => [
'description' => 'Type of row and column permission that the whitelist belongs to:'."\n"
."\n"
.'- ROW_LEVEL: Row-level permission'."\n"
.'- COLUMN_LEVEL: Column-level permission',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ROW_LEVEL',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => 'Whitelist for the specified row-level permission type.',
'type' => 'object',
'properties' => [
'CubeId' => [
'description' => 'Dataset ID.',
'type' => 'string',
'example' => '7c7223ae-****-3c744528014b',
'title' => '',
],
'RuleType' => [
'description' => 'Type of dataset row and column permissions. Possible values:'."\n"
."\n"
.'- ROW_LEVEL: Row-level permission'."\n"
.'- COLUMN_LEVEL: Column-level permission',
'type' => 'string',
'example' => 'ROW_LEVEL',
'title' => '',
],
'UsersModel' => [
'description' => 'Whitelist information.',
'type' => 'object',
'properties' => [
'UserGroups' => [
'type' => 'array',
'items' => [
'description' => 'User group ID.',
'type' => 'string',
'example' => '0d5fb19b-***-1248fc27ca51',
'title' => '',
],
'description' => 'UserGroups.',
'title' => '',
'example' => '',
],
'Users' => [
'type' => 'array',
'items' => [
'description' => 'UserID of Quick BI users.',
'type' => 'string',
'example' => '4334***358',
'title' => '',
],
'description' => 'Users.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Get Dataset Row and Column Permission Whitelist',
'description' => '> This API only supports the new row and column permission model of Quick BI. If you are still using the old row and column permissions, please migrate to the new row and column permission model before calling this interface. To migrate to the new row and column permission model, follow these steps: In Organization Management -> Security Configuration -> Upgrade Row and Column Permissions, click **One-Click Upgrade** to upgrade to the new row-level permissions.',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListDataLevelPermissionWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListDataSource' => [
'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' => 'Workspace ID.',
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => '95296e95-******c7d-8af9-dedf0ad0****',
],
],
[
'name' => 'DsType',
'in' => 'query',
'schema' => [
'description' => 'Data source type.',
'type' => 'string',
'required' => false,
'example' => 'mysql',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => 'Request ID.',
'type' => 'string',
'example' => '7FC9A6A6-****-5CED-B*****E891E4075',
],
'Result' => [
'title' => '数据源信息数组',
'description' => 'Array of data source information.',
'type' => 'array',
'items' => [
'title' => '数据源信息',
'description' => 'Data source information.',
'type' => 'object',
'properties' => [
'CreatorId' => [
'title' => '创建人的Quick BI用户ID。',
'description' => 'Quick BI user ID of the creator.',
'type' => 'string',
'example' => '281*****-485******-8',
],
'CreatorName' => [
'title' => '所有者昵称',
'description' => 'Owner\'s nickname.',
'type' => 'string',
'example' => 'system',
],
'DatasourceId' => [
'title' => '数据源的id',
'description' => 'Data source ID.',
'type' => 'string',
'example' => '7FC9A6A6-****-5CED-B*****E891E4075',
],
'GmtCreate' => [
'title' => '数据源创建时间，yyyy-MM-dd HH:mm:ss',
'description' => 'Creation time of the data source, in yyyy-MM-dd HH:mm:ss format.',
'type' => 'string',
'example' => '2024-04-16 13:17:39',
],
'GmtModified' => [
'title' => '修改时间',
'description' => 'Modification time.',
'type' => 'string',
'example' => '2024-08-15 10:06:31',
],
'ShowName' => [
'title' => '数据源展示名称',
'description' => 'Display name of the data source.',
'type' => 'string',
'example' => '0327',
],
'DsType' => [
'title' => '数据源类型',
'description' => 'Data source type.',
'type' => 'string',
'example' => 'odps',
],
'ParentDsType' => [
'title' => '多引擎数据源的主数据源类型',
'description' => 'Primary data source type for multi-engine data sources.',
'type' => 'string',
'example' => 'dataphin',
],
],
'example' => '',
],
'example' => '',
],
'Success' => [
'title' => '请求是否成功',
'description' => 'Whether the request was successful.',
'type' => 'boolean',
'example' => 'true',
],
],
'example' => '',
],
],
],
'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',
],
'title' => 'ListDataSource',
'summary' => 'Query all data sources under the specified space',
'requestParamsDescription' => 'Data source type codes: '."\n"
.'- garuda -- garuda data source '."\n"
.'- adb -- ADB 3.0 '."\n"
.'- oracle -- Oracle data source '."\n"
.'- mysql -- MySQL data source '."\n"
.'- mysql_hybrid -- HybridDB for MySQL data source '."\n"
.'- odps -- ODPS data source '."\n"
.'- sqlserver -- SQL Server data source '."\n"
.'- greenplum -- Greenplum data source '."\n"
.'- postgresql -- PostgreSQL data source '."\n"
.'- ppas -- RDS PPAS data source '."\n"
.'- oscar -- Shentong data source '."\n"
.'- hive -- Hive data source '."\n"
.'- vertica -- Vertica data source '."\n"
.'- db2 -- IBM DB2 data source (LUW) '."\n"
.'- sybase -- SAP SYBASE IQ data source '."\n"
.'- hana -- SAP HANA data source '."\n"
.'- dla -- DataLake Analytics data source '."\n"
.'- oss -- OSS data source '."\n"
.'- drds -- DRDS data source '."\n"
.'- clivia -- super-engine '."\n"
.'- presto -- Presto data source '."\n"
.'- polardb -- PolarDB data source '."\n"
.'- tsdb -- TSDB data source '."\n"
.'- lindorm_tsdb -- LindormTSDB data source '."\n"
.'- lindorm_wide_table_engine -- Lindorm wide table engine data source '."\n"
.'- lindorm_multi_mode -- Lindorm multi-mode SQL data source '."\n"
.'- hbase -- HBase data source '."\n"
.'- phoenix_thin -- PHOENIX THIN data source '."\n"
.'- dataphin -- DataPhin data source multi-engine '."\n"
.'- dataphin_odps -- DataPhin data source ODPS engine'."\n"
.' - dataphin_hive -- DataPhin data source Hive engine '."\n"
.'- dataphin_v2_odps -- New DataPhin data source ODPS engine '."\n"
.'- dataphin_v2_hive -- New DataPhin data source Hive engine '."\n"
.'- kbase -- KingBase data source '."\n"
.'- clickhouse -- ClickHouse data source '."\n"
.'- tdsql -- TDSQL-H data source '."\n"
.'- gbase -- Gbase data source '."\n"
.'- polardb_pg -- Polardb for PG data source '."\n"
.'- hologres -- Hologres data source '."\n"
.'- impala -- Impala data source '."\n"
.'- impala_v3 -- Impala 3.x data source '."\n"
.'- dingtalk -- DingTalk smart report data source '."\n"
.'- snowflake -- Snowflake data source '."\n"
.'- kylin -- Kylin data source '."\n"
.'- multiDatasource -- Cross-source '."\n"
.'- oceanbase_mysql -- OceanBase MySQL mode data source '."\n"
.'- oceanbase_oracle -- OceanBase Oracle mode data source '."\n"
.'- spark_sql -- Spark SQL data source '."\n"
.'- starrocks -- StarRocks data source '."\n"
.'- apache_doris -- Apache Doris data source '."\n"
.'- selectdb -- SelectDB data source '."\n"
.'- mongodb -- MongoDB data source '."\n"
.'- dm -- DM7 data source '."\n"
.'- Dameng - unicorn -- Unicorn data source '."\n"
.'- sls -- SLS data source '."\n"
.'- gaussdb_dws -- GaussDB DWS data source '."\n"
.'- gaussdb -- GaussDB data source '."\n"
.'- elasticsearch -- Elasticsearch '."\n"
.'- dms -- DMS logical data warehouse'."\n"
.' - yida -- Yida application data source '."\n"
.'- relyt -- Relyt '."\n"
.'- Lark_bitable -- Lark bitable '."\n"
.'- Lark_spreadsheet -- Lark spreadsheet '."\n"
.'- tidb -- TiDB data source '."\n"
.'- mariadb -- MariaDB data source '."\n"
.'- adb_spark -- ADB data source Spark engine',
'changeSet' => [
[
'createdAt' => '2025-08-11T03:10:11.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'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"}]',
'translator' => 'machine',
],
'ListFavoriteReports' => [
'summary' => 'Overview',
'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' => 'The UserID of the user in Quick BI to be queried.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b5d8fd9348cc4327****afb604',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => 'Keyword of the work name.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '财务报表',
'title' => '',
],
],
[
'name' => 'TreeType',
'in' => 'query',
'schema' => [
'description' => 'Type of the work to be queried (leave blank to query all types). Value range:'."\n"
.'- DATAPRODUCT: Data Portal'."\n"
.'- PAGE: Dashboard'."\n"
.'- REPORT: Spreadsheet',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'PAGE',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Number of rows in the work list to be queried:'."\n"
.'Default value: 10'."\n"
.'Maximum value: 9999',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'default' => '10',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Returns the query result.',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'List of works queried.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Favorite' => [
'description' => 'Indicates whether the user has favorited the work.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'FavoriteDate' => [
'description' => 'The timestamp when the work was favorited.',
'type' => 'string',
'example' => '1640088615000',
'title' => '',
],
'GmtCreate' => [
'description' => 'Timestamp of the work creation.',
'type' => 'string',
'example' => '1640088615000',
'title' => '',
],
'GmtModified' => [
'description' => 'Timestamp of the work modification.',
'type' => 'string',
'example' => '1640595729000',
'title' => '',
],
'HasEditAuth' => [
'description' => 'Indicates whether the user has edit permission for the work.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'HasViewAuth' => [
'description' => 'Check if the user has the permission to view the work.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Name' => [
'description' => 'Name of the work.',
'type' => 'string',
'example' => '测试报表',
'title' => '',
],
'OwnerName' => [
'description' => 'Alibaba Cloud account name of the work owner.',
'type' => 'string',
'example' => 'luyaotest的昵称非管理员',
'title' => '',
],
'OwnerNum' => [
'description' => 'UserID of the work owner.',
'type' => 'string',
'example' => '1365*****238860',
'title' => '',
],
'PublishStatus' => [
'description' => 'Publication status of the work. Value range:'."\n"
.'- 0: Not published'."\n"
.'- 1: Published'."\n"
.'- 2: Saved with modifications, not published'."\n"
.'- 3: Offline',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TreeId' => [
'description' => 'Work ID.',
'type' => 'string',
'example' => '977c7698-****-****-****-44b7304d20fc',
'title' => '',
],
'Type' => [
'description' => 'Type of the work. Value range:'."\n"
.'- DATAPRODUCT: Data Portal'."\n"
.'- PAGE: Dashboard'."\n"
.'- REPORT: Spreadsheet',
'type' => 'string',
'example' => 'PAGE',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The ID of the workspace to which the work belongs.',
'type' => 'string',
'example' => '523793cb-****-****-****-aa71c65ffa39',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the workspace to which the work belongs.',
'type' => 'string',
'example' => '测试工作空间',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'Page number.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'PageSize' => [
'description' => 'Number of rows per page set when requesting the interface.',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalNum' => [
'description' => 'Total number of rows.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TotalPages' => [
'description' => 'Total number of pages.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful.'."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Favorite Reports List on Home Dashboard',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListFavoriteReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'ListOrganizationRoleUsers' => [
'summary' => 'Get user list under the specified organization role.',
'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' => 'Organization role ID, including predefined roles and custom roles:'."\n"
."\n"
.'- Organization Administrator (predefined role): 111111111'."\n"
.'- Permission Administrator (predefined role): 111111112'."\n"
.'- Regular User (predefined role): 111111113'."\n"
.'- Custom Role: The corresponding role ID for a custom role',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '111111111',
'title' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'Page number.'."\n"
."\n"
.'- Default value is 1.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Number of items per page.'."\n"
.'- Default value is 10.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => 'Keyword for the nickname of the organization member.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '小刘',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'BCE45E6D-9304-4F94-86BB-5A772B1615FF',
'title' => '',
],
'Result' => [
'description' => 'Returns the list of users under the organization role.',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'User list.',
'type' => 'array',
'items' => [
'description' => 'User details.',
'type' => 'object',
'properties' => [
'NickName' => [
'description' => 'Nickname of the organization member.',
'type' => 'string',
'example' => '测试用户',
'title' => '',
],
'UserId' => [
'description' => 'UserID of the organization member in Quick BI.',
'type' => 'string',
'example' => 'b5d8fd9348cc4327****afb604',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'Page number.',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'PageSize' => [
'description' => 'Number of items per page as set in the request.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TotalNum' => [
'description' => 'Total number of items.',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalPages' => [
'description' => 'Total number of pages.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'ListOrganizationRoleUsers',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListOrganizationRoleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListOrganizationRoles' => [
'summary' => 'Retrieve the list of custom roles at the organization level.',
'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' => 'Request ID.',
'type' => 'string',
'example' => '7AAB95D7-2E11-4FE2-94BC-858E4FC0C976',
'title' => '',
],
'Result' => [
'description' => 'Returns the list of organization roles.',
'type' => 'array',
'items' => [
'description' => 'Details of role configuration.',
'type' => 'object',
'properties' => [
'AuthConfigList' => [
'description' => 'List of role permission configurations.',
'type' => 'array',
'items' => [
'description' => 'Specific permission configuration.',
'type' => 'object',
'properties' => [
'AuthKey' => [
'description' => 'Permission type:'."\n"
.'- quick_monitor: Metric monitoring'."\n"
.'- subscription: Subscription management'."\n"
.'- offline_download: Self-service data retrieval'."\n"
.'- resource_package: Resource package management'."\n"
.'- organization_ask: Organization identification code (AK/SK)'."\n"
.'- developer_openapi: OpenAPI'."\n"
.'- data_service: Data service'."\n"
.'- admin_authorize3rd: Embedded analysis'."\n"
.'- component_manage: Custom component'."\n"
.'- template_open: Custom template'."\n"
.'- custom_driver: Custom driver (supported only in standalone deployment)'."\n"
.'- open_platform_custom_plugin: Custom plugin (supported only in standalone deployment)'."\n"
.'- enterprise_safety: Enterprise security',
'type' => 'string',
'example' => 'enterprise_safety',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'IsSystemRole' => [
'description' => 'Whether it is a predefined role. Possible values:'."\n"
.'- true: Yes'."\n"
.'- false: No',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RoleId' => [
'description' => 'Role ID.',
'type' => 'integer',
'format' => 'int64',
'example' => '111111111',
'title' => '',
],
'RoleName' => [
'description' => 'Role name.',
'type' => 'string',
'example' => '组织管理员',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Get Organization Role List',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListOrganizationRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'ListPortalMenuAuthorization' => [
'summary' => 'Retrieves a list of authorization details for the menus in a BI portal.',
'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' => 'The ID of the BI portal.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '0d173abb53e84c8ca7495429163b****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
],
'Result' => [
'description' => 'A list of authorization details for the BI portal menus.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MenuId' => [
'description' => 'The ID of the leaf-node menu in the BI portal.',
'type' => 'string',
'title' => '',
'example' => '54kqgoa****',
],
'Receivers' => [
'description' => 'The details of the authorization objects for the menu.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverId' => [
'description' => 'The ID of the authorization object.'."\n"
."\n"
.'> - If the authorization object is an organization, this ID is the organization ID.'."\n"
.'>'."\n"
.'> - If the authorization object is a workspace, this ID is the workspace ID.',
'type' => 'string',
'title' => '',
'example' => '121344444790****',
],
'ReceiverType' => [
'description' => 'The type of the authorization object. Valid values:'."\n"
."\n"
.'- 0: User'."\n"
."\n"
.'- 1: User group'."\n"
."\n"
.'- 2: Organization'."\n"
."\n"
.'- 3: Workspace',
'type' => 'integer',
'format' => 'int32',
'title' => '',
'example' => '0',
],
'AuthPointsValue' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'description' => 'The authorization type for the menu. Valid values:'."\n"
."\n"
.'- 1: View'."\n"
."\n"
.'- 11: Edit'."\n"
."\n"
.'- 3: Export and view'."\n"
."\n"
.'- 10: Manage data entry',
'title' => '',
'example' => '1',
],
],
'description' => 'The details of the authorization objects for the menu.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ShowOnlyWithAccess' => [
'description' => 'Indicates whether the menu is visible only to authorized users. Valid values:'."\n"
."\n"
.'- true: The menu is visible only to authorized users.'."\n"
."\n"
.'- false: The menu is visible to all users.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => 'A list of authorization details for the portal menus.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'ListPortalMenuAuthorization',
'changeSet' => [
[
'createdAt' => '2025-08-11T03:10:11.000Z',
'description' => 'Response parameters changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListPortalMenuAuthorization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'ListPortalMenuAuthorization',
],
],
],
],
'ListPortalMenus' => [
'summary' => 'Gets a hierarchical list of menus under a specific BI portal.',
'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' => 'The ID of the BI portal.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0d173abb53e84c8ca7495429163b****',
'title' => '',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The user ID in the Quick BI. When passed in, the list displays only the menus that the user has permissions on.'."\n",
'type' => 'string',
'required' => false,
'example' => '1234567***',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => '75912036-5527-4B7E-9265-B481D6651AC2',
'title' => '',
],
'Result' => [
'description' => 'A JSON string that levels the details of the portal menu list. Valid values:'."\n"
."\n"
.'* menuType: the type of the menu.'."\n"
."\n"
.' * 0: dashboard'."\n"
.' * 1: outer chain'."\n"
.' * 2: workbook'."\n"
.' * 4: directory folder'."\n"
.' * 5: form filling'."\n"
.' * 6: self-service data retrieval'."\n"
."\n"
.'* menuId: menu ID'."\n"
."\n"
.'* uri: ID or URL of the resource associated with the menu'."\n"
."\n"
.'* showOnlyWithAccess: Authorized Only Visible'."\n"
."\n"
.'* menuName: menu display name'."\n"
."\n"
.'* dependentPermisson: whether the report resource associated with the menu has permissions'."\n"
."\n"
.'* children: submenu'."\n",
'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}]',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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":"","errorExample":""}]',
'title' => 'ListPortalMenus',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:31.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListPortalMenus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListRecentViewReports' => [
'summary' => 'You can call this operation to obtain a list of the most frequently viewed and footsteps displayed in the homepage dashboard for a specified user.',
'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' => 'The UserID of the user in the Quick BI.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b5d8fd9348cc4327****afb604',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => 'Keyword of the name of the work.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '财务报表',
'title' => '',
],
],
[
'name' => 'TreeType',
'in' => 'query',
'schema' => [
'description' => 'Query the type of the work (fill in the blank to query all types). Valid values:'."\n"
."\n"
.'* DATAPRODUCT: BI portal'."\n"
.'* PAGE: Dashboard'."\n"
.'* REPORT: workbook'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'PAGE',
'title' => '',
],
],
[
'name' => 'QueryMode',
'in' => 'query',
'schema' => [
'description' => 'The query mode. Valid values:'."\n"
."\n"
.'* 1: Sort by number of visits'."\n"
.'* 2: Sort by Last Access Time'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '1',
'default' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Query the number of rows in the work list:'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Maximum value: 9999'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'default' => '10',
'title' => '',
],
],
[
'name' => 'OffsetDay',
'in' => 'query',
'schema' => [
'description' => 'The number of days to query data in the last few days. Default value: 10.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'default' => '10',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The query results are returned.'."\n",
'type' => 'object',
'properties' => [
'Attention' => [
'type' => 'string',
'example' => '当前API返回的分页参数如TotalNum等即将下线，如有使用请及时修改',
'default' => '当前API返回的分页参数如TotalNum等即将下线，如有使用请及时修改',
'description' => 'Attention',
'title' => '',
],
'Data' => [
'description' => 'The list of queried works.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Favorite' => [
'description' => 'Queries whether the user has collected the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'GmtCreate' => [
'description' => 'The timestamp when the work was created.'."\n",
'type' => 'string',
'example' => '1496651577000',
'title' => '',
],
'GmtModified' => [
'description' => 'The timestamp when the work was modified.'."\n",
'type' => 'string',
'example' => '1640595729000',
'title' => '',
],
'HasEditAuth' => [
'description' => 'The query user has the editing rights of the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'HasViewAuth' => [
'description' => 'The query user has the permission to view the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'LatestViewTime' => [
'description' => 'The timestamp when the work was last accessed.'."\n",
'type' => 'string',
'example' => '1642067498000',
'title' => '',
],
'Name' => [
'description' => 'The name of the work.'."\n",
'type' => 'string',
'example' => '测试报表',
'title' => '',
],
'OwnerName' => [
'description' => 'The Alibaba Cloud account name of the work owner.'."\n",
'type' => 'string',
'example' => '李四',
'title' => '',
],
'OwnerNum' => [
'description' => 'The UserID of the work owner.'."\n",
'type' => 'string',
'example' => '1365*****238860',
'title' => '',
],
'PublishStatus' => [
'description' => 'The publication status of the work. Valid values:'."\n"
."\n"
.'* 0: unpublished'."\n"
.'* 1: published'."\n"
.'* 2: modified and saved but not published.'."\n"
.'* 3: unpublished'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TreeId' => [
'description' => 'The ID of the work.'."\n",
'type' => 'string',
'example' => '977c7698-****-****-****-44b7304d20fc',
'title' => '',
],
'Type' => [
'description' => 'The type of the work. Valid values:'."\n"
."\n"
.'* DATAPRODUCT: BI portal'."\n"
.'* PAGE: Dashboard'."\n"
.'* REPORT: workbook'."\n",
'type' => 'string',
'example' => 'PAGE',
'title' => '',
],
'ViewCount' => [
'description' => 'The number of times the work was accessed.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '7',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The ID of the workspace to which the work belongs.'."\n",
'type' => 'string',
'example' => '523793cb-****-****-****-aa71c65ffa39',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the workspace to which the work belongs.'."\n",
'type' => 'string',
'example' => '测试工作空间',
'title' => '',
],
],
'description' => 'The list of API data sources that were queried.'."\n",
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'The page number of the returned page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'PageSize' => [
'description' => 'The number of entries returned per page.'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Maximum of 100 articles'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalNum' => [
'description' => 'The total number of rows in the table.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TotalPages' => [
'description' => 'The total number of pages returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'ListRecentViewReports',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListRecentViewReports',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListSharedReports' => [
'summary' => 'You can this operation to obtain the list of authorized works displayed on the homepage of a specified user.',
'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' => 'The UserID of the user to be queried in the Quick BI.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b5d8fd9348cc4327****afb604',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => 'Keyword of the name of the work.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '测试报表',
'title' => '',
],
],
[
'name' => 'TreeType',
'in' => 'query',
'schema' => [
'description' => 'Query the type of the work (fill in the blank to query all types). Valid values:'."\n"
."\n"
.'* DATAPRODUCT: BI portal'."\n"
.'* PAGE: Dashboard'."\n"
.'* REPORT: workbook'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'PAGE',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Query the number of rows in the work list:'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Maximum value: 9999'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'default' => '10',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'The query results are returned.'."\n",
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The list of queried works.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Favorite' => [
'description' => 'Queries whether the user has collected the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'GmtCreate' => [
'description' => 'The timestamp when the work was created.'."\n",
'type' => 'string',
'example' => '1640088615000',
'title' => '',
],
'GmtModified' => [
'description' => 'The timestamp when the work was modified.'."\n",
'type' => 'string',
'example' => '1644373980000',
'title' => '',
],
'HasEditAuth' => [
'description' => 'The query user has the editing rights of the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'HasViewAuth' => [
'description' => 'The query user has the permission to view the work.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Name' => [
'description' => 'The name of the work.'."\n",
'type' => 'string',
'example' => '测试报表',
'title' => '',
],
'OwnerName' => [
'description' => 'The Alibaba Cloud account name of the work owner.'."\n",
'type' => 'string',
'example' => 'test账号',
'title' => '',
],
'OwnerNum' => [
'description' => 'The UserID of the work owner.'."\n",
'type' => 'string',
'example' => '1365*****238860',
'title' => '',
],
'PublishStatus' => [
'description' => 'The publication status of the work. Valid values:'."\n"
."\n"
.'* 0: unpublished'."\n"
.'* 1: published'."\n"
.'* 2: modified and saved but not published.'."\n"
.'* 3: unpublished'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TreeId' => [
'description' => 'The ID of the work.'."\n",
'type' => 'string',
'example' => '977c7698-****-****-****-44b7304d20fc',
'title' => '',
],
'Type' => [
'description' => 'The type of the work. Valid values:'."\n"
."\n"
.'* DATAPRODUCT: BI portal'."\n"
.'* PAGE: Dashboard'."\n"
.'* REPORT: workbook'."\n",
'type' => 'string',
'example' => 'PAGE',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The ID of the workspace to which the work belongs.'."\n",
'type' => 'string',
'example' => 'gfidm145-****-****-9426-8f93be23****',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the workspace to which the work belongs.'."\n",
'type' => 'string',
'example' => '测试工作空间',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'The page number of the returned page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'PageSize' => [
'description' => 'The number of rows per page set when the interface is requested.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalNum' => [
'description' => 'The total number of rows in the table.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TotalPages' => [
'description' => 'The total number of pages returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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":"","errorExample":""}]',
'title' => 'ListSharedReports',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListUserGroupsByUserId' => [
'summary' => 'Queries all user groups to which a user belongs based on the user ID.',
'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' => 'The ID of the user. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46e5374665ba4b679ee22e2a2927****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'E2440604-3059-561A-AD68-DEDBC870EB2B',
'title' => '',
],
'Result' => [
'description' => 'The information about the group.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => 'The time when the user group was created.'."\n",
'type' => 'string',
'example' => '2021-03-15 17:13:55',
'title' => '',
],
'CreateUser' => [
'description' => 'The user group creator. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.'."\n",
'type' => 'string',
'example' => '46e5374665ba4b679ee22e2a2927****',
'title' => '',
],
'IdentifiedPath' => [
'description' => 'Directory level of the user group.'."\n",
'type' => 'string',
'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****',
'title' => '',
],
'ModifiedTime' => [
'description' => 'The time when the user group was last modified.'."\n",
'type' => 'string',
'example' => '2021-03-15 20:36:40',
'title' => '',
],
'ModifyUser' => [
'description' => 'The user group modifier. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.'."\n",
'type' => 'string',
'example' => '46e5374665ba4b679ee22e2a2927****',
'title' => '',
],
'ParentUsergroupId' => [
'description' => 'The ID of the user group.'."\n",
'type' => 'string',
'example' => '2fe4fbd8-588f-489a-b3e1-e92c7af0****',
'title' => '',
],
'UsergroupDesc' => [
'description' => 'The description of the user group.'."\n",
'type' => 'string',
'example' => '备注',
'title' => '',
],
'UsergroupId' => [
'description' => 'The ID of the user group.'."\n",
'type' => 'string',
'example' => '34fd141d-4598-4093-8c33-8e066dcb****',
'title' => '',
],
'UsergroupName' => [
'description' => 'The name of the user group.'."\n",
'type' => 'string',
'example' => '测试用户组',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'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":"","errorExample":""}]',
'title' => 'ListUserGroupsByUserId',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2022-03-04T09:50:58.000Z',
'description' => 'OpenAPI offline',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListUserGroupsByUserId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListWhitePortalMenu' => [
'summary' => 'Retrieves the whitelist for a BI portal menu.',
'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' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The ID of the BI portal.',
'title' => '',
'example' => 'asdagad***213425',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The request ID.',
'title' => '',
'example' => 'DC4E1**********0DF67E2C3',
],
'Result' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverId' => [
'type' => 'string',
'title' => '',
'description' => 'The ID of the authorization object. If the authorization is at the workspace or organization level, this parameter returns the workspace ID or organization ID.',
'example' => '8a4***********1e769',
],
'ReceiverType' => [
'type' => 'integer',
'format' => 'int32',
'title' => '',
'description' => 'The type of the authorization object. Valid values:'."\n"
."\n"
.'- 0: User'."\n"
."\n"
.'- 1: User group'."\n"
."\n"
.'- 3: Workspace or organization level',
'example' => '0',
],
'AuthPointsValue' => [
'type' => 'integer',
'format' => 'int32',
'title' => '',
'description' => 'The authorization type for the menu. Valid values:'."\n"
."\n"
.'- 1: View'."\n"
."\n"
.'- 3: Export and view',
'example' => '1',
],
],
'description' => 'Whitelist information.',
'title' => '',
'example' => '',
],
'description' => 'The whitelist.',
'title' => '',
'example' => '',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'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' => 'The group workspace does not exist.',
],
[
'errorCode' => 'NoPermissionTo.Operate.Object',
'errorMessage' => 'You are not authorized to operate the objects.',
'description' => 'You are not authorized to do this.',
],
[
'errorCode' => 'Invalid.Workspace',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => '',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'ListWhitePortalMenu',
'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' => 'Get user list under the specified workspace role.',
'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' => 'Workspace role ID, including predefined roles and custom roles:'."\n"
."\n"
.'- 25: Workspace Administrator (predefined role)'."\n"
.'- 26: Developer (predefined role)'."\n"
.'- 27: Analyst (predefined role)'."\n"
.'- 30: Viewer (predefined role)'."\n"
.'- Custom roles: The corresponding role ID for custom roles',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '25',
'title' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the workspace. This parameter is optional. If you do not set this parameter, the roles of all workspaces are returned.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '726bee5a-****-43e1-9a8e-b550f0120f35',
'title' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'Current page number for pagination:'."\n"
."\n"
.'- Starting value: 1'."\n"
.'- Default value: 1',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Number of items per page for pagination:'."\n"
."\n"
.'- Default value: 10'."\n"
.'- Maximum value: 1000',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '10',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => 'Keyword for the user\'s nickname.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '测试pop用户',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'Returns the list of users under the specified workspace role.',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'User list.',
'type' => 'array',
'items' => [
'description' => 'User details.',
'type' => 'object',
'properties' => [
'NickName' => [
'description' => 'Nickname of the organization member.',
'type' => 'string',
'example' => '测试用户',
'title' => '',
],
'UserId' => [
'description' => 'UserID of the organization member in Quick BI.',
'type' => 'string',
'example' => 'b5d8fd9348cc4327****afb604'."\n",
'title' => '',
],
'WorkspaceId' => [
'description' => 'Workspace ID.',
'type' => 'string',
'example' => '7350a155-0e94-4c6c-8620-57bbec38****',
'title' => '',
],
'WorkspaceName' => [
'description' => 'Workspace name.',
'type' => 'string',
'example' => '测试空间',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNum' => [
'description' => 'Page number.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'PageSize' => [
'description' => 'Number of items per page as set in the request.',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'title' => '',
],
'TotalNum' => [
'description' => 'Total number of items.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'TotalPages' => [
'description' => 'Total number of pages.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful. '."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'ListWorkspaceRoleUsers',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListWorkspaceRoleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ListWorkspaceRoles' => [
'summary' => 'Get the list of workspace roles.',
'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' => 'Workspace ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'description' => 'List of workspace roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AuthConfigList' => [
'description' => 'List of role authorization configurations.',
'type' => 'array',
'items' => [
'description' => 'Specific authorization configuration.',
'type' => 'object',
'properties' => [
'ActionAuthKeys' => [
'description' => 'Authorization scope.',
'type' => 'array',
'items' => [
'description' => 'Specific permissions:'."\n"
.'- edit: Create'."\n"
.'- use: Use'."\n"
.'- list: Display list',
'type' => 'string',
'example' => 'edit',
'title' => '',
],
'title' => '',
'example' => '',
],
'AuthKey' => [
'description' => 'Authorization type:'."\n"
.'- portal_create: Data Portal'."\n"
.'- dashboard_create: Dashboard'."\n"
.'- report_create: Spreadsheet'."\n"
.'- screen_create: Data Screen'."\n"
.'- analysis: Ad-hoc Analysis'."\n"
.'- offline_download: Self-service Data Retrieval'."\n"
.'- data_form: Data Entry'."\n"
.'- quick_etl: Data Preparation'."\n"
.'- cube: Dataset'."\n"
.'- datasource: Data Source',
'type' => 'string',
'example' => 'portal_create',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'IsSystemRole' => [
'description' => 'Whether it is a predefined role. Value range:'."\n"
."\n"
.'- true: Yes'."\n"
.'- false: No',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'RoleId' => [
'description' => 'Workspace role ID, including predefined and custom roles:'."\n"
."\n"
.'- 25: Workspace Administrator (predefined role)'."\n"
.'- 26: Developer (predefined role)'."\n"
.'- 27: Analyst (predefined role)'."\n"
.'- 30: Viewer (predefined role)'."\n"
.'- Custom role: The corresponding role ID for a custom role',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
'title' => '',
],
'RoleName' => [
'description' => 'Role name.',
'type' => 'string',
'example' => '空间管理员',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful. '."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'ListWorkspaceRoles',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:ListWorkspaceRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
],
'ListWorkspaceUserRolesByUserId' => [
'summary' => 'Queries all workspace roles of a user.',
'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' => 'The ID of the Quick BI user. This is not your Alibaba Cloud account ID. You can call the [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) operation to obtain the user ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'afas-********asfasg',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'DC4E***************F67E2C3',
],
'Result' => [
'title' => '',
'description' => 'The list of all workspace role information.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'Each workspace object.',
'type' => 'object',
'properties' => [
'WorkspaceId' => [
'title' => '',
'description' => 'The workspace ID.',
'type' => 'string',
'example' => '9337d121-a78f-4c1b-a8bc-f81de117****',
],
'WorkspaceName' => [
'title' => '',
'description' => 'The workspace name.',
'type' => 'string',
'example' => 'test',
],
'RoleModel' => [
'title' => '',
'description' => 'The workspace role information.',
'type' => 'object',
'properties' => [
'RoleId' => [
'title' => '',
'description' => 'The workspace role ID. This includes, but is not limited to, the following preset workspace roles:'."\n"
."\n"
.'- 25: Workspace Admin (preset role)'."\n"
."\n"
.'- 26: Workspace Developer (preset role)'."\n"
."\n"
.'- 27: Workspace Analyst (preset role)'."\n"
."\n"
.'- 30: Workspace Viewer (preset role)',
'type' => 'string',
'example' => '111111111',
],
'RoleCode' => [
'title' => '',
'description' => 'The code that corresponds to the preset workspace role. This parameter is not returned for custom roles.',
'type' => 'string',
'example' => '34637***35',
],
'RoleName' => [
'title' => '',
'description' => 'The name of the workspace role.',
'type' => 'string',
'example' => 'arms-admin',
],
],
'example' => '',
],
],
'example' => '',
],
'required' => true,
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'User.Not.In.Organization',
'errorMessage' => 'The specified user is not in the organizational unit.',
'description' => 'The specified user is not in the organizational unit.',
],
],
],
'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' => 'ListWorkspaceUserRolesByUserId',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ManualRunMailTask' => [
'summary' => 'Manually Execute Email Task',
'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' => 'The ID of the email task in the subscription management interface.',
'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' => 'Request ID.',
'type' => 'string',
'example' => 'a4d1a221d-41za1-****',
],
'Result' => [
'description' => 'Indicates whether the execution was successful.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Value range:'."\n"
.'- true: The request succeeded '."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'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' => 'ManualRunMailTask',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'quickbi-public:ManualRunMailTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ModifyApiDatasourceParameters' => [
'summary' => 'Modifies the configurations of a specified API data source.',
'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' => 'The ID of the API data source.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b66a66de51f24d149116c17718138194',
'title' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The workspace ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '726bee5a-****-43e1-9a8e-b550f0120f35',
'title' => '',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'schema' => [
'description' => 'The configuration of API data parameters in the JSONArray format. You can modify a maximum of 10 parameters.'."\n"
."\n"
.'* name: the name of a common parameter or a parameter in a query statement'."\n"
.'* value: the value of a common parameter or a parameter in a query statement.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The information returned.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'D8749D65-E80A-433C-AF1B-CE9C180FF3B4',
'title' => '',
],
'Result' => [
'description' => 'The execution result of the interface. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ApiDataSource.NotIn.Workspace',
'errorMessage' => 'Target apiId not in target workspace.',
'description' => '',
],
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'ApiDatasource.Not.Exist',
'errorMessage' => 'Api datasource not exist.',
'description' => '',
],
[
'errorCode' => 'ApiDatasource.Param.IsNull',
'errorMessage' => 'Api datasource modify parameters is null.',
'description' => '',
],
[
'errorCode' => 'ApiDatasource.Param.Oversize',
'errorMessage' => 'The number of parameters of API data source exceeds the limit and cannot exceed %s.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8749D65-E80A-433C-AF1B-CE9C180FF3B4\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'ModifyApiDatasourceParameters',
'description' => 'When you modify a query statement, you can modify only the top-level JsonObject. You cannot modify parameters that are nested in multiple layers. For more information about the parameters, see [Create an API data source](~~409330~~).',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'ModifyCopilotEmbedConfig' => [
'summary' => 'Modify Intelligent Query Embedding Configuration',
'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' => 'Embedding ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ccd3428c-dd2xxxxxxxxxxxxdffee',
],
],
[
'name' => 'DataRange',
'in' => 'query',
'schema' => [
'title' => '数据范围',
'description' => 'Data range.'."\n"
.'>The parameter type is jsonString, and only one switch between analysis themes and query resources can be effective. When the all-select switch is true, it takes precedence. It is recommended to pass only one parameter, with other notes>',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [
'themes' => 'themes',
'allTheme' => 'allTheme',
'llmCubes' => 'llmCubes',
'allCube' => 'allCube',
],
'example' => '如果客户要授权所有分析主题，则 {allTheme: true}'."\n"
.'如果客户要授权所有问数资源，则 {allCube: true}'."\n"
.'如果客户要授权部分问数资源，则 {llmCubes: [12314,12345]}'."\n"
.'如果客户要授权部分分析主题，则 {themes: [12314,12345]}',
],
],
[
'name' => 'ModuleName',
'in' => 'query',
'schema' => [
'title' => '模块名称',
'description' => 'Module name.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '小Q',
],
],
[
'name' => 'AgentName',
'in' => 'query',
'schema' => [
'title' => '机器人昵称',
'description' => 'Agent nickname.',
'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' => 'Request ID.',
'type' => 'string',
'example' => '4BAA4694-CC27-555F-B15A-688AA9289FEE',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
.'- true: The request was successful'."\n"
.'- false: The request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Result' => [
'description' => 'Returns the result of the API execution. Possible values:'."\n"
.'- true: Execution succeeded'."\n"
.'- false: Execution failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'UserRoleConfig.NotContain.Function',
'errorMessage' => 'The user %s does not have permission to operate.',
'description' => 'The user %s does not have permission to operate.',
],
[
'errorCode' => 'Copilot.Modulename.Error',
'errorMessage' => 'ModuleName max length limit 20.',
'description' => 'The maximum length of a module name is 20.',
],
[
'errorCode' => 'Copilot.AgentName.Error',
'errorMessage' => 'AgentName max length limit 10.',
'description' => 'The maximum length of the robot name is limited to 10.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
[
'errorCode' => 'CopilotEmbed.Config.NotFind',
'errorMessage' => 'Can not find copilot embed config with this copilot ID.',
'description' => 'Cannot find this embedded configuration',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BAA4694-CC27-555F-B15A-688AA9289FEE\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]',
'title' => 'Modify Intelligent Query Embedding Configuration',
'changeSet' => [
[
'createdAt' => '2025-02-11T06:04:44.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'quickbi-public:ModifyCopilotEmbedConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
'translator' => 'machine',
'flowControl' => [
'flowControlList' => [
[
'threshold' => '50',
'countWindow' => 1,
'regionId' => '*',
'api' => 'ModifyCopilotEmbedConfig',
],
],
],
],
'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' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'An array of dashboard IDs. Separate multiple IDs with commas.'."\n"
.'>The number of IDs cannot exceed 50.>',
'title' => '',
'example' => 'asda,sadaf',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'description' => 'The status identifier. 0 indicates disabled and 1 indicates enabled.',
'title' => '',
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The request ID.',
'title' => '',
'example' => '46e537a5****',
],
'Result' => [
'type' => 'array',
'items' => [
'type' => 'string',
'description' => 'The dashboard ID.',
'title' => '',
'example' => 'ccd3428c-****-****-a608-26bae29dffee',
],
'description' => 'A list of dashboard IDs for which the operation failed.',
'title' => '',
'example' => '',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
297 => [
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'You must specify the parameter.',
'description' => 'Invalid parameter',
],
],
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Invalid.Parameter.Error',
'errorMessage' => 'The parameter is invalid:%s.',
'description' => 'invalid parameter: ${0}.',
],
[
'errorCode' => 'RobotNl2sql.Moudle.NotPurchase',
'errorMessage' => 'Please purchase Nl2sql module first.',
'description' => 'Please purchase Nl2sql module first.',
],
[
'errorCode' => 'ApiUser.Not.Exists',
'errorMessage' => 'The specified user does not exist.',
'description' => 'The specified user does not exist.',
],
[
'errorCode' => 'Parameter.Error',
'errorMessage' => 'The input parameter is invalid.',
'description' => 'input parameter error.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'ModifyDashboardNl2sqlStatus',
'summary' => 'Modifies the Q-Assistant status for multiple dashboards.',
'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' => 'Queries the run logs of acceleration tasks for a specified dataset.',
'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' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The ID of the dataset.',
'title' => '',
'example' => '7c7223ae-****-3c744528014b',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The start time. The format is yyyy-MM-dd HH:mm:ss.',
'title' => '',
'example' => '2025-04-15 00:00:00',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
'description' => 'The end time. The format is yyyy-MM-dd HH:mm:ss.',
'title' => '',
'example' => '2025-05-15 00:00:00',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The page number. The default value is **1**.',
'title' => '',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'description' => 'The number of entries per page.'."\n"
."\n"
.'- Default value: 10.',
'title' => '',
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'description' => 'The request ID.',
'title' => '',
'example' => 'D8749D********80FF3B4',
],
'Result' => [
'type' => 'object',
'properties' => [
'TotalPages' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of pages.',
'title' => '',
'example' => '1',
],
'TotalNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The total number of entries.',
'title' => '',
'example' => '1',
],
'PageNum' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The page number.',
'title' => '',
'example' => '1',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The number of entries per page.',
'title' => '',
'example' => '10',
],
'Pre' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The previous page. A value of NULL or 0 indicates that no previous page exists.',
'title' => '',
'example' => 'null',
],
'Next' => [
'type' => 'integer',
'format' => 'int32',
'description' => 'The next page. A value of NULL or 0 indicates that no next page exists.',
'title' => '',
'example' => 'null',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JobId' => [
'type' => 'string',
'description' => 'The task ID.',
'title' => '',
'example' => 'REST_A***************6a8',
],
'JobHistoryId' => [
'type' => 'string',
'description' => 'The task history ID.',
'title' => '',
'example' => 'REST_A***************6a8',
],
'JonStartDate' => [
'type' => 'string',
'description' => 'The start time of the task.',
'title' => '',
'example' => 'REST_A***************6a8',
],
'JobStatus' => [
'type' => 'string',
'description' => 'The status of the task.'."\n"
."\n"
.'- 0: Pending'."\n"
."\n"
.'- 1: Running'."\n"
."\n"
.'- 2: Succeeded'."\n"
."\n"
.'- 3: Failed'."\n"
."\n"
.'- 4: Canceled'."\n"
."\n"
.'- 5: Warning',
'title' => '',
'example' => '0',
],
'Duration' => [
'type' => 'string',
'description' => 'The task duration in seconds.',
'title' => '',
'example' => '123',
],
'Log' => [
'type' => 'string',
'description' => 'The log content.',
'title' => '',
'example' => 'asdav************',
],
],
'description' => 'The acceleration task log.',
'title' => '',
'example' => '',
],
'description' => 'An array of acceleration task logs.',
'title' => '',
'example' => '',
],
],
'description' => 'The result of the API request.'."\n"
."\n"
.'- true: The execution succeeded.'."\n"
."\n"
.'- false: The execution failed.',
'title' => '',
'example' => '',
],
'Success' => [
'type' => 'boolean',
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'title' => '',
'example' => 'true',
],
],
'title' => '',
'description' => 'The response schema.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'Cube.Not.Exist',
'errorMessage' => 'The Cube does not exist.',
'description' => 'The Cube does not exist.',
],
[
'errorCode' => 'Date.Format.Error',
'errorMessage' => 'Date format conversion error.',
'description' => 'Date format conversion error',
],
[
'errorCode' => 'Date.Check.Error',
'errorMessage' => 'The end date cannot be greater than the start date.',
'description' => 'End date cannot be greater than start date',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'QueryAccelerationLogByCubeId',
'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' => 'Get approval flow information based on the approver.',
'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' => 'Current approver user ID, qbi user ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12352fasdavsa',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => '审批状态。'."\n"
.'● 0：待审批'."\n"
.'● 1：已处理',
'description' => 'Approval status:'."\n"
.'- 0: Pending'."\n"
.'- 1: Processed',
'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' => 'Number of rows per page, default is 1000.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1000',
],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => [
'title' => '页数，默认1',
'description' => 'Page number, default is 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' => 'Request ID.',
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
],
'Result' => [
'description' => 'Return the result of the interface execution.',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '审批流信息数组。',
'description' => 'Array of approval flow information.',
'type' => 'array',
'items' => [
'title' => '审批流信息对象',
'description' => 'Approval flow information object.',
'type' => 'object',
'properties' => [
'ApplicantId' => [
'title' => '申请人userID，qbi用户id',
'description' => 'Applicant\'s user ID, qbi user ID.',
'type' => 'string',
'example' => '1359508',
],
'ApplicantName' => [
'title' => '申请人昵称',
'description' => 'Applicant\'s nickname.',
'type' => 'string',
'example' => '李飞',
],
'ApplicationId' => [
'title' => '申请id',
'description' => 'Application ID.',
'type' => 'string',
'example' => '64813ef6da58e80eef8ed2f9',
],
'ApplyReason' => [
'title' => '申请理由',
'description' => 'Application reason.',
'type' => 'string',
'example' => '开发需要',
],
'ApproverId' => [
'title' => '审批人userID，qbi用户id',
'description' => 'Approver\'s user ID, qbi user ID.',
'type' => 'string',
'example' => 'sdasascasxasd',
],
'ApproverName' => [
'title' => '审批人昵称',
'description' => 'Approver\'s nickname.',
'type' => 'string',
'example' => 'data_fusion_002',
],
'DeleteFlag' => [
'title' => '资源是否已被删除',
'description' => 'Whether the resource has been deleted:'."\n"
.'- true: Deleted'."\n"
.'- false: Not deleted',
'type' => 'boolean',
'example' => 'true',
],
'ExpireDate' => [
'title' => '权限有效期限，时间戳',
'description' => 'Permission expiration date, timestamp.',
'type' => 'integer',
'format' => 'int64',
'example' => '1708568097135',
],
'FlagStatus' => [
'title' => '权限审批状态：'."\n"
.'● 0：审批中,对应请求参数中的0'."\n"
.'● 1：审批通过，对应请求参数送1'."\n"
.'● 2：审批拒绝，对应请求参数送1',
'description' => 'Permission approval status:'."\n"
.'- 0: Under review, corresponding to 0 in the request parameters'."\n"
.'- 1: Approved, corresponding to 1 in the request parameters'."\n"
.'- 2: Rejected, corresponding to 1 in the request parameters',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'GmtCreate' => [
'title' => '申请创建时间，时间戳',
'description' => 'Application creation time, timestamp.',
'type' => 'integer',
'format' => 'int64',
'example' => '1687315758',
],
'GmtModified' => [
'title' => '申请修改时间，时间戳',
'description' => 'Application modification time, timestamp.',
'type' => 'integer',
'format' => 'int64',
'example' => '1640595729000',
],
'HandleReason' => [
'title' => '处理理由',
'description' => 'Handling reason.',
'type' => 'string',
'example' => '开发需要',
],
'ResourceId' => [
'title' => '申请权限资源ID',
'description' => 'The ID of the resource for which permission is requested.',
'type' => 'string',
'example' => 'acl-ct4t2e4u2x4ej1bzur',
],
'ResourceName' => [
'title' => '申请权限资源名称(报表名、空间名...)',
'description' => 'The name of the resource for which permission is requested (e.g., report name, space name...).',
'type' => 'string',
'example' => '测试资源',
],
'ResourceType' => [
'title' => '资源类型',
'description' => 'The type of the resource.',
'type' => 'string',
'example' => 'DASHBOARD',
],
'WorkspaceName' => [
'title' => '空间名称',
'description' => 'The name of the workspace.',
'type' => 'string',
'example' => '测试工作空间',
],
],
'example' => '',
],
'example' => '',
],
'Page' => [
'title' => '当前页',
'description' => 'The current page number.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'title' => '当前页请求记录数',
'description' => 'The number of records requested per page.',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'Start' => [
'title' => '当前页起始位置',
'description' => 'The starting position of the current page.',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Total' => [
'title' => '总数目',
'description' => 'The total number of items.',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TotalPages' => [
'title' => '总页码',
'description' => 'The total number of pages.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the API call was successful. Possible values are:'."\n"
.'- true: success'."\n"
.'- false: failure',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'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' => 'QueryApprovalInfo',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2025-02-11T06:04:44.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-12-30T02:38:46.000Z',
'description' => 'Error codes changed, Request parameters changed',
],
[
'createdAt' => '2024-10-18T01:53:31.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:QueryApprovalInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryAuditLog' => [
'summary' => 'Queries audit log information.',
'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' => 'The log type. Valid values:'."\n"
."\n"
.'- dataView: access logs'."\n"
."\n"
.'- function: operation logs'."\n"
."\n"
.'- permission: permission logs',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'function' => 'function',
'permission' => 'permission',
'dataView' => 'dataView',
],
'example' => 'function',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'title' => '工作空间ID，需要查询的日志所属工作空间ID',
'description' => 'The ID of the workspace that contains the logs to query.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'title' => '查询开始时间，时间戳,不能早于当前时间90天',
'description' => 'The start date for the query. Use the yyyyMMdd format. The date cannot be more than 90 days before the current date.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '20240504',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'title' => '查询结束时间，时间戳',
'description' => 'The end date for the query. Use the yyyyMMdd format.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '20240604',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型，参见作品类型',
'description' => 'The resource type. For more information, see work types.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cube',
],
],
[
'name' => 'OperatorId',
'in' => 'query',
'schema' => [
'title' => '操作人userId。',
'description' => 'The user ID of the operator.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0***',
],
],
[
'name' => 'OperatorTypes',
'in' => 'query',
'schema' => [
'title' => '权限/访问/操作类型，空-默认所有；'."\n"
.'见审计日志码值,送多个请以英文逗号分割',
'description' => 'The permission, access, or operation type. If left empty, all types are queried by default.'."\n"
."\n"
.'For valid values, see audit log codes. To specify multiple types, separate them with commas.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'MODIFY',
],
],
[
'name' => 'UserAccessDevice',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'title' => '',
'description' => 'The device used for access. Valid values:'."\n"
."\n"
.'- MOBILE: mobile device'."\n"
."\n"
.'- PC: PC',
'example' => 'PC',
],
],
[
'name' => 'AccessSourceFlag',
'in' => 'query',
'schema' => [
'type' => 'string',
'title' => '',
'description' => 'The access source. Valid values:'."\n"
."\n"
.'- COMMON: standard access'."\n"
."\n"
.'- IMBEDDED: embedded report'."\n"
."\n"
.'- PUBLIC: public report'."\n"
."\n"
.'- IMBEDDED\\_COMPONENT: embedded card',
'required' => false,
'example' => 'PUBLIC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => '78C1AA2D-9201-599E-A0BA-6FC462E57A95',
],
'Result' => [
'description' => 'An array of log objects.',
'type' => 'array',
'items' => [
'description' => 'A log object.',
'type' => 'object',
'properties' => [
'GmtCreate' => [
'title' => '日志时间',
'description' => 'The time when the log was generated.',
'type' => 'string',
'example' => '2024-04-16 13:17:39',
],
'OperatorAccountName' => [
'title' => '操作者账号',
'description' => 'The account name of the operator.',
'type' => 'string',
'example' => 'wukaibis',
],
'OperatorName' => [
'title' => '操作者用户昵称',
'description' => 'The nickname of the operator.',
'type' => 'string',
'example' => 'buc_344078',
],
'OperatorType' => [
'title' => '操作类型',
'description' => 'The operation type.',
'type' => 'string',
'example' => 'CREATE',
],
'TargetName' => [
'title' => '操作目标名称',
'description' => 'The name of the operation target.',
'type' => 'string',
'example' => 'test',
],
'TargetType' => [
'title' => '操作目标类型',
'description' => 'The type of the operation target.',
'type' => 'string',
'example' => 'USER',
],
'WorkspaceId' => [
'title' => '工作空间ID',
'description' => 'The workspace ID.',
'type' => 'string',
'example' => '87c6b145-090c-43e1-9426-8f93be23****',
],
'TargetId' => [
'title' => '操作对象ID',
'description' => 'The ID of the operation target.',
'type' => 'string',
'example' => '1113***************8500',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Date.Format.Error',
'errorMessage' => 'Date format conversion error.',
'description' => 'Date format conversion error',
],
[
'errorCode' => 'Date.Check.Error',
'errorMessage' => 'The end date cannot be greater than the start date.',
'description' => 'End date cannot be greater than start date',
],
[
'errorCode' => 'Date.Exceed.Error',
'errorMessage' => 'The start date must be within 90 days from the current date.',
'description' => 'Start date cannot be 90 days earlier than current date',
],
[
'errorCode' => 'Log.Type.Error',
'errorMessage' => 'The log type is incorrect.',
'description' => 'The log type is incorrect.',
],
[
'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' => 'Only organization administrators can perform this operation.',
],
],
],
'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' => 'Query Audit Log Information',
'changeSet' => [
[
'createdAt' => '2025-07-02T03:20:55.000Z',
'description' => 'Request parameters changed',
],
[
'createdAt' => '2025-02-21T06:02:16.000Z',
'description' => 'Error codes changed',
],
[
'createdAt' => '2024-12-30T02:38:46.000Z',
'description' => 'Response parameters changed',
],
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'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' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryComponentPerformance' => [
'summary' => 'Queries component performance logs.',
'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' => 'The query type. Valid values:'."\n"
."\n"
.'* **lastDay**: Yesterday'."\n"
.'* **sevenDays**: Within seven days'."\n"
.'* **thirtyDays**: Within 30 days'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sevenDays',
'title' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The workspace ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '89713491-cb4f-4579-b889-e82c35f1****',
'title' => '',
],
],
[
'name' => 'ReportId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the work. The works here include BI portal, dashboards, spreadsheets, and self-service access.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '6b407e50-e774-406b-9956-da2425c2****',
'title' => '',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource types.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'report',
'title' => '',
],
],
[
'name' => 'CostTimeAvgMin',
'in' => 'query',
'schema' => [
'description' => 'The average duration (minutes).'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of rows per page in a paged query.'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Maximum value: 1,000.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '100',
'title' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The current page number of the workspace member list:'."\n"
."\n"
.'* Pages start from page 1.'."\n"
.'* Default value: 1.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'BCE45E6D-9304-4F94-86BB-5A772B1615FF',
'title' => '',
],
'Result' => [
'type' => 'array',
'items' => [
'description' => 'Component performance analysis model.'."\n",
'type' => 'object',
'properties' => [
'CacheCostTimeAvg' => [
'description' => 'The average duration of cache hits.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'CacheQueryCount' => [
'description' => 'The number of cache hits.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '3',
'title' => '',
],
'ComponentId' => [
'description' => 'The component ID.'."\n",
'type' => 'string',
'example' => '0696083a-ca72-4d89-8e7a-c017910e0***',
'title' => '',
],
'ComponentName' => [
'description' => 'The name of the add-on.'."\n",
'type' => 'string',
'example' => '线图',
'title' => '',
],
'CostTimeAvg' => [
'description' => 'The average query duration associated with the SQL pattern.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QueryCount' => [
'description' => 'The number of queries.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
'title' => '',
],
'QueryCountAvg' => [
'description' => 'The average number of queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QueryOverFivePercentNum' => [
'description' => 'The query exceeds the 5S number of queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '5',
'title' => '',
],
'QueryOverFiveSecPercent' => [
'description' => 'Query the proportion of more than 5S.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'QueryOverTenSecPercent' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'QueryOverTenSecPercentNum' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QueryTimeoutCount' => [
'description' => 'The number of times that the chart query times out.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'QueryTimeoutCountPercent' => [
'description' => 'The percentage of timeout times for chart queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QuickIndexCostTimeAvg' => [
'description' => 'The average time consumed by the Quick engine query.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QuickIndexQueryCount' => [
'description' => 'The number of times that the Quick engine is hit.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '3',
'title' => '',
],
'RepeatQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'RepeatQueryPercentNum' => [
'description' => 'The number of duplicate queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '2',
'title' => '',
],
'RepeatSqlQueryCount' => [
'description' => 'The number of times the query is repeated.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
'title' => '',
],
'RepeatSqlQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'ReportId' => [
'description' => 'The ID of the work.'."\n",
'type' => 'string',
'example' => '6b407e50-e774-406b-9956-da2425c2****',
'title' => '',
],
'ReportName' => [
'description' => 'The name of the report.'."\n",
'type' => 'string',
'example' => 'ClusterRiskReport',
'title' => '',
],
'ReportType' => [
'description' => 'The format of the report.'."\n",
'type' => 'string',
'example' => 'report',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The unique ID of the space.'."\n",
'type' => 'string',
'example' => '89713491-cb4f-4579-b889-e82c35f1****',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the group.'."\n",
'type' => 'string',
'example' => '测试空间',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'description' => 'The result returned.'."\n",
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'QueryComponentPerformance',
'translator' => 'machine',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:QueryComponentPerformance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryCopilotEmbedConfig' => [
'summary' => 'Get the List of Configurations for Activating XiaoQ Embedding',
'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' => 'Name of the embedded configuration module, supports fuzzy search.',
'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' => 'Request ID.',
'type' => 'string',
'example' => '1FC71085-D5FD-08E0-813A-4D4BD1031BC5',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
.'- false: The request failed.',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'Result' => [
'description' => 'List of embedded configurations.',
'type' => 'array',
'items' => [
'description' => 'Embedded configuration object.',
'type' => 'object',
'properties' => [
'AgentName' => [
'title' => '机器人昵称',
'description' => 'Robot\'s nickname.',
'type' => 'string',
'example' => '小Q',
],
'CopilotId' => [
'title' => '嵌入id',
'description' => 'Embedding ID.',
'type' => 'string',
'example' => '9c079710-ddbe-48b3-b495-7c83c8d57cc4',
],
'CreateUser' => [
'title' => '创建人userid',
'description' => 'ID of the creator.',
'type' => 'string',
'example' => 'qweqw12312423521',
],
'CreateUserName' => [
'title' => '创建人的昵称',
'description' => 'Nickname of the creator.',
'type' => 'string',
'example' => '诸葛',
],
'DataRange' => [
'title' => '数据范围（分析主题和数据集）',
'description' => 'Data range (analysis themes and question resources).',
'type' => 'object',
'properties' => [
'AllCube' => [
'title' => '是否全选问数资源',
'description' => 'Whether all question resources are selected.',
'type' => 'boolean',
'example' => 'true/false',
],
'AllTheme' => [
'title' => '是否全选分析主题',
'description' => 'Whether all analysis themes are selected.',
'type' => 'boolean',
'example' => 'true/false',
],
'LlmCubes' => [
'title' => '数据集id集合',
'description' => 'Collection of question resource IDs.',
'type' => 'array',
'items' => [
'description' => 'Question resource ID.',
'type' => 'string',
'example' => '123124,1231241',
'title' => '',
],
'example' => '',
],
'Themes' => [
'title' => '分析主题的id集合',
'description' => 'Collection of analysis theme IDs.',
'type' => 'array',
'items' => [
'description' => 'Analysis theme ID.',
'type' => 'string',
'example' => '123124,1231241',
'title' => '',
],
'example' => '',
],
],
'example' => '',
],
'ModifyUser' => [
'title' => '修改人',
'description' => 'ID of the modifier.',
'type' => 'string',
'example' => 'asda1231231dfs',
],
'ModuleName' => [
'title' => '模块名称',
'description' => 'Module name.',
'type' => 'string',
'example' => '小Q',
],
'ShowName' => [
'title' => '嵌入模块名称',
'description' => 'Name of the embedded module.',
'type' => 'string',
'example' => '0327',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Get the List of Configurations for Activating XiaoQ Embedding',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'quickbi-public:QueryCopilotEmbedConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryCubeOptimization' => [
'summary' => 'Queries dataset optimization suggestions.',
'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' => 'The workspace ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'D787E1A3-A93C-424A-B626-C2B05DF8D885',
'title' => '',
],
'Result' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AdviceType' => [
'description' => 'The type of the suggestion. Valid values:'."\n"
."\n"
.'* **OPEN_CACHE**: Open cache.'."\n"
.'* **OPEN_QUICK_ENGINE**: Open FAST Cache.'."\n"
.'* **INCREASE_CACHE_TIME**: Increase the cache time.'."\n",
'type' => 'string',
'example' => 'OPENQUICKENGINE',
'title' => '',
],
'CubePerformanceDiagnoseModel' => [
'description' => 'The diagnostic information about the dataset.'."\n",
'type' => 'object',
'properties' => [
'CacheCostTimeAvg' => [
'description' => 'The average duration of cache hits.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'CacheQueryCount' => [
'description' => 'The number of cache hits.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'CostTimeAvg' => [
'description' => 'The average query duration associated with the SQL pattern.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1.0',
'title' => '',
],
'CubeId' => [
'description' => 'The dataset ID.'."\n",
'type' => 'string',
'example' => '3e45b61a-9ba8-4c7c-8248-8dbe69945636',
'title' => '',
],
'CubeName' => [
'description' => 'The name of the dataset.'."\n",
'type' => 'string',
'example' => 'test',
'title' => '',
],
'QueryCount' => [
'description' => 'The number of queries.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '50',
'title' => '',
],
'QueryCountAvg' => [
'description' => 'The average number of queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '2',
'title' => '',
],
'QueryOverFivePercentNum' => [
'description' => 'The percentage of the number of queries that exceed the 5S.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.1',
'title' => '',
],
'QueryOverFiveSecPercent' => [
'description' => 'Query the proportion of more than 5S.'."\n",
'type' => 'string',
'example' => '0.5',
'title' => '',
],
'QueryOverTenSecPercent' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'string',
'example' => '0.1',
'title' => '',
],
'QueryOverTenSecPercentNum' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QueryTimeoutCount' => [
'description' => 'The number of times that the chart query times out.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'QueryTimeoutCountPercent' => [
'description' => 'The percentage of timeout times for chart queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.3',
'title' => '',
],
'QuickIndexCostTimeAvg' => [
'description' => 'The average time consumed by the Quick engine query.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'QuickIndexQueryCount' => [
'description' => 'The number of times that the Quick engine is hit.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'RepeatQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '0.1',
'title' => '',
],
'RepeatQueryPercentNum' => [
'description' => 'The number of duplicate queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '2',
'title' => '',
],
'RepeatSqlQueryCount' => [
'description' => 'The number of times the query is repeated.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
'title' => '',
],
'RepeatSqlQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The workspace ID.'."\n",
'type' => 'string',
'example' => '6ea74bff-c818-4188-b462-dbb45a24dbac',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the workspace.'."\n",
'type' => 'string',
'example' => 'eco0sh0prods',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'Return the result of the interface execution.',
'title' => '',
'example' => '',
],
'description' => 'The query results are returned.'."\n",
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'QueryCubeOptimization',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:QueryCubeOptimization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryCubePerformance' => [
'summary' => 'Queries the performance logs of a dataset.',
'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' => 'The query type. Valid values:'."\n"
."\n"
.'* **lastDay**: Yesterday'."\n"
.'* **sevenDays**: Within seven days'."\n"
.'* **thirtyDays**: Within 30 days'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sevenDays',
'title' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'The workspace ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '95296e95-ca89-4c7d-8af9-dedf0ad0****',
'title' => '',
],
],
[
'name' => 'CubeId',
'in' => 'query',
'schema' => [
'description' => 'The dataset ID.'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '7c7223ae-****-3c744528014b',
'title' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The current page number of the workspace member list:'."\n"
."\n"
.'* Pages start from page 1.'."\n"
.'* Default value: 1.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of rows per page in a paged query.'."\n"
."\n"
.'* Default value: 10.'."\n"
.'* Maximum value: 1,000.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '100',
'title' => '',
],
],
[
'name' => 'CostTimeAvgMin',
'in' => 'query',
'schema' => [
'description' => 'The average duration (minutes).'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '685072a0-1fd5-40ef-ae6b-cf94e79e718f',
'title' => '',
],
'Result' => [
'type' => 'array',
'items' => [
'description' => 'The diagnostic information about the dataset.'."\n",
'type' => 'object',
'properties' => [
'CacheCostTimeAvg' => [
'description' => 'The average duration of cache hits.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'CacheQueryCount' => [
'description' => 'The number of cache hits.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'CostTimeAvg' => [
'description' => 'The average query duration associated with the SQL pattern.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'CubeId' => [
'description' => 'The dataset ID.'."\n",
'type' => 'string',
'example' => '7c7223ae-****-3c744528014b',
'title' => '',
],
'CubeName' => [
'description' => 'The name of the dataset.'."\n",
'type' => 'string',
'example' => 'test',
'title' => '',
],
'QueryCount' => [
'description' => 'The number of queries.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '50',
'title' => '',
],
'QueryCountAvg' => [
'description' => 'The average number of queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'QueryOverFivePercentNum' => [
'description' => 'The percentage of the number of queries that exceed the 5S.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1.0',
'title' => '',
],
'QueryOverFiveSecPercent' => [
'description' => 'Query the proportion of more than 5S.'."\n",
'type' => 'string',
'example' => '1.0',
'title' => '',
],
'QueryOverTenSecPercent' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'string',
'example' => '1.0',
'title' => '',
],
'QueryOverTenSecPercentNum' => [
'description' => 'The percentage of queries that exceed 10s.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1.0',
'title' => '',
],
'QueryTimeoutCount' => [
'description' => 'The number of times that the chart query times out.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'QueryTimeoutCountPercent' => [
'description' => 'The percentage of timeout times for chart queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'QuickIndexCostTimeAvg' => [
'description' => 'The average time consumed by the Quick engine query.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'QuickIndexQueryCount' => [
'description' => 'The number of times that the Quick engine is hit.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'RepeatQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '0.3',
'title' => '',
],
'RepeatQueryPercentNum' => [
'description' => 'The number of duplicate queries.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '1',
'title' => '',
],
'RepeatSqlQueryCount' => [
'description' => 'The number of times the query is repeated.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'title' => '',
],
'RepeatSqlQueryPercent' => [
'description' => 'The proportion of duplicate queries.'."\n",
'type' => 'string',
'example' => '1',
'title' => '',
],
'WorkspaceId' => [
'description' => 'The ID of the workspace to which the work belongs.'."\n",
'type' => 'string',
'example' => '87c6b145-090c-43e1-9426-8f93be23****',
'title' => '',
],
'WorkspaceName' => [
'description' => 'The name of the group.'."\n",
'type' => 'string',
'example' => '测试工作空间',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'description' => 'Array of report objects',
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* true: The request was successful.'."\n"
.'* false: The request failed.'."\n",
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'QueryCubePerformance',
'translator' => 'machine',
'changeSet' => [
[
'createdAt' => '2024-10-18T01:53:30.000Z',
'description' => 'Error codes changed',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'quickbi-public:QueryCubePerformance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'QuickBI',
'resourceType' => 'All Resource',
'arn' => '*',
],
],
],
],
],
],
'QueryDashboardNl2sql' => [
'summary' => 'Query Dashboard\'s Question Resource Information',
'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' => 'User ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3d7ebb8***********500078f4',
'title' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => 'Workspace ID.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3d7ebb8***********500078f4',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Request ID.',
'type' => 'string',
'example' => '46e537a5****,3dadsu****',
'title' => '',
],
'Result' => [
'description' => 'Result of the API execution. Possible values:'."\n"
."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'array',
'items' => [
'description' => 'Returns the result of the API execution.',
'type' => 'object',
'properties' => [
'DashboardName' => [
'title' => '仪表板名称',
'description' => 'Dashboard name',
'type' => 'string',
'example' => '612b',
],
'DashboardNl2sqlId' => [
'title' => '仪表板问数资源id',
'description' => 'Dashboard question resource ID',
'type' => 'string',
'example' => 'sasdas****sawdau',
],
'OwnerId' => [
'title' => '仪表板创建者Userid',
'description' => 'UserID of the dashboard creator',
'type' => 'string',
'example' => '46e5374665ba4b679ee22e2a2927****',
],
'Authorities' => [
'title' => '当该参数有值，并且包含"READ"时，表示该用户对该仪表板问数资源有问数权限',
'description' => 'If this parameter has a value and includes "READ", it indicates that the user has read permission for the dashboard question resource.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'If this parameter has a value and includes "READ", it indicates that the user has read permission for the dashboard question resource.',
'type' => 'string',
'example' => 'READ',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request was successful. Possible values: '."\n"
."\n"
.'- true: Request succeeded'."\n"
.'- false: Request failed',
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Internal.System.Error',
'errorMessage' => 'An internal system error occurred.',
'description' => 'An internal system error occurred.',
],
[
'errorCode' => 'User.Not.In.Organization',
'errorMessage' => 'The specified user is not in the organizational unit.',
'description' => 'The specified user is not in the organizational unit.',
],
[
'errorCode' => 'Workspace.Not.Exist',
'errorMessage' => 'The group workspace does not exist.',
'description' => 'The group workspace does not exist.',
],
[
'errorCode' => 'Workspace.NotIn.Organization',
'errorMessage' => 'The workspace is not owned by the organization.',
'description' => 'The workspace is not owned by the organization.',
],
[
'errorCode' => 'UserRoleConfig.NotContain.Function',
'errorMessage' => 'The user %s does not have permission to operate.',
'description' => 'The user %s does not have permission to operate.',
],
[
'errorCode' => 'User.NotIn.Workspace',
'errorMessage' => 'The user is not a member of the group workspace.',
'description' => 'The user is not a member of the group workspace.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => 'QueryDashboardNl2sql',
'changeSet' => [],
'ramActions' => [],
'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"}]',
'translator' => 'machine',
'flowControl' => [
'flowControlList' => [],
],
],
'QueryData' => [
'summary' => 'Calls an API that was created in DataService Studio.',
'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' => 'The ID of the API in DataService Studio. For more information, see [DataService Studio](~~144980~~).',
'type' => 'string',
'required' => true,
'docRequired' => true,
'title' => '',
'example' => 'f4cc43bc3***',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => 'The user ID in Quick BI. For more information about how to obtain the user ID, see [QueryUserInfoByAccount](https://next.api.aliyun.com/document/quickbi-public/2022-01-01/QueryUserInfoByAccount).'."\n"
."\n"
.'> This parameter specifies the identity of the user who uses DataService Studio. You can use it with the row-level and column-level permission configurations of the dataset.'."\n"
."\n"
.'>'."\n"
."\n"
.'If you do not pass this parameter, or pass an empty string or null, the user ID of the owner of the current Quick BI organization is used by default.'."\n"
."\n"
.'>',
'type' => 'string',
'required' => false,
'title' => '',
'example' => 'b5d8fd9348cc4327****afb604',
],
],
[
'name' => 'Conditions',
'in' => 'query',
'schema' => [
'description' => 'The filter conditions for DataService Studio. Pass the conditions as key-value pairs in a map-type string. The key is the name of the request parameter, and the value is the value of the request parameter. Keys and values must appear in pairs.'."\n"
."\n"
.'**Note:**'."\n"
."\n"
.'- If the operator of a request parameter is set to **Enumeration Filter**, the value can contain multiple values. In this case, the value must be in the format of a JSON list. For example: `area=["East China","North China","South China"]`'."\n"
."\n"
.'- For dates, use the following formats based on the date type:'."\n"
."\n"
.' - Year: 2019'."\n"
."\n"
.' - Quarter: 2019Q1'."\n"
."\n"
.' - Month: 201901 (with a leading zero)'."\n"
."\n"
.' - Week: 2019-52'."\n"
."\n"
.' - Day: 20190101'."\n"
."\n"
.' - Hour: 14:00:00 (minutes and seconds are 00)'."\n"
."\n"
.' - Minute: 14:12:00 (seconds are 00)'."\n"
."\n"
.' - Second: 14:34:34',
'type' => 'string',
'required' => false,
'title' => '',
'example' => '{ "area": ["test", "test"], "shopping_date": "2019Q1", }',
],
],
[
'name' => 'ReturnFields',
'in' => 'query',
'schema' => [
'description' => 'A list of the names of the returned parameters, in a list-type string format.',
'type' => 'string',
'required' => false,
'title' => '',
'example' => '["area", "city", "price", "date"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- true: The request was successful.'."\n"
."\n"
.'- false: The request failed.',
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'RequestId' => [
'description' => 'The request ID.',
'type' => 'string',
'title' => '',
'example' => 'a4d1a221d-41za1-****',
],
'Result' => [
'description' => 'The result of the API call. Valid values:'."\n"
."\n"
.'- true: The call was successful.'."\n"
."\n"
.'- false: The call failed.',
'type' => 'object',
'properties' => [
'Headers' => [
'description' => 'The column headers.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Aggregator' => [
'description' => 'The aggregate operator. This parameter is returned only for measure fields, such as SUM, AVG, and MAX.'."\n"
."\n"
.'- SUM: The sum.'."\n"
."\n"
.'- MAX: The maximum value.'."\n"
."\n"
.'- MIN: The minimum value.'."\n"
."\n"
.'- AVG: The average value.'."\n"
."\n"
.'- COUNT: The count.'."\n"
."\n"
.'- COUNTD: The count of unique values.'."\n"
."\n"
.'- STDDEV\\_POP: The population standard deviation.'."\n"
."\n"
.'- STDDEV\\_SAMP: The sample standard deviation.'."\n"
."\n"
.'- VAR\\_POP: The population variance.'."\n"
."\n"
.'- VAR\\_SAMP: The sample variance.',
'type' => 'string',
'title' => '',
'example' => 'SUM',
],
'Column' => [
'description' => 'The field name. It corresponds to the field name in the physical table.',
'type' => 'string',
'title' => '',
'example' => 'test',
],
'DataType' => [
'description' => 'The data type of the field. Common types include the following:'."\n"
."\n"
.'- number'."\n"
."\n"
.'- string'."\n"
."\n"
.'- date'."\n"
."\n"
.'- time'."\n"
."\n"
.'- datetime',
'type' => 'string',
'title' => '',
'example' => 'string',
],
'Granularity' => [
'description' => 'The granularity of the dimension field.'."\n"
.'This parameter is returned only when the requested field is a date dimension or a geographic dimension. Valid values:'."\n"
."\n"
.'- Date granularity: yearRegion (year), monthRegion (month), weekRegion (week), dayRegion (day), hourRegion (hour), minRegion (minute), secRegion (second)'."\n"
."\n"
.'- Geographic granularity: COUNTRY (country), PROVINCE (province), CITY (city), XIAN (county/district), REGION (region)',
'type' => 'string',
'title' => '',
'example' => 'REGION',
],
'Label' => [
'description' => 'The alias of the field. It is the key for the map data row in the values result parameter.',
'type' => 'string',
'title' => '',
'example' => 'area',
],
'Type' => [
'description' => 'The field type. It indicates whether the field is a dimension or a measure.'."\n"
."\n"
.'- Dimension'."\n"
."\n"
.'- Measure',
'type' => 'string',
'title' => '',
'example' => 'Dimension',
],
'OriginalColumn' => [
'type' => 'string',
'description' => 'The original name of the corresponding field in the dataset.',
'title' => '',
'example' => 'area',
],
],
'description' => 'Column headers.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Sql' => [
'description' => 'The SQL statement for the query.'."\n"
."\n"
.'> In addition to the filter conditions passed in the current API call, the returned SQL statement also includes the row-level and column-level permission configurations.',
'type' => 'string',
'title' => '',
'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' => 'The query results.',
'type' => 'array',
'items' => [
'description' => 'The rows and columns of the returned data.'."\n"
."\n"
.'This parameter has a List\\