'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'dataphin-public', 'version' => '2023-06-30', ], 'directories' => [ [ 'id' => 198270, 'title' => '平台管理', 'type' => 'directory', 'children' => [ [ 'id' => 243566, 'title' => '项目', 'type' => 'directory', 'children' => [ 'CheckProjectHasDependency', 'GetProject', 'GetProjectByName', 'AddProjectMember', 'GetProjectWhiteLists', 'ListProjectMembers', 'ListProjects', 'RemoveProjectMember', 'ReplaceProjectWhiteLists', 'UpdateProjectMember', 'UpdateTenantComputeEngine', ], ], [ 'id' => 198271, 'title' => '数据源', 'type' => 'directory', 'children' => [ 'GetCheckConnectivityJobs', 'GetDataSourceDependencies', 'CreateDataSource', 'DeleteDataSource', 'UpdateDataSourceBasicInfo', 'UpdateDataSourceConfig', 'ListDataSourceWithConfig', 'CheckDataSourceConnectivity', 'CheckDataSourceConnectivityById', ], ], [ 'id' => 201914, 'title' => '计算源', 'type' => 'directory', 'children' => [ 'CheckComputeSourceConnectivity', 'CheckComputeSourceConnectivityById', 'ListComputeSources', 'UpdateComputeSource', 'GetComputeSource', 'DeleteComputeSource', 'CreateComputeSource', 'GetSparkLocalClientInfo', ], ], [ 'id' => 198279, 'title' => '用户与授权', 'type' => 'directory', 'children' => [ 'SyncDepartment', 'SyncDepartmentUser', 'TransferOwnershipForAllObject', 'RetryTransferOwnership', 'GetTransferInfo', 'AddTenantMembers', 'AddTenantMembersBySourceUser', 'CreateUserGroup', 'AddUserGroupMember', 'DeleteUserGroup', 'UpdateUserGroup', 'UpdateUserGroupSwitch', 'UpdateTenantMember', 'ListResourcePermissionOperationLog', 'ListResourcePermissions', 'GetProjectProduceUser', 'GetUsers', 'ListAddableUsers', 'ListTenantMembers', 'GetUserGroup', 'ListAddableRoles', 'ListUserGroups', 'GetMyTenants', 'GetMyRoles', 'ListUserGroupMembers', 'GetUserBySourceId', 'GrantResourcePermission', 'RevokeResourcePermission', 'CheckResourcePermission', 'RemoveTenantMember', 'RemoveUserGroupMember', ], ], [ 'id' => 205631, 'title' => '行级权限', 'type' => 'directory', 'children' => [ 'DeleteRowPermission', 'GetAccountByRowPermissionId', 'ListRowPermission', 'ListRowPermissionByUserId', 'UpdateRowPermission', 'CreateRowPermission', ], ], ], ], [ 'id' => 198307, 'title' => '研发', 'type' => 'directory', 'children' => [ [ 'id' => 200872, 'title' => '目录树', 'type' => 'directory', 'children' => [ 'CreateDirectory', 'DeleteDirectory', 'UpdateFileName', 'UpdateFileDirectory', 'GetDirectoryTree', 'ListFiles', ], ], [ 'id' => 200804, 'title' => '数据架构', 'type' => 'directory', 'children' => [ 'GetBizEntityInfoByVersion', 'GetBizEntityInfo', 'UpdateBizUnit', 'ListBizUnits', 'GetBizUnitInfo', 'DeleteBizUnit', 'CreateBizUnit', 'UpdateBizEntity', 'OnlineBizEntity', 'OfflineBizEntity', 'ListBizEntities', 'CreateBizEntity', 'UpdateDataDomain', 'ListDataDomains', 'GetDataDomainInfo', 'DeleteDataDomain', 'CreateDataDomain', 'DeleteBizEntity', ], ], [ 'id' => 198308, 'title' => '即席查询', 'type' => 'directory', 'children' => [ 'CreateAdHocFile', 'DeleteAdHocFile', 'UpdateAdHocFile', 'GetAdHocFile', 'StopAdHocTask', 'GetAdHocTaskResult', 'ExecuteAdHocTask', 'GetAdHocTaskLog', ], ], [ 'id' => 201111, 'title' => '离线计算任务', 'type' => 'directory', 'children' => [ 'UpdatePipelineByAsync', 'OfflinePipelineByAsync', 'GetPipelineById', 'OfflinePipeline', 'CreatePipeline', 'GetPipelineAsyncResult', 'CreatePipelineByAsync', 'UpdatePipeline', 'CreatePipelineNode', 'UpdateBatchTaskUdfLineages', 'UpdateBatchTask', 'SubmitBatchTask', 'ParseBatchTaskDependency', 'OfflineBatchTask', 'GetBatchTaskUdfLineages', 'GetBatchTaskVersions', 'GetBatchTaskInfoByVersion', 'GetBatchTaskInfo', 'DeleteBatchTask', 'CreateBatchTask', ], ], [ 'id' => 201126, 'title' => '实时研发任务', 'type' => 'directory', 'children' => [ 'GetStreamJobs', 'GetQueueEngineVersionByEnv', 'GetClusterQueueInfoByEnv', 'CreateStreamBatchJobMapping', ], ], [ 'id' => 243553, 'title' => '资源', 'type' => 'directory', 'children' => [ 'GetResource', 'GetResourceByVersion', 'UpdateResource', 'GetFileStorageCredential', 'DeleteResource', 'CreateResource', ], ], [ 'id' => 243557, 'title' => '函数', 'type' => 'directory', 'children' => [ 'GetUdf', 'GetUdfByVersion', 'UpdateUdf', 'DeleteUdf', 'CreateUdf', ], ], [ 'id' => 201062, 'title' => '发布', 'type' => 'directory', 'children' => [ 'ListSubmitRecords', 'GetLatestSubmitDetail', 'PublishObjectList', 'ListPublishRecords', ], ], ], ], [ 'id' => 205628, 'title' => '资产', 'type' => 'directory', 'children' => [ [ 'id' => 376092, 'title' => '数据标准', 'type' => 'directory', 'children' => [ 'UpdateStandardWordRoot', 'UpdateStandardTemplate', 'UpdateStandardSet', 'UpdateStandardMappingToInvalid', 'UpdateStandardLookupTable', 'UpdateStandard', 'OfflineStandard', 'PublishStandard', 'ListStandards', 'GetStandardWordRoot', 'GetStandardTemplate', 'GetStandardStatistics', 'GetStandardSet', 'GetStandardLookupTable', 'GetStandard', 'DeleteStandardWordRoot', 'DeleteStandardValidMapping', 'DeleteStandardSet', 'DeleteStandardRelations', 'DeleteStandardLookupTable', 'DeleteStandardInValidMapping', 'DeleteStandard', 'CreateStandardWordRoot', 'CreateStandardTemplate', 'CreateStandardSet', 'CreateStandardRelations', 'CreateStandardMapping', 'CreateStandardLookupTable', 'CreateStandard', ], ], [ 'id' => 376128, 'title' => '数据质量', 'type' => 'directory', 'children' => [ 'UpsertQualityWatchAlert', 'UpsertQualityWatch', 'UpsertQualityTemplate', 'UpsertQualitySchedule', 'UpsertQualityRule', 'UpdateQualityWatchSwitch', 'UpdateQualityRuleSwitch', 'SubmitQualityWatchTasks', 'SubmitQualityRuleTasks', 'RemoveQualityRuleSchedules', 'ListQualityWatches', 'ListQualityWatchTasks', 'ListQualityTemplates', 'ListQualityRules', 'ListQualityRuleTasks', 'GetQualityWatchTaskLog', 'GetQualityWatchTask', 'GetQualityWatchByObjectId', 'GetQualityWatch', 'GetQualityTemplate', 'GetQualitySchedulesByWatchId', 'GetQualitySchedule', 'GetQualityRuleTaskLog', 'GetQualityRuleTask', 'GetQualityRule', 'GetQualityAlertOfAllRuleScopeByWatchId', 'DeleteQualityWatches', 'DeleteQualityTemplates', 'DeleteQualitySchedules', 'DeleteQualityRules', 'AssignQualityRuleOfAllRuleScopeSchedules', ], ], [ 'id' => 376161, 'title' => '数据安全', 'type' => 'directory', 'children' => [ 'UpdateSecurityLevel', 'UpdateSecurityIdentifyResultStatus', 'UpdateSecurityClassifyCatalog', 'UpdateSecurityClassify', 'ListSecurityIdentifyResults', 'ListSecurityIdentifyRecords', 'GetSecuritySecretKey', 'GetSecurityLevel', 'GetSecurityIdentifyResult', 'GetSecurityClassify', 'DeleteSecurityLevel', 'DeleteSecurityIdentifyResults', 'DeleteSecurityClassifyCatalog', 'DeleteSecurityClassify', 'CreateSecurityLevel', 'CreateSecurityIdentifyResult', 'CreateSecurityClassifyCatalog', 'CreateSecurityClassify', ], ], 'GetTableLineages', 'GetBelongAssetMapping', 'GetAssetMappingRelations', 'ListTables', 'GetTableColumnLineages', 'GetTableColumns', 'CreateBizMetric', 'UpdateBizMetric', 'GetBizMetricByName', 'DeleteBizMetric', 'DeleteRegisterLineage', 'AddRegisterLineage', 'GetTableLineageByTaskId', 'GetTableColumnLineageByTaskId', ], ], [ 'id' => 198318, 'title' => '运维', 'type' => 'directory', 'children' => [ [ 'id' => 198319, 'title' => '实例运维', 'type' => 'directory', 'children' => [ 'GetInstanceUpDownStream', 'GetInstanceDownStream', 'GetSupplementDagrunInstance', 'GetPhysicalInstance', 'ListInstances', 'OperateInstance', 'FixData', ], ], [ 'id' => 198327, 'title' => '任务运维', 'type' => 'directory', 'children' => [ 'ExecuteTriggerNode', 'CreateNodeSupplement', 'PausePhysicalNode', 'GetOperationSubmitStatus', 'GetPhysicalInstanceLog', 'GetSupplementDagrun', 'GetPhysicalNode', 'GetPhysicalNodeContent', 'GetNodeUpDownStream', 'ListNodes', 'GetPhysicalNodeOperationLog', 'ListNodeDownStream', 'GetPhysicalNodeByOutputName', 'GetDevObjectDependency', 'ResumePhysicalNode', 'ExecuteManualNode', ], ], ], ], [ 'id' => 201065, 'title' => '告警消息', 'type' => 'directory', 'children' => [ 'ListAlertNotifications', 'ListAlertEvents', 'GetAlertEvent', ], ], [ 'id' => 201918, 'title' => '数据服务', 'type' => 'directory', 'children' => [ 'RevokeDataServiceApi', 'PublishDataServiceApi', 'ListDataServicePublishedApis', 'ListDataServiceMyAppPermissions', 'ListDataServiceMyApiPermissions', 'ListDataServiceAuthorizedApps', 'ListDataServiceApiImpacts', 'ListDataServiceApiCalls', 'ListDataServiceApiCallStatistics', 'GrantDataServiceApi', 'GetDataServiceProjectAddableUsers', 'GetDataServiceMyProjects', 'GetDataServiceAuthorizedProjects', 'GetDataServiceAuthorizedAppsByGroupId', 'GetDataServiceAppsByGroupId', 'GetDataServiceAppGroups', 'GetDataServiceAppAuthorizedUsers', 'GetDataServiceApiGroups', 'GetDataServiceApiErrorImpact', 'GetDataServiceApiDocument', 'GetDataServiceApiCallTrend', 'GetDataServiceApiCallSummary', 'ApplyDataServiceApp', 'ApplyDataServiceApi', 'AddDataServiceProjectMember', 'CreateDataServiceApi', 'ListApiByApp', 'ListAuthorizedDataServiceApiDetails', ], ], ], 'components' => [ 'schemas' => [ 'PrivilegeTransferResultEntrie' => [ 'type' => 'object', 'properties' => [ 'Privilege' => [ 'title' => '需要转交的功能模块', 'type' => 'string', ], 'PrivilegeDisplayName' => [ 'title' => '需要转交的功能模块', 'type' => 'string', ], 'Status' => [ 'title' => '转交状态', 'type' => 'string', ], 'ErrMsg' => [ 'title' => '如果出错，错误信息', 'type' => 'string', ], 'IsLeaf' => [ 'title' => '是否为叶子节点', 'type' => 'boolean', ], 'Children' => [ 'title' => '子功能', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/PrivilegeTransferResultEntrie', ], ], 'Test' => [ 'type' => 'string', ], ], ], ], ], 'apis' => [ 'CheckProjectHasDependency' => [ 'summary' => '校验项目是否被任务等数据依赖。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '校验项目是否被依赖', ], 'GetProject' => [ 'summary' => '通过项目Id获取项目详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识, 默认：PROD', 'description' => '项目环境，支持：'."\n" .' - DEV：开发环境'."\n" .' - PROD：生产环境', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ProjectInfo' => [ 'title' => '项目详情', 'description' => '项目详情', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '所属业务板块Id', 'description' => '依赖数据模块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '业务板块Id', ], 'BizUnitDisplayName' => [ 'title' => '所属业务板块展示名', 'description' => '依赖数据模块显示名', 'type' => 'string', 'example' => '业务板块显示名', ], 'ComputeSourceId' => [ 'title' => '绑定计算源Id', 'description' => '计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '项目依赖计算源Id', ], 'ComputeSourceName' => [ 'title' => '绑定计算源名', 'description' => '计算源名称', 'type' => 'string', 'example' => '项目依赖计算源名', ], 'StreamComputeSourceId' => [ 'title' => '绑定实时计算源Id', 'description' => '实时计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '项目依赖实时计算源Id', ], 'StreamComputeSourceName' => [ 'title' => '绑定实时计算源名', 'description' => '实时计算源名称', 'type' => 'string', 'example' => '项目依赖实时计算源名', ], 'NameSpaceTag' => [ 'title' => '名称空间：PUBLIC 公共类型、APPLICATION 应用类型、BASE 基础类型', 'description' => '项目标签', 'type' => 'string', 'example' => 'GENERAL', ], 'Env' => [ 'title' => '环境标识', 'description' => '环境', 'type' => 'string', 'example' => 'DEV', ], 'WhiteLists' => [ 'title' => '白名单', 'description' => '白名单列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '白名单', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述', 'description' => '白名单描述', 'type' => 'string', 'example' => 'whitelist for xxx', ], 'Ip' => [ 'title' => 'Ip', 'description' => 'ip', 'type' => 'string', 'example' => '10.209.47.198', ], 'Port' => [ 'title' => '端口', 'description' => '端口', 'type' => 'string', 'example' => '3306', ], ], ], ], 'Mode' => [ 'title' => '项目模式', 'description' => '项目模式，支持：'."\n" .'- BASIC'."\n" .'- DEV_PROD', 'type' => 'string', 'example' => 'BASIC', ], 'Type' => [ 'title' => '项目类型: DISTILL 萃取项目、GENERAL 一般类型项目', 'description' => '项目类型', 'type' => 'string', 'example' => 'GENERAL', ], 'Id' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12356', ], 'Name' => [ 'title' => '项目名称', 'description' => '项目名', 'type' => 'string', 'example' => 'dp_test', ], 'DisplayName' => [ 'title' => '项目展示名', 'description' => '项目显示名', 'type' => 'string', 'example' => '项目显示名', ], 'Description' => [ 'title' => '项目描述', 'description' => '项目描述', 'type' => 'string', 'example' => 'project for xxx', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间', 'type' => 'string', 'example' => '1703048484000', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '编辑时间', 'type' => 'string', 'example' => '1703048484000', ], 'Owner' => [ 'title' => '项目责任人', 'description' => '项目归属人Id', 'type' => 'string', 'example' => '101111', ], 'OwnerName' => [ 'title' => '项目责任人', 'description' => '项目归属人', 'type' => 'string', 'example' => '测试用户', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ProjectInfo\\": {\\n \\"BizUnitId\\": 0,\\n \\"BizUnitDisplayName\\": \\"业务板块显示名\\",\\n \\"ComputeSourceId\\": 0,\\n \\"ComputeSourceName\\": \\"项目依赖计算源名\\",\\n \\"StreamComputeSourceId\\": 0,\\n \\"StreamComputeSourceName\\": \\"项目依赖实时计算源名\\",\\n \\"NameSpaceTag\\": \\"GENERAL\\",\\n \\"Env\\": \\"DEV\\",\\n \\"WhiteLists\\": [\\n {\\n \\"Description\\": \\"whitelist for xxx\\",\\n \\"Ip\\": \\"10.209.47.198\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"Mode\\": \\"BASIC\\",\\n \\"Type\\": \\"GENERAL\\",\\n \\"Id\\": 12356,\\n \\"Name\\": \\"dp_test\\",\\n \\"DisplayName\\": \\"项目显示名\\",\\n \\"Description\\": \\"project for xxx\\",\\n \\"GmtCreate\\": \\"1703048484000\\",\\n \\"GmtModified\\": \\"1703048484000\\",\\n \\"Owner\\": \\"101111\\",\\n \\"OwnerName\\": \\"测试用户\\"\\n }\\n}","type":"json"}]', 'title' => '获取项目详情', ], 'GetProjectByName' => [ 'summary' => '通过项目名获取项目详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '项目名', 'description' => '项目名', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ProjectInfo' => [ 'title' => '项目详情', 'description' => '项目详情', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '所属业务板块Id', 'description' => '所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '101131', ], 'BizUnitDisplayName' => [ 'title' => '所属业务板块展示名', 'description' => '所属业务板块展示名', 'type' => 'string', 'example' => '测试', ], 'ComputeSourceId' => [ 'title' => '绑定计算源Id', 'description' => '绑定计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '101711', ], 'ComputeSourceName' => [ 'title' => '绑定计算源名', 'description' => '绑定计算源名', 'type' => 'string', 'example' => 'ds1', ], 'StreamComputeSourceId' => [ 'title' => '绑定实时计算源Id', 'description' => '绑定实时计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '201711', ], 'StreamComputeSourceName' => [ 'title' => '绑定实时计算源名', 'description' => '绑定实时计算源名', 'type' => 'string', 'example' => 'ds2', ], 'NameSpaceTag' => [ 'title' => '名称空间：PUBLIC 公共类型、APPLICATION 应用类型、BASE 基础类型', 'description' => '名称空间：PUBLIC 公共类型、APPLICATION 应用类型、BASE 基础类型', 'type' => 'string', 'example' => 'BASE', ], 'Env' => [ 'title' => '环境标识', 'description' => '环境标识', 'type' => 'string', 'example' => 'DEV', ], 'WhiteLists' => [ 'title' => '白名单', 'description' => '白名单', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx 白名单', ], 'Ip' => [ 'title' => 'Ip', 'description' => 'Ip', 'type' => 'string', 'example' => '10.11.1.21', ], 'Port' => [ 'title' => '端口', 'description' => '端口', 'type' => 'string', 'example' => '5432', ], ], ], ], 'Mode' => [ 'title' => '项目模式', 'description' => '项目模式', 'type' => 'string', 'example' => 'BASIC', ], 'Type' => [ 'title' => '项目类型: DISTILL 萃取项目、GENERAL 一般类型项目', 'description' => '项目类型: DISTILL 萃取项目、GENERAL 一般类型项目', 'type' => 'string', 'example' => 'GENERAL', ], 'Id' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'Name' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'DisplayName' => [ 'title' => '项目展示名', 'description' => '项目展示名', 'type' => 'string', 'example' => 'xx test', ], 'Description' => [ 'title' => '项目描述', 'description' => '项目描述', 'type' => 'string', 'example' => '测试', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'Owner' => [ 'title' => '项目责任人', 'description' => '项目责任人', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '项目责任人', 'description' => '项目责任人', 'type' => 'string', 'example' => '张三', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ProjectInfo\\": {\\n \\"BizUnitId\\": 101131,\\n \\"BizUnitDisplayName\\": \\"测试\\",\\n \\"ComputeSourceId\\": 101711,\\n \\"ComputeSourceName\\": \\"ds1\\",\\n \\"StreamComputeSourceId\\": 201711,\\n \\"StreamComputeSourceName\\": \\"ds2\\",\\n \\"NameSpaceTag\\": \\"BASE\\",\\n \\"Env\\": \\"DEV\\",\\n \\"WhiteLists\\": [\\n {\\n \\"Description\\": \\"xx 白名单\\",\\n \\"Ip\\": \\"10.11.1.21\\",\\n \\"Port\\": \\"5432\\"\\n }\\n ],\\n \\"Mode\\": \\"BASIC\\",\\n \\"Type\\": \\"GENERAL\\",\\n \\"Id\\": 1030111021,\\n \\"Name\\": \\"test\\",\\n \\"DisplayName\\": \\"xx test\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"张三\\"\\n }\\n}","type":"json"}]', 'title' => '通过项目名获取项目详情', ], 'AddProjectMember' => [ 'summary' => '增加项目成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], ], [ 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '新增成员命令', 'description' => '新增成员命令', 'type' => 'object', 'properties' => [ 'Env' => [ 'title' => '环境标识: DEV、PROD', 'description' => '环境标识: DEV、PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'UserList' => [ 'title' => '用户成员', 'description' => '用户成员', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '30012011', ], 'RoleList' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'type' => 'array', 'items' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'required' => true, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '增加项目成员', ], 'GetProjectWhiteLists' => [ 'summary' => '获取项目白名单。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'WhiteLists' => [ 'title' => '项目白名单', 'description' => '项目白名单', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '测试', ], 'Ip' => [ 'title' => 'ip', 'description' => 'ip', 'type' => 'string', 'example' => '10.1.0.2', ], 'Port' => [ 'title' => '端口', 'description' => '端口', 'type' => 'string', 'example' => '5432', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"WhiteLists\\": [\\n {\\n \\"Description\\": \\"测试\\",\\n \\"Ip\\": \\"10.1.0.2\\",\\n \\"Port\\": \\"5432\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取项目白名单', ], 'ListProjectMembers' => [ 'summary' => '查询项目成员列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '请求对象', 'type' => 'object', 'properties' => [ 'Env' => [ 'title' => '环境标识', 'description' => '项目环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'PageSize' => [ 'title' => '分页记录数, 默认：20', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'PageNo' => [ 'title' => '页码, 默认：1', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => true, 'example' => '1030111021', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '项目成员总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '101', ], 'ProjectMemberList' => [ 'title' => '分页用户成员列表', 'description' => '项目成员列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '项目成员', 'type' => 'object', 'properties' => [ 'RoleIdList' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '角色', 'type' => 'array', 'items' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '角色编码，编码列表参考新增项目成员', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间戳', 'type' => 'string', 'example' => '1702692675000', ], 'LastModifier' => [ 'title' => '最后编辑用户Id', 'description' => '编辑人Id', 'type' => 'string', 'example' => '101111', ], 'UserName' => [ 'title' => '用户名', 'description' => '成员用户名', 'type' => 'string', 'example' => '测试用户', ], 'UserId' => [ 'title' => '用户ID', 'description' => '成员用户Id', 'type' => 'string', 'example' => '101111', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间戳', 'type' => 'string', 'example' => '1721720955000', ], 'Id' => [ 'title' => '用户成员ID', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12356', ], 'LastModifierName' => [ 'title' => '最后编辑用户名', 'description' => '编辑人', 'type' => 'string', 'example' => '测试用户', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 101,\\n \\"ProjectMemberList\\": [\\n {\\n \\"RoleIdList\\": [\\n 1\\n ],\\n \\"GmtCreate\\": \\"1702692675000\\",\\n \\"LastModifier\\": \\"101111\\",\\n \\"UserName\\": \\"测试用户\\",\\n \\"UserId\\": \\"101111\\",\\n \\"GmtModified\\": \\"1721720955000\\",\\n \\"Id\\": 12356,\\n \\"LastModifierName\\": \\"测试用户\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询项目成员列表', ], 'ListProjects' => [ 'summary' => '获取项目列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '关键字模糊匹配', 'description' => '关键字模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'TagList' => [ 'title' => '项目标签', 'description' => '项目标签', 'type' => 'array', 'items' => [ 'title' => '项目标签', 'description' => '项目标签', 'type' => 'string', 'required' => false, 'example' => 'GENERAL', ], 'required' => false, ], 'Mode' => [ 'title' => '项目模式', 'description' => '项目模式', 'type' => 'string', 'required' => false, 'example' => 'BASIC', ], 'Env' => [ 'title' => '环境标识', 'description' => '环境标识', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'PageNo' => [ 'title' => '页码, 默认：1', 'description' => '页码, 默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认：20', 'description' => '分页记录数, 默认：20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'ProjectList' => [ 'title' => '分页项目列表', 'description' => '分页项目列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'RealtimeDataSourceName' => [ 'title' => '实时计算源名', 'description' => '实时计算源名', 'type' => 'string', 'example' => 'ds2', ], 'Owner' => [ 'title' => '项目负责人', 'description' => '项目负责人', 'type' => 'string', 'example' => '30012112', ], 'OwnerName' => [ 'title' => '项目负责人', 'description' => '项目负责人', 'type' => 'string', 'example' => '张三', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '测试', ], 'Mode' => [ 'title' => '项目模式', 'description' => '项目模式', 'type' => 'string', 'example' => 'BASIC', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'Env' => [ 'title' => '环境标识', 'description' => '环境标识', 'type' => 'string', 'example' => 'DEV', ], 'Name' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'demo', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '162112', ], 'Type' => [ 'title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'example' => 'GENERAL', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'DataSourceName' => [ 'title' => '计算源名', 'description' => '计算源名', 'type' => 'string', 'example' => 'ds1', ], 'DisplayName' => [ 'title' => '项目展示名', 'description' => '项目展示名', 'type' => 'string', 'example' => '测试', ], 'Id' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'DataSourceId' => [ 'title' => '计算源Id', 'description' => '计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'RealtimeDataSourceId' => [ 'title' => '实时计算源Id', 'description' => '实时计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1122', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"ProjectList\\": [\\n {\\n \\"RealtimeDataSourceName\\": \\"ds2\\",\\n \\"Owner\\": \\"30012112\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Description\\": \\"测试\\",\\n \\"Mode\\": \\"BASIC\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"Env\\": \\"DEV\\",\\n \\"Name\\": \\"demo\\",\\n \\"BizUnitId\\": 162112,\\n \\"Type\\": \\"GENERAL\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"DataSourceName\\": \\"ds1\\",\\n \\"DisplayName\\": \\"测试\\",\\n \\"Id\\": 1030111021,\\n \\"DataSourceId\\": 1121,\\n \\"RealtimeDataSourceId\\": 1122\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询项目列表', ], 'RemoveProjectMember' => [ 'summary' => '删除项目成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], ], [ 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除成员命令', 'description' => '删除成员命令', 'type' => 'object', 'properties' => [ 'Env' => [ 'title' => '环境标识: DEV、PROD', 'description' => '环境标识: DEV、PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'UserIdList' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'array', 'items' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => '30012011', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除项目成员', ], 'ReplaceProjectWhiteLists' => [ 'summary' => '更新项目白名单。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'ReplaceCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑命令', 'description' => '编辑命令', 'type' => 'object', 'properties' => [ 'WhiteLists' => [ 'title' => '项目白名单', 'description' => '项目白名单', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => '测试', ], 'Ip' => [ 'title' => 'ip', 'description' => 'ip', 'type' => 'string', 'required' => true, 'example' => '10.1.0.2', ], 'Port' => [ 'title' => '端口', 'description' => '端口', 'type' => 'string', 'required' => true, 'example' => '5432', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '替换项目白名单', ], 'UpdateProjectMember' => [ 'summary' => '编辑项目成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑命令', 'description' => '编辑命令', 'type' => 'object', 'properties' => [ 'Env' => [ 'title' => '环境标识', 'description' => '环境标识', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'UserList' => [ 'title' => '用户成员', 'description' => '用户成员', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '30012011', ], 'RoleList' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'type' => 'array', 'items' => [ 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'description' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'required' => true, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '编辑项目成员', ], 'UpdateTenantComputeEngine' => [ 'summary' => '修改租户计算设置。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑指令', 'description' => '编辑指令', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'required' => true, 'example' => 'MacCompute', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'string', 'required' => false, 'example' => '1.0', ], 'ClusterUrlList' => [ 'title' => '集群节点连接列表', 'description' => '集群节点连接列表', 'type' => 'array', 'items' => [ 'title' => '集群节点连接列表', 'description' => '集群节点连接列表', 'type' => 'string', 'required' => true, 'example' => '10.1.11.2', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '修改租户计算设置', ], 'GetCheckConnectivityJobs' => [ 'summary' => '根据指定数据源ID查询连通性检查任务列表，包含空值校验和租户权限验证，防止跨租户访问。'."\n" .'发布版本号：v5.5.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DataSourceId', 'in' => 'query', 'schema' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '462935472785', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => 'result', 'description' => 'result', 'type' => 'array', 'items' => [ 'title' => 'CheckConnectivityJobDTO', 'description' => 'CheckConnectivityJobDTO', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'TenantId' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'string', 'example' => '30001011', ], 'JobType' => [ 'title' => '任务类型（应用级别或集群级别）', 'description' => '任务类型（应用级别或集群级别）', 'type' => 'string', 'example' => 'application/cluster', ], 'ErrorMsg' => [ 'title' => '错误信息（任务失败时的详细错误描述）', 'description' => '错误信息（任务失败时的详细错误描述）', 'type' => 'string', 'example' => 'notFoundIp', ], 'VoldemortTaskId' => [ 'title' => 'Voldemort任务ID（用于关联底层执行任务）', 'description' => 'Voldemort任务ID（用于关联底层执行任务）', 'type' => 'string', 'example' => 't_7572319950395080706_20251225_7572319950395080707', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => '192', ], 'JobId' => [ 'title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '123123', ], ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"TenantId\\": \\"30001011\\",\\n \\"JobType\\": \\"application/cluster\\",\\n \\"ErrorMsg\\": \\"notFoundIp\\",\\n \\"VoldemortTaskId\\": \\"t_7572319950395080706_20251225_7572319950395080707\\",\\n \\"DataSourceId\\": \\"192\\",\\n \\"JobId\\": \\"123123\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询数据源检查连通性任务', 'description' => '可以根据数据源Id查询已测试的连通性任务详细信息', ], 'GetDataSourceDependencies' => [ 'summary' => '查询数据源变更影响的集成任务及数据库SQL任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1023211', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'DependencyList' => [ 'title' => '引用记录', 'description' => '引用记录', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '依赖记录类型', 'description' => '依赖记录类型', 'type' => 'string', 'example' => 'pipeline', ], 'TypeCode' => [ 'title' => '依赖记录类型code', 'description' => '依赖记录类型code', 'type' => 'string', 'example' => 'pipeline', ], 'Id' => [ 'title' => '依赖记录id', 'description' => '依赖记录id', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'title' => '依赖记录名称', 'description' => '依赖记录名称', 'type' => 'string', 'example' => 'jytest', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"DependencyList\\": [\\n {\\n \\"Type\\": \\"pipeline\\",\\n \\"TypeCode\\": \\"pipeline\\",\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"jytest\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据源依赖列表', ], 'CreateDataSource' => [ 'summary' => '新建数据源：租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员 有权限操作。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '新建数据源请求', 'description' => '请求对象', 'type' => 'object', 'properties' => [ 'ProdDataSourceCreate' => [ 'title' => '数据源创建', 'description' => '生成环境数据源', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '数据源类型', 'description' => '数据源类型：'."\n" .'- MAX_COMPUTE'."\n" .'- HDFS'."\n" .'- LOG_HUB'."\n" .'- POLARDB'."\n" .'- HBASE_0_9_4'."\n" .'- HBASE_1_1_X'."\n" .'- DRDS'."\n" .'- HIVE'."\n" .'- FTP'."\n" .'- ELASTIC_SEARCH'."\n" .'- MYSQL'."\n" .'- MONGODB'."\n" .'- OSS'."\n" .'- HANA'."\n" .'- SQL_SERVER'."\n" .'- POSTGRE_SQL'."\n" .'- ANALYTICDB'."\n" .'- ADB_FOR_MYSQL_V3'."\n" .'- ADB_FOR_PG'."\n" .'- ORACLE'."\n" .'- VERTICA'."\n" .'- DB2'."\n" .'- TERA_DATA 等', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], 'Name' => [ 'title' => '名字', 'description' => '数据源名', 'type' => 'string', 'required' => true, 'example' => 'dp_test', ], 'Description' => [ 'title' => '描述', 'description' => '数据源描述', 'type' => 'string', 'required' => false, 'example' => 'datasource for xx', ], 'CheckActivity' => [ 'title' => '是否校验连通性', 'description' => '是否联通性校验', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项列表', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项keyId', 'description' => '配置项，不同数据库需要的Key值请查看文档下方补充说明', 'type' => 'string', 'required' => true, 'example' => 'jdbc.username', ], 'Value' => [ 'title' => '配置值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'username', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => false, ], 'DevDataSourceCreate' => [ 'title' => '新建开发环境数据源', 'description' => '开发环境数据源', 'type' => 'object', 'properties' => [ 'ProdDataSourceId' => [ 'title' => '关联生产环境数据源ID，如果只新建开发环境计算源时不能为空', 'description' => '关联生产环境数据源ID，如果只新建开发环境计算源时不能为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011', ], 'DataSourceCreate' => [ 'title' => '数据源创建', 'description' => '开发环境数据源', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], 'Name' => [ 'title' => '名字', 'description' => '数据源名', 'type' => 'string', 'required' => true, 'example' => 'dp_test_dev', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'datasource for xxx in dev ', ], 'CheckActivity' => [ 'title' => '是否校验连通性', 'description' => '是否连通性校验', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项列表', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项keyId', 'description' => '配置项，不同数据库需要的Key值请查看文档下方补充说明', 'type' => 'string', 'required' => true, 'example' => 'jdbc.username', ], 'Value' => [ 'title' => '配置值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'username', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '数据源新建结果', 'description' => '数据源新建结果', 'type' => 'object', 'properties' => [ 'DevDataSourceId' => [ 'title' => '开发环境数据源ID', 'description' => '开发环境数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'ProdDataSourceId' => [ 'description' => '生产环境数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"DevDataSourceId\\": 123,\\n \\"ProdDataSourceId\\": 12345\\n }\\n}","type":"json"}]', 'title' => '新建数据源', 'requestParamsDescription' => '## ConfigItemList参数Key说明'."\n" .'### MAX_COMPUTE'."\n" ."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|maxcompute.endpoint | 是 | |'."\n" .'|maxcompute.project | 是 | |'."\n" .'|maxcompute.access.id | 是 | |'."\n" .'|maxcompute.access.key | 是 | |'."\n" ."\n\n" ."\n" .'### HDFS'."\n" ."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|hadoop.kdc.address | 否 | 如果有.krb5.config.file，可以不写|'."\n" .'|hadoop.kerberos.krb5.config.file | 否 | 如果有hadoop.kdc.address，可以不写|'."\n" .'|hadoop.kerberos.krb5.config.filename | 是 | krb5.config文件名称|'."\n" .'|hdfs.kerberos.switch | 是 | 字符型类型：TRUE、FLASE，表示HDFS是否开启kerberos认证，|'."\n" .'|hdfs.kerberos.keytab.file | kerberos开启时必填 | HDFS principal认证文件ID，需要通过dataphin文件系统上传|'."\n" .'|hdfs.kerberos.keytab.filename | kerberos开启时必填 | HDFS principal认证文件名称|'."\n" .'|hdfs.kerberos.principal | kerberos开启时必填 | HDFS principal名称，如 xxx/master@DATAPHIN.COM|'."\n" .'|hdfs.defaultFs | 是 | defaultFs地址，如 namenode:8020|'."\n" ."\n\n" ."\n" .'### LOG_HUB'."\n" ."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|endPoint | 是 | |'."\n" .'|accessId | 是 | |'."\n" .'|accessKey | 是 | |'."\n" .'|projectName | 是 | |'."\n" ."\n\n" ."\n" .'### POLARDB'."\n" ."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|jdbc.url | 是 | |'."\n" .'|jdbc.username | 是 | |'."\n" .'|jdbc.password | 是 | |'."\n" .'|jdbc.database.schema | 是 | |'."\n" .'|deploy.type | 是 | 部署类型：PUBLIC（公网），RDS（阿里云），ECS（自建）；|'."\n" .'|如果是云上数据库，需要打通反向VPC网络，根据实际部署形态选择，其他情况为PUBLIC|'."\n" .'|access.type | 是 | 访问方式：PUBLIC，VPC，公共云环境需要反向VPC打通使用VPC，其他情况为PUBLIC|'."\n" .'|vpc.id | 否 | VPC环境下需要|'."\n" .'|vpc.region.id | 否 | VPC环境下需要|'."\n" .'|vpc.instance.id | 否 | VPC环境下需要|'."\n" .'|backend.db.type | 是 | backend数据库类型，MYSQL or POSTGRE_SQL|'."\n" ."\n\n" ."\n" .'### HBASE_0_9_4/HBASE_1_1_X'."\n" ."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|hadoop.kdc.address | 否 | 如果有.krb5.config.file，可以不写|'."\n" .'|hadoop.kerberos.krb5.config.file | 否 | 如果有hadoop.kdc.address，可以不写|'."\n" .'|hbase.kerberos.switch | 是 | 字符型类型：TRUE、FLASE，表示HDFS是否开启·kerberos认证，|'."\n" .'|hbase.kerberos.keytab.file | 否 | HDFS principal认证文件ID，需要通过dataphin文件系统上传|'."\n" .'|hbase.kerberos.principal | 否 | HDFS principal认证文件名称|'."\n" .'|hbase.cluster | 是 | Hbase集群连接串，支持Zk|'."\n" .'|hbase.connection.param | 否 | 连接参数|'."\n" ."\n\n" ."\n" .'### DRDS/POSTGRE_SQL/ORACLE/VERTICA/DRDS/ANALYTICDB/ADB_FOR_MYSQL_V3'."\n" .'|key | 是否必填 | 说明|'."\n" .'|:----------------------|:--------|:-------|'."\n" .'|jdbc.url | 是 | |'."\n" .'|jdbc.username | 是 | |'."\n" .'|jdbc.password | 是 | |'."\n" .'|jdbc.database.schema | 否 | 如果有schema，该项最好填写，或者在URL中加上schema参数，否则元数据服务可能报错|'."\n" .'|deploy.type | 是 | 部署类型：PUBLIC（公网），RDS（阿里云），ECS（自建）；|'."\n" .'|如果是云上数据库，需要打通反向VPC网络，根据实际部署形态选择，其他情况为PUBLIC|'."\n" .'|access.type | 是 | 访问方式：PUBLIC，VPC，公共云环境需要反向VPC打通使用VPC，其他情况为PUBLIC|'."\n" .'|vpc.id | 是 | VPC环境下需要|'."\n" .'|vpc.region.id | 是 | VPC环境下需要|'."\n" .'|vpc.instance.id | 是 | VPC环境下需要|'."\n" ."\n" .'### HIVE'."\n" ."\n" .'| key | 是否必填 | 说明 |'."\n" .'|:---------------------------------|:-----|:-------------------------------------------------------------------|'."\n" .'| hive.version | 是 | hive版本,如CDH5_HIVE_1_1_0，CDH6_HIVE_2_1_1，CDP7_HIVE_3_1_300等 |'."\n" .'| hadoop.namenode | 是 | namenode，支持host，IP例子:host=192.168.1.1,webUiPort=50070,ipcPort=8020 |'."\n" .'| hadoop.kerberos.switch | 是 | hadoop集群是否开启kerberos认证 |'."\n" .'| kerberos.config | 是 | Kerberos配置方式: kdc或krb |'."\n" .'| hadoop.kdc.address | 否 | kerberos Server地址，如果有.krb5.config.file，可以不写 |'."\n" .'| hadoop.kerberos.krb5.config.file | 否 | 如果有hadoop.kdc.address，可以不写 |'."\n" .'| hive.kerberos.switch | 是 | 字符型类型：TRUE、FLASE，表示hive是否开启kerberos认证， |'."\n" .'| hive.kerberos.keytab.file | 否 | hive principal认证文件ID，需要通过dataphin文件系统上传 |'."\n" .'| hive.kerberos.keytab.filename | 否 | hive principal认证文件名称 |'."\n" .'| hive.kerberos.principal | 否 | hive principal |'."\n" .'| hive.jdbc.url | 是 | hive 连接串，暂不支持ZK方式（ [ 'summary' => '删除数据源。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除数据源请求', 'description' => '删除数据源请求', 'type' => 'object', 'properties' => [ 'Mode' => [ 'title' => '删除模式：'."\n" .'DEV：只删除开发环境数据源'."\n" .'DEV_PROD：同时删除开发和生产环境数据源', 'description' => '删除模式：'."\n" .'- DEV：只删除开发环境数据源'."\n" .'- DEV_PROD：同时删除开发和生产环境数据源', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'DEV', 'enum' => [ 'DEV', 'DEV_PROD', ], ], 'ProdDataSourceId' => [ 'title' => '生成环境数据源ID', 'description' => '生产环境数据源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13121', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '删除数据源', ], 'UpdateDataSourceBasicInfo' => [ 'summary' => '编辑数据源基础信息：租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员 有权限操作。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '数据源基础信息编辑', 'description' => '数据源基础信息编辑', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23231', ], 'Name' => [ 'title' => '数据源名', 'description' => '数据源名', 'type' => 'string', 'required' => true, 'example' => 'xx测试', ], 'Description' => [ 'title' => '数据源描述', 'description' => '数据源描述', 'type' => 'string', 'required' => true, 'example' => 'xx', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '数据源基础信息编辑结果.', 'description' => '数据源基础信息编辑结果.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '编辑数据源基础信息', ], 'UpdateDataSourceConfig' => [ 'summary' => '编辑数据源链接配置项：租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员 有权限操作。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '数据源配置项变更', 'description' => '数据源配置项变更', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13231313', ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项keyId', 'description' => '配置项keyId', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置值', 'description' => '配置值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '数据源连接配置项编辑结果.', 'description' => '数据源连接配置项编辑结果.', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '编辑数据源链接配置项', ], 'ListDataSourceWithConfig' => [ 'summary' => '搜索数据源，所属结果包含数据源配置项。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询', 'description' => '分页查询', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '数据源名字', 'description' => '数据源名字', 'type' => 'string', 'required' => false, 'example' => 'vcns-test', ], 'TypeList' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'array', 'items' => [ 'description' => '数据源类型', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE', ], 'required' => false, ], 'ScopeList' => [ 'title' => '数据源使用范围，支持如下：'."\n" .'STREAMING 实时'."\n" .'OFFLINE 离线'."\n" .'DIP_META_SYNC 元仓初始化'."\n" .'DATA_DISTILL 数据萃取'."\n" .'CUMPUTE_SOURCE_SHADOW 影子计算源'."\n" .'LABEL 标签'."\n" .'ALL 离线+实时', 'description' => '数据源使用范围，支持如下：'."\n" .'- STREAMING 实时'."\n" .'- OFFLINE 离线'."\n" .'- DIP_META_SYNC 元仓初始化'."\n" .'- DATA_DISTILL 数据萃取'."\n" .'- CUMPUTE_SOURCE_SHADOW 影子计算源'."\n" .'- LABEL 标签'."\n" .'- ALL 离线+实时', 'type' => 'array', 'items' => [ 'description' => '数据源使用范围', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'required' => false, ], 'OwnerList' => [ 'title' => '数据源负责人', 'description' => '数据源负责人', 'type' => 'array', 'items' => [ 'description' => '用户ID', 'type' => 'string', 'required' => false, 'example' => '2323131', ], 'required' => false, ], 'Tag' => [ 'title' => '创建数据源时标记的tag', 'description' => '创建数据源时标记的标签', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Page' => [ 'title' => '页码，起始页是1', 'description' => '页码，起始页是1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'default' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'default' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '39', ], 'DataSourceList' => [ 'description' => '分页列表', 'type' => 'array', 'items' => [ 'description' => '数据源', 'type' => 'object', 'properties' => [ 'ProdDataSourceInfo' => [ 'description' => '生产环境数据源', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '300000028799', ], 'Name' => [ 'title' => '数据源名', 'description' => '数据源名', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Scope' => [ 'title' => '数据源使用范围', 'description' => '数据源使用范围', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1708303959000', ], 'ModifyTime' => [ 'title' => '编辑时间', 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1708303959000', ], 'Creator' => [ 'title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'example' => '212211111', ], 'CreatorName' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '张三', ], 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '212211111', ], 'OwnerName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => '张三', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx 测试', ], 'Env' => [ 'title' => '数据源所属环境', 'description' => '数据源所属环境', 'type' => 'string', 'example' => 'PROD', ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项Id', 'description' => '配置项Id', 'type' => 'string', 'example' => 'param1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], 'DevDataSourceInfo' => [ 'description' => '开发环境数据源', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12313123131', ], 'Name' => [ 'title' => '数据源名', 'description' => '数据源名', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Scope' => [ 'title' => '数据源使用范围', 'description' => '数据源使用范围', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710209552704', ], 'ModifyTime' => [ 'title' => '编辑时间', 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710209552704', ], 'Creator' => [ 'title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'example' => '212211111', ], 'CreatorName' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '张三', ], 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '212211111', ], 'OwnerName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => '张三', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx 项目', ], 'Env' => [ 'title' => '数据源所属环境', 'description' => '数据源所属环境', 'type' => 'string', 'example' => 'DEV', ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项Id', 'description' => '配置项Id', 'type' => 'string', 'example' => 'param1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 39,\\n \\"DataSourceList\\": [\\n {\\n \\"ProdDataSourceInfo\\": {\\n \\"Id\\": 300000028799,\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"MAX_COMPUTE\\",\\n \\"Scope\\": \\"ALL\\",\\n \\"CreateTime\\": 1708303959000,\\n \\"ModifyTime\\": 1708303959000,\\n \\"Creator\\": \\"212211111\\",\\n \\"CreatorName\\": \\"张三\\",\\n \\"Owner\\": \\"212211111\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Description\\": \\"xx 测试\\",\\n \\"Env\\": \\"PROD\\",\\n \\"ConfigItemList\\": [\\n {\\n \\"Key\\": \\"param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"DevDataSourceInfo\\": {\\n \\"Id\\": 12313123131,\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"MAX_COMPUTE\\",\\n \\"Scope\\": \\"ALL\\",\\n \\"CreateTime\\": 1710209552704,\\n \\"ModifyTime\\": 1710209552704,\\n \\"Creator\\": \\"212211111\\",\\n \\"CreatorName\\": \\"张三\\",\\n \\"Owner\\": \\"212211111\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Description\\": \\"xx 项目\\",\\n \\"Env\\": \\"DEV\\",\\n \\"ConfigItemList\\": [\\n {\\n \\"Key\\": \\"param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询数据源列表', ], 'CheckDataSourceConnectivity' => [ 'summary' => '校验数据源连通性。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CheckCommand', 'in' => 'formData', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'title' => '校验对象', 'description' => '校验对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '数据源类型', 'description' => '数据源类型，可支持数据源见新建数据源', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', 'enum' => [], ], 'ConfigItemList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项keyId', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置值', 'description' => '配置值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '数据源连接校验结果', 'description' => '数据源连接校验结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '校验数据源连通性', ], 'CheckDataSourceConnectivityById' => [ 'summary' => '校验数据源连通性。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '数据源连接校验结果', 'description' => '数据源连接校验结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '通过数据源ID校验连通性', ], 'CheckComputeSourceConnectivity' => [ 'summary' => '校验连通性校验。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CheckCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '校验指令', 'description' => '校验指令', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], 'ConfigList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '计算源连通性校验', ], 'CheckComputeSourceConnectivityById' => [ 'summary' => '通过计算源Id校验已存在计算源连通性。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '计算源Id', 'description' => '计算源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '通过计算源Id校验连通性', ], 'ListComputeSources' => [ 'summary' => '查询计算源列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', ], 'BindProject' => [ 'title' => '是否绑定项目', 'description' => '是否绑定项目', 'type' => 'boolean', 'required' => false, ], 'Keyword' => [ 'title' => '关键字', 'description' => '关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'ComputeSourceList' => [ 'title' => '分页计算源列表', 'description' => '分页计算源列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Owner' => [ 'title' => '计算源归属人', 'description' => '计算源归属人', 'type' => 'string', 'example' => '30012211', ], 'OwnerName' => [ 'title' => '计算源归属人', 'description' => '计算源归属人', 'type' => 'string', 'example' => '张三', ], 'BindProjectId' => [ 'title' => '绑定项目Id', 'description' => '绑定项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10132131111', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'BindProject' => [ 'title' => '是否绑定项目', 'description' => '是否绑定项目', 'type' => 'boolean', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012211', ], 'Name' => [ 'title' => '计算源名', 'description' => '计算源名', 'type' => 'string', 'example' => 'test1011', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'example' => 'MaxCompute', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'test1011', ], 'Id' => [ 'title' => '计算源Id', 'description' => '计算源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '102111', ], 'BindProjectName' => [ 'title' => '绑定项目名称', 'description' => '绑定项目名称', 'type' => 'string', 'example' => 'testPrj', ], 'CreatorName' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '张三', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"ComputeSourceList\\": [\\n {\\n \\"Owner\\": \\"30012211\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"BindProjectId\\": 10132131111,\\n \\"Description\\": \\"test\\",\\n \\"BindProject\\": true,\\n \\"GmtModified\\": \\"2025-06-30 08:00:00\\",\\n \\"Creator\\": \\"30012211\\",\\n \\"Name\\": \\"test1011\\",\\n \\"GmtCreate\\": \\"2025-06-30 08:00:00\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"DisplayName\\": \\"test1011\\",\\n \\"Id\\": 102111,\\n \\"BindProjectName\\": \\"testPrj\\",\\n \\"CreatorName\\": \\"张三\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询计算源列表', ], 'UpdateComputeSource' => [ 'summary' => '编辑计算源：业务板块管理员、项目管理员 有权限操作。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑指令', 'description' => '编辑指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '计算源Id', 'description' => '计算源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102311', ], 'Name' => [ 'title' => '计算源名称', 'description' => '计算源名称', 'type' => 'string', 'required' => true, 'example' => 'test1021', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'required' => true, 'example' => 'MacCompute', ], 'ConfigList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '编辑计算源', ], 'GetComputeSource' => [ 'summary' => '通过计算源Id获取计算源详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '计算源Id', 'description' => '计算源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ComputeSourceInfo' => [ 'title' => '计算源详情', 'description' => '计算源详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '计算源Id', 'description' => '计算源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12356', ], 'Name' => [ 'title' => '计算源名', 'description' => '计算源名', 'type' => 'string', 'example' => 'dp_test', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '显示名', 'type' => 'string', 'example' => 'dp_test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'compute source for xxx.', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间戳', 'type' => 'string', 'example' => '1681881607000', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '编辑时间戳', 'type' => 'string', 'example' => '1711881607000', ], 'Owner' => [ 'title' => '计算源归属人', 'description' => '计算源所有者ID', 'type' => 'string', 'example' => '101101', ], 'Creator' => [ 'title' => '创建者', 'description' => '计算源创建者ID', 'type' => 'string', 'example' => '101101', ], 'OwnerName' => [ 'title' => '计算源归属人', 'description' => '计算源所有者', 'type' => 'string', 'example' => 'test', ], 'CreatorName' => [ 'title' => '创建者', 'description' => '计算源创建者', 'type' => 'string', 'example' => 'test', ], 'BindProjectName' => [ 'title' => '绑定项目名称', 'description' => '绑定项目', 'type' => 'string', 'example' => 'dp_mctest', ], 'BindProjectId' => [ 'title' => '绑定项目Id', 'description' => '绑定项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10101101', ], 'BindProject' => [ 'title' => '是否绑定项目', 'description' => '是否已绑定项目', 'type' => 'boolean', 'example' => 'true', ], 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ComputeSourceInfo\\": {\\n \\"Id\\": 12356,\\n \\"Name\\": \\"dp_test\\",\\n \\"DisplayName\\": \\"dp_test\\",\\n \\"Description\\": \\"compute source for xxx.\\",\\n \\"GmtCreate\\": \\"1681881607000\\",\\n \\"GmtModified\\": \\"1711881607000\\",\\n \\"Owner\\": \\"101101\\",\\n \\"Creator\\": \\"101101\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"BindProjectName\\": \\"dp_mctest\\",\\n \\"BindProjectId\\": 10101101,\\n \\"BindProject\\": true,\\n \\"Type\\": \\"MAX_COMPUTE\\"\\n }\\n}","type":"json"}]', 'title' => '获取计算源详情', ], 'DeleteComputeSource' => [ 'summary' => '删除计算源。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '计算源Id', 'description' => '计算源ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除计算源', ], 'CreateComputeSource' => [ 'summary' => '新建计算源：业务板块管理员、项目管理员 有权限操作。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建命令', 'description' => '创建命令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '计算源名', 'description' => '计算源名', 'type' => 'string', 'required' => true, 'example' => 'test1011', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Type' => [ 'title' => '计算源类型', 'description' => '计算源类型', 'type' => 'string', 'required' => true, 'example' => 'MacCompute', ], 'ConfigList' => [ 'title' => '连接配置项', 'description' => '连接配置项', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'True', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '创建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '计算源Id', 'description' => '计算源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12356', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"Id\\": 12356\\n }\\n}","type":"json"}]', 'title' => '新建计算源', ], 'GetSparkLocalClientInfo' => [ 'summary' => '获取计算源对应集群的spark客户信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => '232432343', ], ], [ 'name' => 'EnvEnum', 'in' => 'query', 'schema' => [ 'title' => '环境标识：'."\n" .'DEV：开发环境'."\n" .'PROD：生产环境', 'description' => '环境标识：'."\n" .'DEV：开发环境'."\n" .'PROD：生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '响应结果', 'type' => 'array', 'items' => [ 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'ClientName' => [ 'description' => '客户端名称', 'type' => 'string', 'example' => 'spark-clinet', ], 'ClientFileResourceName' => [ 'description' => '客户端文件名称', 'type' => 'string', 'example' => 'spark-cleint.zip', ], 'ClientFileResourceId' => [ 'description' => '客户端文件id', 'type' => 'string', 'example' => 'XXXX-XXXX-XXXX-XXXX', ], 'Editable' => [ 'description' => '可否编辑', 'type' => 'boolean', 'example' => 'true/false', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"ClientName\\": \\"spark-clinet\\",\\n \\"ClientFileResourceName\\": \\"spark-cleint.zip\\",\\n \\"ClientFileResourceId\\": \\"XXXX-XXXX-XXXX-XXXX\\",\\n \\"Editable\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取计算源对应集群的spark客户信息', ], 'SyncDepartment' => [ 'summary' => '同步部门信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SyncDepartmentCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'DepartmentList' => [ 'description' => '部门列表（全量组织树）', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DepartmentId' => [ 'title' => '部门ID（部门唯一标识）', 'description' => '部门ID（部门唯一标识）', 'type' => 'string', 'required' => true, 'example' => '10001', ], 'DepartmentName' => [ 'title' => '部门展示名称', 'description' => '部门展示名称', 'type' => 'string', 'required' => true, 'example' => '研发中心', ], 'ParentDepartmentId' => [ 'title' => '父部门ID（部门唯一标识，如无则为null）', 'description' => '父部门ID（部门唯一标识，如无则为null）', 'type' => 'string', 'required' => false, 'example' => '10001', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '同步结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '同步部门信息', 'description' => '可以根据appKey查询已发布接口的详细信息', 'extraInfo' => '接口上线版本：v5.1.0', ], 'SyncDepartmentUser' => [ 'summary' => '同步部门成员信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SyncDepartmentUserCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'DeptUserMapping' => [ 'description' => '用户归属部门关系', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceUserId' => [ 'title' => '用户系统的用户ID（用户唯一标识）', 'description' => '用户系统的用户ID（用户唯一标识）', 'type' => 'string', 'required' => true, 'example' => '30000001', ], 'DepartmentIdList' => [ 'title' => '用户归属部门ID列表（为空则为删除用户归属关系）', 'description' => '用户归属部门ID列表（为空则为删除用户归属关系）', 'type' => 'array', 'items' => [ 'description' => '用户归属部门ID', 'type' => 'string', 'required' => true, 'example' => 'DEPT_1', ], 'required' => false, ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '响应结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '同步部门成员信息', 'extraInfo' => '接口上线版本：v5.1.0', ], 'TransferOwnershipForAllObject' => [ 'summary' => '一键转交负责人。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PrivilegeTransferRecord', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '转交信息', 'type' => 'object', 'properties' => [ 'OldOwner' => [ 'title' => '转出人用户ID', 'description' => '转出人用户ID', 'type' => 'string', 'required' => true, 'example' => '30000001', ], 'NewOwner' => [ 'title' => '接收人用户ID', 'description' => '接收人用户ID', 'type' => 'string', 'required' => true, 'example' => '30000002', ], 'TransferComment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '转交记录ID', 'description' => '转交记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '一键转交负责人', ], 'RetryTransferOwnership' => [ 'summary' => '重新转交运行失败的转交任务。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PrivilegeTransferRecord', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '转交信息', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '转出任务ID', 'description' => '转出任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'NewOwner' => [ 'title' => '接收人用户ID', 'description' => '接收人用户ID', 'type' => 'string', 'required' => true, 'example' => '30000001', ], 'TransferComment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '转交记录ID', 'description' => '转交记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 2\\n}","type":"json"}]', 'title' => '重新转交运行失败的转交任务', ], 'GetTransferInfo' => [ 'summary' => '根据转交任务ID查询转交任务的进度。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProposalId', 'in' => 'query', 'schema' => [ 'title' => '转交记录ID', 'description' => '转交记录ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'ProposalId' => [ 'title' => '审批单id', 'description' => '审批单id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FlowId' => [ 'title' => '审批单flowId', 'description' => '审批单flowId', 'type' => 'integer', 'format' => 'int64', 'example' => '1753669315426', ], 'Title' => [ 'title' => '审批单title', 'description' => '审批单title', 'type' => 'string', 'example' => 'transefer title', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30000001', ], 'DisplayName' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'OldOwner' => [ 'title' => '旧的owner', 'description' => '旧的owner', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30000001', ], 'DisplayName' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'NewOwner' => [ 'title' => '新的owner', 'description' => '新的owner', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30000001', ], 'DisplayName' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'PrivilegeTransferMode' => [ 'title' => '转交模式：一键转交-ONE_STOP,根据功能模块转交-FUNCTION_MODULE_BASED', 'description' => '转交模式：一键转交-ONE_STOP,根据功能模块转交-FUNCTION_MODULE_BASED', 'type' => 'string', 'example' => 'ONE_STOP', ], 'TransferComment' => [ 'title' => '转交描述', 'description' => '转交描述', 'type' => 'string', 'example' => 'comment', ], 'TransferStatus' => [ 'title' => '转交状态', 'description' => '转交状态', 'type' => 'string', 'enumValueTitles' => [ 'REVOKED' => '已被管理员强行撤回', 'SUCCESS' => '权限转交成功', 'FAILED' => '权限转交失败：处理中出错', 'APPROVING' => '审批中', 'CANCELED' => '已取消', 'APPROVED' => '审批人已同意，正在处理中', 'RETRY' => '已重试', 'REJECTED' => '审批人已拒绝', ], 'example' => 'APPROVED', ], 'LastModifier' => [ 'title' => '最后修改人', 'description' => '最后修改人', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30000001', ], 'DisplayName' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'PrivilegeTransferResultEntries' => [ 'title' => '功能模块的转交详情', 'description' => '功能模块的转交详情', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '转交模块状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'PrivilegeDisplayName' => [ 'description' => '转交模块名称', 'type' => 'string', 'example' => 'table owner', ], 'ErrMsg' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'userId is error', ], ], ], ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '1632036495973809', ], 'GmtModified' => [ 'title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'string', 'example' => '1632036495973809', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ProposalId\\": 1,\\n \\"FlowId\\": 1753669315426,\\n \\"Title\\": \\"transefer title\\",\\n \\"Creator\\": {\\n \\"UserId\\": \\"30000001\\",\\n \\"DisplayName\\": \\"zhangsan\\"\\n },\\n \\"OldOwner\\": {\\n \\"UserId\\": \\"30000001\\",\\n \\"DisplayName\\": \\"zhangsan\\"\\n },\\n \\"NewOwner\\": {\\n \\"UserId\\": \\"30000001\\",\\n \\"DisplayName\\": \\"zhangsan\\"\\n },\\n \\"PrivilegeTransferMode\\": \\"ONE_STOP\\",\\n \\"TransferComment\\": \\"comment\\",\\n \\"TransferStatus\\": \\"APPROVED\\",\\n \\"LastModifier\\": {\\n \\"UserId\\": \\"30000001\\",\\n \\"DisplayName\\": \\"zhangsan\\"\\n },\\n \\"PrivilegeTransferResultEntries\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"PrivilegeDisplayName\\": \\"table owner\\",\\n \\"ErrMsg\\": \\"userId is error\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"1632036495973809\\",\\n \\"GmtModified\\": \\"1632036495973809\\"\\n }\\n}","type":"json"}]', 'title' => '根据转交任务ID查询转交任务的进度', ], 'AddTenantMembers' => [ 'summary' => '批量添加用户至租户，该API仅支持超级管理员（SuperAdmin）和系统管理员能调用。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'UserList' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'array', 'items' => [ 'title' => '成员对象', 'description' => '成员对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'required' => false, 'example' => '1323241', ], 'RoleList' => [ 'title' => '用户Id', 'description' => '角色列表'."\n" .'- SYSTEM_ADMIN'."\n" .'- DATASOURCE_MANAGER'."\n" .'- SECURITY_ADMIN'."\n" .'- QUALITY_MANAGER'."\n" .'- EXPORT_ADMIN'."\n" .'- DATA_STANDARD_MANAGER'."\n" .'- LABELS_BUSINESS_PLANNER'."\n" .'- BUSINESS_MEMBER', 'type' => 'array', 'items' => [ 'title' => '角色列表', 'description' => '角色', 'type' => 'string', 'required' => false, 'example' => 'SECURITY_ADMIN', ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '新增租户成员结果', 'description' => '新增租户成员结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '添加用户到租户', ], 'AddTenantMembersBySourceUser' => [ 'summary' => '通过原始用户添加租户成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '添加请求', 'type' => 'object', 'properties' => [ 'SourceUserList' => [ 'description' => '来源用户列表', 'type' => 'array', 'items' => [ 'description' => '来源用户', 'type' => 'object', 'properties' => [ 'SourceId' => [ 'title' => '用户原始Id', 'description' => '用户原始Id', 'type' => 'string', 'required' => false, 'example' => '2323131', ], 'DisplayName' => [ 'title' => '显示名', 'description' => '显示名', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'AccountName' => [ 'title' => '账号名称', 'description' => '账号名称', 'type' => 'string', 'required' => false, 'example' => '123@xx.com', ], 'MobilePhone' => [ 'title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'required' => false, 'example' => '13888888888', ], 'Mail' => [ 'title' => '邮箱', 'description' => '邮箱', 'type' => 'string', 'required' => false, 'example' => '123@xx.com', ], 'DingNumber' => [ 'title' => '钉钉号', 'description' => '钉钉号', 'type' => 'string', 'required' => false, 'example' => '123@dingding', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '添加结果', 'description' => '添加结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '根据认证系统的来源用户ID添加用户到租户', ], 'CreateUserGroup' => [ 'summary' => '新建用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '新建请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '用户组名称', 'description' => '用户组名称', 'type' => 'string', 'required' => false, 'example' => 'xx用户组', ], 'Description' => [ 'title' => '用户组描述', 'description' => '用户组描述', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'Active' => [ 'title' => '是否启用用户组', 'description' => '是否启用用户组', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'AdminUserIdList' => [ 'title' => '用户组管理员用户Id', 'description' => '用户组管理员用户Id', 'type' => 'array', 'items' => [ 'title' => '用户组管理员用户Id', 'description' => '用户组管理员用户Id', 'type' => 'string', 'required' => false, 'example' => '23231', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'UserGroupId' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'example' => '2313131', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"UserGroupId\\": \\"2313131\\"\\n}","type":"json"}]', 'title' => '新建用户组', ], 'AddUserGroupMember' => [ 'summary' => '添加用户组成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '添加用户组成员', 'description' => '添加用户组成员', 'type' => 'object', 'properties' => [ 'UserGroupId' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '132331', ], 'UserIdList' => [ 'title' => '用户Id列表', 'description' => '用户Id列表', 'type' => 'array', 'items' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => '342313', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '添加结果', 'description' => '添加结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '添加用户组成员', ], 'DeleteUserGroup' => [ 'summary' => '删除用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '232131', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '删除用户组', ], 'UpdateUserGroup' => [ 'summary' => '编辑用户组。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑用户组', 'description' => '编辑用户组', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '13423', ], 'Name' => [ 'title' => '用户组名称', 'description' => '用户组名称', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'AdminUserIdList' => [ 'title' => '用户组管理员', 'description' => '用户组管理员', 'type' => 'array', 'items' => [ 'title' => '用户组管理员', 'description' => '用户组管理员', 'type' => 'string', 'required' => false, 'example' => '2323131', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '编辑结果', 'description' => '编辑结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '更新用户组', ], 'UpdateUserGroupSwitch' => [ 'summary' => '修改用户组的启用状态。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '31323', ], ], [ 'name' => 'Active', 'in' => 'query', 'schema' => [ 'title' => '是否启用用户组标识', 'description' => '是否启用用户组标识', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '编辑结果', 'description' => '编辑结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '修改用户组的启用状态', ], 'UpdateTenantMember' => [ 'summary' => '编辑租户成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求对象', 'description' => '请求对象', 'type' => 'object', 'properties' => [ 'MemberList' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'array', 'items' => [ 'title' => '成员对象', 'description' => '成员对象', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => '2331', ], 'MobilePhone' => [ 'title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'required' => false, 'example' => '13888888888', ], 'Mail' => [ 'title' => '邮箱', 'description' => '邮箱', 'type' => 'string', 'required' => false, 'example' => '123@xx.com', ], 'DingNumber' => [ 'title' => '钉钉号', 'description' => '钉钉号', 'type' => 'string', 'required' => false, 'example' => '123@dingding', ], 'RoleList' => [ 'title' => '角色列表', 'description' => '角色列表', 'type' => 'array', 'items' => [ 'title' => '角色', 'description' => '角色', 'type' => 'string', 'required' => false, 'example' => 'SECURITY_ADMIN', ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '编辑租户成员', ], 'ListResourcePermissionOperationLog' => [ 'summary' => '分页获取权限操作列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页请求', 'description' => '分页请求', 'type' => 'object', 'properties' => [ 'TabType' => [ 'title' => 'TAB名称：表：TABLE;数据源：DATASOURCE', 'description' => 'TAB名称：表：TABLE;数据源：DATASOURCE', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'SearchText' => [ 'title' => '搜索关键词', 'description' => '搜索关键词', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '121', ], 'Data' => [ 'title' => '分页记录', 'description' => '分页记录', 'type' => 'array', 'items' => [ 'title' => '操作日志', 'description' => '操作日志', 'type' => 'object', 'properties' => [ 'OperateId' => [ 'title' => '操作Id', 'description' => '操作Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123133', ], 'OperateType' => [ 'title' => '操作类型: 申请：APPLY；授权：GRANT', 'description' => '操作类型：'."\n" .'- APPLY 申请'."\n" .'- GRANT 授权', 'type' => 'string', 'example' => 'APPLY', ], 'ResourceInfo' => [ 'title' => '权限资源', 'description' => '权限资源', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '权限资源ID', 'description' => '权限资源ID', 'type' => 'string', 'example' => 'a.tb1', ], 'Name' => [ 'title' => '权限资源名称', 'description' => '权限资源名称', 'type' => 'string', 'example' => 'tb1', ], 'DisplayName' => [ 'title' => '资源展示名称', 'description' => '资源展示名称', 'type' => 'string', 'example' => 'tb1', ], 'Type' => [ 'title' => '资源类型 PHYSICAL_TABLE,PHYSICAL_VIEW,LOGICAL_TABLE,LOGICAL_VIEW,REALTIME_LOGICAL_TABLE,REALTIME_MIRROR_TABLE,DATASOURCE', 'description' => '资源类型'."\n" .'- PHYSICAL_TABLE：物理表'."\n" .'- PHYSICAL_VIEW：物理视图'."\n" .'- LOGICAL_TABLE：事实逻辑表'."\n" .'- LOGICAL_VIEW：事实逻辑视图'."\n" .'- REALTIME_LOGICAL_TABLE：实时元表'."\n" .'- REALTIME_MIRROR_TABLE：实时元表'."\n" .'- DATASOURCE：数据源', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'Env' => [ 'title' => '资源环境类型 开发：DEV；生产：PROD', 'description' => '资源环境'."\n" .'- DEV'."\n" .'- PROD', 'type' => 'string', 'example' => 'DEV', ], 'BizUnitInfo' => [ 'title' => '业务板块', 'description' => '业务板块', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Id', 'description' => 'Id', 'type' => 'string', 'example' => '121323', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'xx', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'xx', ], 'Env' => [ 'title' => '环境标识 开发：DEV；生产：PROD', 'description' => '环境标识 '."\n" .'- DEV'."\n" .'- PROD', 'type' => 'string', 'example' => 'DEV', ], ], ], 'ProjectInfo' => [ 'title' => '项目', 'description' => '项目', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1123131', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'xx', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'xx', ], 'Env' => [ 'title' => '环境标识 开发：DEV；生产：PROD', 'description' => '环境标识 '."\n" .'- DEV'."\n" .'- PROD', 'type' => 'string', 'example' => 'DEV', ], ], ], ], ], 'Account' => [ 'title' => '操作人', 'description' => '操作人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '账号ID'."\n" .'- 个人账号：Dataphin侧userId'."\n" .'- 生产账号：UserId，通过GetProjectProduceUser接口获取'."\n" .'- 用户组：用户组Id，通过ListUserGroup接口获取', 'type' => 'string', 'example' => '1212131', ], 'Name' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '账号名称', 'type' => 'string', 'example' => 'xx', ], 'Type' => [ 'title' => '授权账号类型：PERSONAL（个人账号），PRODUCE（生产账号）,USER_GROUP（用户组）', 'description' => '授权账号类型'."\n" .'- PERSONAL：个人账号'."\n" .'- PRODUCE：生产账号'."\n" .'- USER_GROUP：用户组', 'type' => 'string', 'example' => 'PERSONAL', ], ], ], 'TargetAccount' => [ 'title' => '被授权对象', 'description' => '被授权对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '账号ID', 'type' => 'string', 'example' => '1212131', ], 'Name' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '账号名称', 'type' => 'string', 'example' => 'xx', ], 'Type' => [ 'title' => '授权账号类型：PERSONAL（个人账号），PRODUCE（生产账号）,USER_GROUP（用户组）', 'description' => '授权账号类型', 'type' => 'string', 'example' => 'PERSONAL', ], ], ], 'Reason' => [ 'title' => '原因', 'description' => '原因', 'type' => 'string', 'example' => 'xx测试', ], 'OperateTime' => [ 'title' => '操作时间', 'description' => '操作时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710012121000', ], 'Period' => [ 'title' => '有效期设置', 'description' => '有效期设置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '有效期类型'."\n" .'自定义：CUSTOM；长期：LONG_TERM', 'description' => '有效期类型'."\n" .'- CUSTOM：自定义'."\n" .'- LONG_TERM：长期有效'."\n" .'- DAYS_30：30天有效'."\n" .'- DAYS_90：90天有效'."\n" .'- DAYS_180：180天有效', 'type' => 'string', 'example' => 'CUSTOM', ], 'EndTime' => [ 'title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '1712000000000', ], ], ], 'AuthScope' => [ 'title' => '表的授权范围 制定表：selectTable 项目下所有表：projectAllTable，板块下所有逻辑表：bizUnitAllLogicTable', 'description' => '表的授权范围'."\n" .'- selectTable：指定表'."\n" .'- projectAllTable：项目下所有表'."\n" .'- bizUnitAllLogicTable：板块下所有逻辑表', 'type' => 'string', 'example' => 'selectTable', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 121,\\n \\"Data\\": [\\n {\\n \\"OperateId\\": 123133,\\n \\"OperateType\\": \\"APPLY\\",\\n \\"ResourceInfo\\": {\\n \\"Id\\": \\"a.tb1\\",\\n \\"Name\\": \\"tb1\\",\\n \\"DisplayName\\": \\"tb1\\",\\n \\"Type\\": \\"PHYSICAL_TABLE\\",\\n \\"Env\\": \\"DEV\\",\\n \\"BizUnitInfo\\": {\\n \\"Id\\": \\"121323\\",\\n \\"Name\\": \\"xx\\",\\n \\"DisplayName\\": \\"xx\\",\\n \\"Env\\": \\"DEV\\"\\n },\\n \\"ProjectInfo\\": {\\n \\"Id\\": 1123131,\\n \\"Name\\": \\"xx\\",\\n \\"DisplayName\\": \\"xx\\",\\n \\"Env\\": \\"DEV\\"\\n }\\n },\\n \\"Account\\": {\\n \\"Id\\": \\"1212131\\",\\n \\"Name\\": \\"xx\\",\\n \\"Type\\": \\"PERSONAL\\"\\n },\\n \\"TargetAccount\\": {\\n \\"Id\\": \\"1212131\\",\\n \\"Name\\": \\"xx\\",\\n \\"Type\\": \\"PERSONAL\\"\\n },\\n \\"Reason\\": \\"xx测试\\",\\n \\"OperateTime\\": 1710012121000,\\n \\"Period\\": {\\n \\"Type\\": \\"CUSTOM\\",\\n \\"EndTime\\": \\"1712000000000\\"\\n },\\n \\"AuthScope\\": \\"selectTable\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页获取权限操作日志', ], 'ListResourcePermissions' => [ 'summary' => '分页获取权限授权记录。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页请求', 'description' => '分页请求', 'type' => 'object', 'properties' => [ 'TabType' => [ 'title' => 'TAB名称：表：TABLE;数据源：DATASOURCE', 'description' => 'TAB名称：表：TABLE;数据源：DATASOURCE', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'SearchText' => [ 'title' => '搜索关键词', 'description' => '搜索关键词', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '121', ], 'Data' => [ 'title' => '分页列表', 'description' => '分页列表', 'type' => 'array', 'items' => [ 'title' => '资源权限明细', 'description' => '资源权限明细', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '记录ID', 'description' => '记录ID', 'type' => 'string', 'example' => '12123111', ], 'ResourceInfo' => [ 'title' => '权限资源', 'description' => '权限资源', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '权限资源ID', 'description' => '权限资源ID', 'type' => 'string', 'example' => 'a.tb1', ], 'Name' => [ 'title' => '权限资源名称', 'description' => '权限资源名称', 'type' => 'string', 'example' => 'tb1', ], 'DisplayName' => [ 'title' => '资源展示名称', 'description' => '资源展示名称', 'type' => 'string', 'example' => 'tb1', ], 'Type' => [ 'title' => '资源类型 PHYSICAL_TABLE,PHYSICAL_VIEW,LOGICAL_TABLE,LOGICAL_VIEW,REALTIME_LOGICAL_TABLE,REALTIME_MIRROR_TABLE,DATASOURCE', 'description' => '资源类型 PHYSICAL_TABLE,PHYSICAL_VIEW,LOGICAL_TABLE,LOGICAL_VIEW,REALTIME_LOGICAL_TABLE,REALTIME_MIRROR_TABLE,DATASOURCE', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'Env' => [ 'title' => '资源环境类型 开发：DEV；生产：PROD', 'description' => '资源环境类型 开发：DEV；生产：PROD', 'type' => 'string', 'example' => 'DEV', ], 'BizUnitInfo' => [ 'title' => '业务板块', 'description' => '业务板块', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Id', 'description' => 'Id', 'type' => 'string', 'example' => '121323', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'xx', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'xx', ], 'Env' => [ 'title' => '环境标识 开发：DEV；生产：PROD', 'description' => '环境标识 开发：DEV；生产：PROD', 'type' => 'string', 'example' => 'DEV', ], ], ], 'ProjectInfo' => [ 'title' => '项目', 'description' => '项目', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1123131', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'xx', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'xx', ], 'Env' => [ 'title' => '环境标识 开发：DEV；生产：PROD', 'description' => '环境标识 开发：DEV；生产：PROD', 'type' => 'string', 'example' => 'DEV', ], ], ], ], ], 'TargetAccount' => [ 'title' => '被授权对象', 'description' => '被授权对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'type' => 'string', 'example' => '1212131', ], 'Name' => [ 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'description' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', 'type' => 'string', 'example' => 'xx', ], 'Type' => [ 'title' => '授权账号类型：PERSONAL（个人账号），PRODUCE（生产账号）,USER_GROUP（用户组）', 'description' => '授权账号类型：PERSONAL（个人账号），PRODUCE（生产账号）,USER_GROUP（用户组）', 'type' => 'string', 'example' => 'PERSONAL', ], ], ], 'Period' => [ 'title' => '有效期设置', 'description' => '有效期设置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '有效期类型'."\n" .'自定义：CUSTOM；长期：LONG_TERM', 'description' => '有效期类型'."\n" .'自定义：CUSTOM；长期：LONG_TERM', 'type' => 'string', 'example' => 'CUSTOM', ], 'EndTime' => [ 'title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '1712000000000', ], ], ], 'AuthScope' => [ 'title' => '表的授权范围 制定表：selectTable 项目下所有表：projectAllTable，板块下所有逻辑表：bizUnitAllLogicTable', 'description' => '表的授权范围 制定表：selectTable 项目下所有表：projectAllTable，板块下所有逻辑表：bizUnitAllLogicTable', 'type' => 'string', 'example' => 'selectTable', ], 'PermissionPeriodList' => [ 'title' => '不同权限类型有效期列表', 'description' => '不同权限类型有效期列表', 'type' => 'array', 'items' => [ 'title' => '权限有效期', 'description' => '权限有效期', 'type' => 'object', 'properties' => [ 'PermissionType' => [ 'title' => '权限类型', 'description' => '权限类型', 'type' => 'string', 'example' => 'SELECT', ], 'Period' => [ 'title' => '有效期设置', 'description' => '有效期设置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '有效期类型'."\n" .'自定义：CUSTOM；长期：LONG_TERM', 'description' => '有效期类型'."\n" .'自定义：CUSTOM；长期：LONG_TERM', 'type' => 'string', 'example' => 'CUSTOM', ], 'EndTime' => [ 'title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '1712000000000', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 121,\\n \\"Data\\": [\\n {\\n \\"RecordId\\": \\"12123111\\",\\n \\"ResourceInfo\\": {\\n \\"Id\\": \\"a.tb1\\",\\n \\"Name\\": \\"tb1\\",\\n \\"DisplayName\\": \\"tb1\\",\\n \\"Type\\": \\"PHYSICAL_TABLE\\",\\n \\"Env\\": \\"DEV\\",\\n \\"BizUnitInfo\\": {\\n \\"Id\\": \\"121323\\",\\n \\"Name\\": \\"xx\\",\\n \\"DisplayName\\": \\"xx\\",\\n \\"Env\\": \\"DEV\\"\\n },\\n \\"ProjectInfo\\": {\\n \\"Id\\": 1123131,\\n \\"Name\\": \\"xx\\",\\n \\"DisplayName\\": \\"xx\\",\\n \\"Env\\": \\"DEV\\"\\n }\\n },\\n \\"TargetAccount\\": {\\n \\"Id\\": \\"1212131\\",\\n \\"Name\\": \\"xx\\",\\n \\"Type\\": \\"PERSONAL\\"\\n },\\n \\"Period\\": {\\n \\"Type\\": \\"CUSTOM\\",\\n \\"EndTime\\": \\"1712000000000\\"\\n },\\n \\"AuthScope\\": \\"selectTable\\",\\n \\"PermissionPeriodList\\": [\\n {\\n \\"PermissionType\\": \\"SELECT\\",\\n \\"Period\\": {\\n \\"Type\\": \\"CUSTOM\\",\\n \\"EndTime\\": \\"1712000000000\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页获取权限授权记录', ], 'GetProjectProduceUser' => [ 'summary' => '获得项目生产账号，该API仅支持超级管理员（SuperAdmin）能发起调用。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131311111321', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'User' => [ 'title' => '生产者用户', 'description' => '生产者用户', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '123131', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"User\\": {\\n \\"Id\\": \\"123131\\"\\n }\\n}","type":"json"}]', 'title' => '获得项目生产账号', ], 'GetUsers' => [ 'summary' => '根据UserId批量获取用户信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UserIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '用户Id列表', 'description' => '用户Id列表', 'type' => 'array', 'items' => [ 'description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => '132313', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'UserList' => [ 'title' => '用户列表', 'description' => '用户列表', 'type' => 'array', 'items' => [ 'title' => '用户对象', 'description' => '用户对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '1233121', ], 'ParentId' => [ 'title' => '用户归属主账号Id', 'description' => '用户归属主账号Id', 'type' => 'string', 'example' => '231231', ], 'SourceType' => [ 'title' => '用户来源', 'description' => '用户来源', 'type' => 'string', 'example' => 'ALIYUN', ], 'SourceId' => [ 'title' => '用户来源Id', 'description' => '用户来源Id', 'type' => 'string', 'example' => '123@xx.com', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], 'DisplayName' => [ 'title' => '用户显示名', 'description' => '用户显示名', 'type' => 'string', 'example' => 'xx测试', ], 'DisplayNameWithoutStatus' => [ 'title' => '用户显示名（不含状态）', 'description' => '用户显示名（不含状态）', 'type' => 'string', 'example' => 'xx测试', ], 'AccountName' => [ 'title' => '账号名', 'description' => '账号名', 'type' => 'string', 'example' => '123@xx.com', ], 'RealName' => [ 'title' => '用户真实名称', 'description' => '用户真实名称', 'type' => 'string', 'example' => 'xx测试', ], 'NickName' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'xx测试', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'MobilePhone' => [ 'title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'example' => '1388888888', ], 'Mail' => [ 'title' => '邮箱', 'description' => '邮箱', 'type' => 'string', 'example' => '123@xx.com', ], 'DingNumber' => [ 'title' => '钉钉号', 'description' => '钉钉号', 'type' => 'string', 'example' => '123@dingding', ], 'WeChatRobot' => [ 'title' => '企微机器人', 'description' => '企微机器人', 'type' => 'string', 'example' => 'xx', ], 'FeiShuRobot' => [ 'title' => '飞书机器人', 'description' => '飞书机器人', 'type' => 'string', 'example' => 'xx', ], 'EnableWhiteIp' => [ 'title' => '是否开启ip白名单', 'description' => '是否开启ip白名单', 'type' => 'string', 'example' => 'true', ], 'WhiteIp' => [ 'title' => '白名单', 'description' => '白名单', 'type' => 'string', 'example' => '*', ], 'GmtModified' => [ 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"UserList\\": [\\n {\\n \\"Id\\": \\"1233121\\",\\n \\"ParentId\\": \\"231231\\",\\n \\"SourceType\\": \\"ALIYUN\\",\\n \\"SourceId\\": \\"123@xx.com\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"DisplayName\\": \\"xx测试\\",\\n \\"DisplayNameWithoutStatus\\": \\"xx测试\\",\\n \\"AccountName\\": \\"123@xx.com\\",\\n \\"RealName\\": \\"xx测试\\",\\n \\"NickName\\": \\"xx测试\\",\\n \\"GmtCreate\\": 1717343597000,\\n \\"MobilePhone\\": \\"1388888888\\",\\n \\"Mail\\": \\"123@xx.com\\",\\n \\"DingNumber\\": \\"123@dingding\\",\\n \\"WeChatRobot\\": \\"xx\\",\\n \\"FeiShuRobot\\": \\"xx\\",\\n \\"EnableWhiteIp\\": \\"true\\",\\n \\"WhiteIp\\": \\"*\\",\\n \\"GmtModified\\": 1717343597000\\n }\\n ]\\n}","type":"json"}]', 'title' => '根据UserId获取用户详情信息', ], 'ListAddableUsers' => [ 'summary' => '查询租户可添加用户，仅限超级管理员（SuperAdmin）和系统管理员能调用。用户需添加到Dataphin实例的用户成员列表中，但尚未添加到租户成员列表中。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求对象', 'description' => '请求对象', 'type' => 'object', 'properties' => [ 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'SearchText' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'xx', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '66', ], 'UserList' => [ 'title' => '用户列表', 'description' => '用户列表', 'type' => 'array', 'items' => [ 'title' => '用户对象', 'description' => '用户对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '123231', ], 'ParentId' => [ 'title' => '用户归属主账号Id', 'description' => '用户归属主账号Id', 'type' => 'string', 'example' => '231313', ], 'SourceType' => [ 'title' => '用户来源', 'description' => '用户来源', 'type' => 'string', 'example' => 'aliyun', ], 'SourceId' => [ 'title' => '用户来源Id', 'description' => '用户来源Id', 'type' => 'string', 'example' => '123@xx.com', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx', ], 'DisplayName' => [ 'title' => '用户显示名', 'description' => '用户显示名', 'type' => 'string', 'example' => 'xx', ], 'DisplayNameWithoutStatus' => [ 'title' => '用户显示名（不含状态）', 'description' => '用户显示名（不含状态）', 'type' => 'string', 'example' => 'xx', ], 'AccountName' => [ 'title' => '账号名', 'description' => '账号名', 'type' => 'string', 'example' => '123@xx.com', ], 'RealName' => [ 'title' => '用户真实名称', 'description' => '用户真实名称', 'type' => 'string', 'example' => 'xx', ], 'NickName' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'xx', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'MobilePhone' => [ 'title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'example' => '13888888888', ], 'Mail' => [ 'title' => '邮箱', 'description' => '邮箱', 'type' => 'string', 'example' => '123@xx.com', ], 'DingNumber' => [ 'title' => '钉钉号', 'description' => '钉钉号', 'type' => 'string', 'example' => '123@dingding', ], 'WeChatRobot' => [ 'title' => '企微机器人', 'description' => '企微机器人', 'type' => 'string', 'example' => 'xx', ], 'FeiShuRobot' => [ 'title' => '飞书机器人', 'description' => '飞书机器人', 'type' => 'string', 'example' => 'xx', ], 'EnableWhiteIp' => [ 'title' => '是否开启ip白名单', 'description' => '是否开启ip白名单', 'type' => 'string', 'example' => 'true', ], 'WhiteIp' => [ 'title' => '白名单', 'description' => '白名单', 'type' => 'string', 'example' => '*', ], 'GmtModified' => [ 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 66,\\n \\"UserList\\": [\\n {\\n \\"Id\\": \\"123231\\",\\n \\"ParentId\\": \\"231313\\",\\n \\"SourceType\\": \\"aliyun\\",\\n \\"SourceId\\": \\"123@xx.com\\",\\n \\"Name\\": \\"xx\\",\\n \\"DisplayName\\": \\"xx\\",\\n \\"DisplayNameWithoutStatus\\": \\"xx\\",\\n \\"AccountName\\": \\"123@xx.com\\",\\n \\"RealName\\": \\"xx\\",\\n \\"NickName\\": \\"xx\\",\\n \\"GmtCreate\\": 1717343597000,\\n \\"MobilePhone\\": \\"13888888888\\",\\n \\"Mail\\": \\"123@xx.com\\",\\n \\"DingNumber\\": \\"123@dingding\\",\\n \\"WeChatRobot\\": \\"xx\\",\\n \\"FeiShuRobot\\": \\"xx\\",\\n \\"EnableWhiteIp\\": \\"true\\",\\n \\"WhiteIp\\": \\"*\\",\\n \\"GmtModified\\": 1717343597000\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询租户可添加用户', ], 'ListTenantMembers' => [ 'summary' => '获取租户成员列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求对象', 'description' => '请求对象', 'type' => 'object', 'properties' => [ 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'SearchText' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => '测试', ], 'UserGroupIdList' => [ 'title' => '成员归属用户组ID', 'description' => '成员归属用户组ID', 'type' => 'array', 'items' => [ 'description' => '用户组ID', 'type' => 'string', 'required' => false, 'example' => '1213111', ], 'required' => false, ], 'RoleList' => [ 'title' => '成员角色：'."\n" .'SUPER_ADMIN PROJECT_OPS PROJECT_DEVELOPER等', 'description' => '成员角色：'."\n" .'- SUPER_ADMIN：dataphin超级管理员'."\n" .'- SYSTEM_ADMIN：系统管理员'."\n" .'- COMMON_USER：dataphin用户'."\n" .'- DATA_ADMIN：dataphin数据管理员'."\n" .'- EXPORT_ADMIN：导出管理员'."\n" .'- SECURITY_ADMIN：安全管理员'."\n" .'- DATASOURCE_MANAGER：数据源管理员'."\n" .'- QUALITY_MANAGER：资产质量负责人'."\n" .'- DATA_STANDARD_MANAGER：数据标准管理员'."\n" .'- LABELS_BUSINESS_PLANNER：标签业务规划师'."\n" .'- BUSINESS_MEMBER：普通业务用户'."\n" .'- DATAPRO_OPERATE_SUPER_ADMIN：运营超级管理员'."\n" .'- DATAPRO_OPERATE_ADMIN：运营管理员'."\n" .'- DATAPRO_OPERATE_MEMBER：运营人员'."\n" .'- DATAPRO_BUSINESS_ANALYST：业务分析师'."\n" .'- LABELS_BUSINESS_MEMBER：标签业务员'."\n" .'- DATAPRO_BUSINESS_MEMBER：DATAPRO 普通业务用户', 'type' => 'array', 'items' => [ 'description' => '成员角色', 'type' => 'string', 'required' => false, 'example' => 'DATA_ADMIN', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '110', ], 'UserList' => [ 'title' => '用户列表', 'description' => '用户列表', 'type' => 'array', 'items' => [ 'title' => '用户对象', 'description' => '用户对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '132321', ], 'SourceType' => [ 'title' => '用户来源', 'description' => '用户来源', 'type' => 'string', 'example' => 'aliyun', ], 'SourceId' => [ 'title' => '用户来源Id', 'description' => '用户来源Id', 'type' => 'string', 'example' => '213213232422222', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'zhangsan', ], 'DisplayName' => [ 'title' => '用户显示名', 'description' => '用户显示名', 'type' => 'string', 'example' => 'zhangsan', ], 'DisplayNameWithoutStatus' => [ 'title' => '用户显示名（不含状态）', 'description' => '用户显示名（不含状态）', 'type' => 'string', 'example' => 'zhangsan', ], 'AccountName' => [ 'title' => '账号名', 'description' => '账号名', 'type' => 'string', 'example' => 'zhangsan', ], 'RealName' => [ 'title' => '用户真实名称', 'description' => '用户真实名称', 'type' => 'string', 'example' => '张三', ], 'NickName' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'susan', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1730000000000', ], 'MobilePhone' => [ 'title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'example' => '13888888888', ], 'Mail' => [ 'title' => '邮箱', 'description' => '邮箱', 'type' => 'string', 'example' => '123@aliyun.com', ], 'DingNumber' => [ 'title' => '钉钉号', 'description' => '钉钉号', 'type' => 'string', 'example' => 'dd123123', ], 'EnableWhiteIp' => [ 'title' => '是否开启ip白名单', 'description' => '是否开启ip白名单', 'type' => 'string', 'example' => 'true', ], 'WhiteIp' => [ 'title' => '白名单', 'description' => '白名单', 'type' => 'string', 'example' => '0.0.0.0/0', ], 'GmtModified' => [ 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1730000000000', ], 'UserGroupList' => [ 'title' => '归属资源组', 'description' => '归属资源组', 'type' => 'array', 'items' => [ 'title' => '用户组', 'description' => '资源组', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组ID', 'description' => '用户组ID', 'type' => 'string', 'example' => '121313', ], 'Name' => [ 'title' => '用户组名字', 'description' => '用户组名字', 'type' => 'string', 'example' => 'xx测试', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '测试', ], 'Active' => [ 'title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '232424', ], ], 'RoleList' => [ 'title' => '成员橘色', 'description' => '成员角色', 'type' => 'array', 'items' => [ 'description' => '角色', 'type' => 'string', 'example' => 'DATA_ADMIN', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 110,\\n \\"UserList\\": [\\n {\\n \\"Id\\": \\"132321\\",\\n \\"SourceType\\": \\"aliyun\\",\\n \\"SourceId\\": \\"213213232422222\\",\\n \\"Name\\": \\"zhangsan\\",\\n \\"DisplayName\\": \\"zhangsan\\",\\n \\"DisplayNameWithoutStatus\\": \\"zhangsan\\",\\n \\"AccountName\\": \\"zhangsan\\",\\n \\"RealName\\": \\"张三\\",\\n \\"NickName\\": \\"susan\\",\\n \\"GmtCreate\\": 1730000000000,\\n \\"MobilePhone\\": \\"13888888888\\",\\n \\"Mail\\": \\"123@aliyun.com\\",\\n \\"DingNumber\\": \\"dd123123\\",\\n \\"EnableWhiteIp\\": \\"true\\",\\n \\"WhiteIp\\": \\"0.0.0.0/0\\",\\n \\"GmtModified\\": 1730000000000,\\n \\"UserGroupList\\": [\\n {\\n \\"Id\\": \\"121313\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Description\\": \\"测试\\",\\n \\"Active\\": true\\n }\\n ],\\n \\"RoleList\\": [\\n \\"DATA_ADMIN\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取租户成员列表', ], 'GetUserGroup' => [ 'summary' => '获取用户组详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UserGroupId', 'in' => 'query', 'schema' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '1313213', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'UserGroupInfo' => [ 'title' => '用户组详情', 'description' => '用户组详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'example' => '1313213', ], 'Name' => [ 'title' => '用户组名称', 'description' => '用户组名称', 'type' => 'string', 'example' => 'xx测试', ], 'Description' => [ 'title' => '用户组描述', 'description' => '用户组描述', 'type' => 'string', 'example' => 'xx', ], 'Active' => [ 'title' => '是否启用用户组', 'description' => '是否启用用户组', 'type' => 'boolean', 'example' => 'true', ], 'AdminList' => [ 'title' => '用户组管理员', 'description' => '用户组管理员', 'type' => 'array', 'items' => [ 'description' => '用户组管理员', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '131313', ], 'DisplayName' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], 'AccountName' => [ 'title' => '用户账号名', 'description' => '用户账号名', 'type' => 'string', 'example' => 'xx', ], ], ], ], 'MyRole' => [ 'title' => '当前用户在用户组角色', 'description' => '当前用户在用户组角色', 'type' => 'string', 'example' => 'xx', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"UserGroupInfo\\": {\\n \\"Id\\": \\"1313213\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Description\\": \\"xx\\",\\n \\"Active\\": true,\\n \\"AdminList\\": [\\n {\\n \\"Id\\": \\"131313\\",\\n \\"DisplayName\\": \\"xx测试\\",\\n \\"AccountName\\": \\"xx\\"\\n }\\n ],\\n \\"MyRole\\": \\"xx\\"\\n }\\n}","type":"json"}]', 'title' => '获取用户组详情', ], 'ListAddableRoles' => [ 'summary' => '获取可配置到租户成员的全局角色。仅限内置的全局角色，不支持自定义全局角色。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'RoleList' => [ 'title' => '角色列表', 'description' => '角色列表', 'type' => 'array', 'items' => [ 'title' => '角色', 'description' => '角色', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '角色编码', 'description' => '角色编码', 'type' => 'string', 'example' => 'SECURITY_ADMIN', ], 'Name' => [ 'title' => '角色名称', 'description' => '角色名称', 'type' => 'string', 'example' => '安全管理员', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"RoleList\\": [\\n {\\n \\"Code\\": \\"SECURITY_ADMIN\\",\\n \\"Name\\": \\"安全管理员\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取可配置用户的全局角色', ], 'ListUserGroups' => [ 'summary' => '用户组列表分页查询。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询', 'description' => '分页查询', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '用户组名称关键字', 'description' => '用户组名称关键字', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Active' => [ 'title' => '是否启用用户组', 'description' => '是否启用用户组', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'AdminIdList' => [ 'title' => '用户组管理员用户Id', 'description' => '用户组管理员用户Id', 'type' => 'array', 'items' => [ 'title' => '用户组管理员用户Id', 'description' => '用户组管理员用户Id', 'type' => 'string', 'required' => false, 'example' => '131311', ], 'required' => false, ], 'FilterMine' => [ 'title' => '是否过滤当前用户所在用户组', 'description' => '是否过滤当前用户所在用户组', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'PageNo' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '49', ], 'UserGroupList' => [ 'title' => '分页列表', 'description' => '分页列表', 'type' => 'array', 'items' => [ 'title' => '用户组', 'description' => '用户组', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'example' => '31313232', ], 'Name' => [ 'title' => '用户组名称', 'description' => '用户组名称', 'type' => 'string', 'example' => 'xx测试', ], 'Description' => [ 'title' => '用户组描述', 'description' => '用户组描述', 'type' => 'string', 'example' => 'xx 测试', ], 'Active' => [ 'title' => '是否启用用户组', 'description' => '是否启用用户组', 'type' => 'boolean', 'example' => 'true', ], 'AdminList' => [ 'title' => '用户组管理员', 'description' => '用户组管理员', 'type' => 'array', 'items' => [ 'description' => '用户组管理员', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '32313131', ], 'DisplayName' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => '张三', ], 'AccountName' => [ 'title' => '用户账号名', 'description' => '用户账号名', 'type' => 'string', 'example' => 'zhangsan', ], ], ], ], 'MyRole' => [ 'title' => '当前用户在用户组角色', 'description' => '当前用户在用户组角色', 'type' => 'string', 'example' => 'SECURITY_ADMIN', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 49,\\n \\"UserGroupList\\": [\\n {\\n \\"Id\\": \\"31313232\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Description\\": \\"xx 测试\\",\\n \\"Active\\": true,\\n \\"AdminList\\": [\\n {\\n \\"Id\\": \\"32313131\\",\\n \\"DisplayName\\": \\"张三\\",\\n \\"AccountName\\": \\"zhangsan\\"\\n }\\n ],\\n \\"MyRole\\": \\"SECURITY_ADMIN\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '用户组列表分页查询', ], 'GetMyTenants' => [ 'summary' => '获取当前用户归属租户。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'FeatureCodeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '租户拥有售卖Code', 'description' => '租户拥有售卖Code', 'type' => 'array', 'items' => [ 'title' => '售卖Code', 'description' => '售卖Code', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_STREAM', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'TenantList' => [ 'title' => '租户列表', 'description' => '租户列表', 'type' => 'array', 'items' => [ 'title' => '租户详情', 'description' => '租户详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '租户Id', 'description' => '租户Id', 'type' => 'integer', 'format' => 'int64', 'example' => '132311', ], 'Name' => [ 'title' => '租户名', 'description' => '租户名', 'type' => 'string', 'example' => 'xx测试', ], 'OwnerId' => [ 'title' => '租户归属用户Id', 'description' => '租户归属用户Id', 'type' => 'string', 'example' => '21323231', ], 'Description' => [ 'title' => '租户描述', 'description' => '租户描述', 'type' => 'string', 'example' => 'xx 测试', ], 'Deleted' => [ 'title' => '是否被删除标识', 'description' => '是否被删除标识', 'type' => 'boolean', 'example' => 'false', ], 'DeleteTime' => [ 'title' => '删除时间', 'description' => '删除时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'TitleType' => [ 'title' => '租户标题类型', 'description' => '租户标题类型', 'type' => 'string', 'example' => 'icon', ], 'OpsTenant' => [ 'title' => '是否运维租户', 'description' => '是否运维租户', 'type' => 'boolean', 'example' => 'false', ], 'ResourceLimited' => [ 'title' => '是否进行资源限额的计算', 'description' => '是否进行资源限额的计算', 'type' => 'boolean', 'example' => 'false', ], 'Visible' => [ 'title' => '是否可以展示', 'description' => '是否可以展示', 'type' => 'boolean', 'example' => 'true', ], 'TenantTypeList' => [ 'title' => '租户类型', 'description' => '租户类型', 'type' => 'array', 'items' => [ 'title' => '租户类型', 'description' => '租户类型', 'type' => 'string', 'example' => 'application', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TenantList\\": [\\n {\\n \\"Id\\": 132311,\\n \\"Name\\": \\"xx测试\\",\\n \\"OwnerId\\": \\"21323231\\",\\n \\"Description\\": \\"xx 测试\\",\\n \\"Deleted\\": false,\\n \\"DeleteTime\\": 1717343597000,\\n \\"TitleType\\": \\"icon\\",\\n \\"OpsTenant\\": false,\\n \\"ResourceLimited\\": false,\\n \\"Visible\\": true,\\n \\"TenantTypeList\\": [\\n \\"application\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取当前用户归属租户', ], 'GetMyRoles' => [ 'summary' => '获取用户角色列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'RoleList' => [ 'description' => '角色列表', 'type' => 'array', 'items' => [ 'description' => '角色', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '角色Id', 'description' => '角色Id', 'type' => 'integer', 'format' => 'int64', 'example' => '300047957', ], 'Name' => [ 'title' => '角色名称', 'description' => '角色名称', 'type' => 'string', 'example' => 'dataphinAdmin', ], 'Description' => [ 'title' => '角色描述', 'description' => '角色描述', 'type' => 'string', 'example' => 'dataphin管理员', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"RoleList\\": [\\n {\\n \\"Id\\": 300047957,\\n \\"Name\\": \\"dataphinAdmin\\",\\n \\"Description\\": \\"dataphin管理员\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取当前用户角色列表', ], 'ListUserGroupMembers' => [ 'summary' => '用户组成员分页查询。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询', 'description' => '分页查询', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '用户名关键字', 'description' => '用户名关键字', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'UserGroupId' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => false, 'example' => '232231', ], 'UserIdList' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'array', 'items' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => false, 'example' => '2231111', ], 'required' => false, ], 'PageNo' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '217', ], 'MemberList' => [ 'title' => '分页列表', 'description' => '分页列表', 'type' => 'array', 'items' => [ 'description' => '用户组成员', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组成员Id', 'description' => '用户组成员Id', 'type' => 'string', 'example' => '2324211', ], 'UserGroupId' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'example' => '231111', ], 'UserInfo' => [ 'title' => '用户组成员', 'description' => '用户组成员', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '13232', ], 'DisplayName' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], 'AccountName' => [ 'title' => '用户账号名', 'description' => '用户账号名', 'type' => 'string', 'example' => 'atest', ], ], ], 'UserRole' => [ 'title' => '用户组成员在用户组角色', 'description' => '用户组成员在用户组角色', 'type' => 'string', 'example' => 'SECURITY_ADMIN', ], 'Creator' => [ 'title' => '添加人', 'description' => '添加人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '12121111', ], 'DisplayName' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'zhangsan', ], 'AccountName' => [ 'title' => '用户账号名', 'description' => '用户账号名', 'type' => 'string', 'example' => '12121111', ], ], ], 'GmtCreate' => [ 'title' => '用户组成员添加时间', 'description' => '用户组成员添加时间', 'type' => 'integer', 'format' => 'int64', 'example' => 'zhangsan', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 217,\\n \\"MemberList\\": [\\n {\\n \\"Id\\": \\"2324211\\",\\n \\"UserGroupId\\": \\"231111\\",\\n \\"UserInfo\\": {\\n \\"Id\\": \\"13232\\",\\n \\"DisplayName\\": \\"xx测试\\",\\n \\"AccountName\\": \\"atest\\"\\n },\\n \\"UserRole\\": \\"SECURITY_ADMIN\\",\\n \\"Creator\\": {\\n \\"Id\\": \\"12121111\\",\\n \\"DisplayName\\": \\"zhangsan\\",\\n \\"AccountName\\": \\"12121111\\"\\n },\\n \\"GmtCreate\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '用户组成员分页查询', ], 'GetUserBySourceId' => [ 'summary' => '通过原始用户ID获取用户详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => [ 'title' => '用户来源Id', 'description' => '用户来源Id', 'type' => 'string', 'required' => true, 'example' => '323131', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'User' => [ 'title' => '用户对象', 'description' => '用户对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '23231231', ], 'DisplayName' => [ 'title' => '用户显示名', 'description' => '用户显示名', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"User\\": {\\n \\"Id\\": \\"23231231\\",\\n \\"DisplayName\\": \\"xx测试\\"\\n }\\n}","type":"json"}]', 'title' => '通过原始用户ID获取用户详情', ], 'GrantResourcePermission' => [ 'summary' => '通过资源点对用户授权。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'GrantCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '授权请求', 'description' => '授权请求', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'PHYSICAL_TABLE', 'enum' => [], ], 'OperateList' => [ 'title' => '操作类型', 'description' => '操作类型', 'type' => 'array', 'items' => [ 'description' => '操作类型', 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], 'required' => true, ], 'Reason' => [ 'title' => '授权原因', 'description' => '授权原因', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'ResourceList' => [ 'title' => '资源列表', 'description' => '资源列表', 'type' => 'array', 'items' => [ 'title' => '资源对象', 'description' => '资源对象', 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'title' => '资源Id', 'description' => '资源Id', 'type' => 'string', 'required' => false, 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01', ], ], 'required' => false, ], 'required' => true, ], 'EffectiveEnd' => [ 'title' => '有效期，', 'description' => '有效期时间戳, 毫秒', 'type' => 'string', 'required' => true, 'example' => '1717343597000', ], 'UserIdList' => [ 'title' => '待授权用户', 'description' => '待授权用户', 'type' => 'array', 'items' => [ 'title' => '待授权用户', 'description' => '待授权用户', 'type' => 'string', 'required' => false, 'example' => '23244434', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '授权用户资源的权限', ], 'RevokeResourcePermission' => [ 'summary' => '回收用户资源授权。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RevokeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '授权回收请求', 'description' => '授权回收请求', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'PHYSICAL_TABLE', ], 'ResourceList' => [ 'title' => '资源列表', 'description' => '资源列表', 'type' => 'array', 'items' => [ 'description' => '资源', 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'odps.300002102.beginner_test.amin_table', ], ], 'required' => false, ], 'required' => true, ], 'OperateList' => [ 'title' => '操作列表', 'description' => '操作列表', 'type' => 'array', 'items' => [ 'description' => '操作', 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], 'required' => false, ], 'Reason' => [ 'title' => '回收原因', 'description' => '回收原因', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '13131', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '回收用户资源授权', ], 'CheckResourcePermission' => [ 'summary' => '校验用户是否有指定资源权限点。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CheckCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '校验用户资源点权限', 'description' => '校验用户资源点权限', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '323231', ], 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型'."\n" .'- PHYSICAL_TABLE：物理表'."\n" .'- PHYSICAL_FIELD：物理表字段'."\n" .'- LOGICAL_TABLE：事实逻辑表'."\n" .'- LOGICAL_FIELD：事实逻辑表字段'."\n" .'- LABEL_TABLE：标签逻辑表'."\n" .'- LABEL_FIELD：标签逻辑表字段'."\n" .'- DATASOURCE：数据源'."\n" .'- GLOBAL_PARAM：全局参数'."\n" .'- REALTIME_LOGICAL_TABLE：实时元表'."\n" .'- REALTIME_LOGICAL_FIELD：实时元表字段'."\n" .'- REALTIME_MIRROR_TABLE：镜像表'."\n" .'- REALTIME_MIRROR_FIELD：实时镜像表字段'."\n" .'- FUNCTION：函数'."\n" .'- FEATURE：功能权限'."\n" .'- PHYSICAL_VIEW：物理视图'."\n" .'- LOGICAL_VIEW：逻辑视图'."\n" .'- QD_SERVICE_FEATURE：服务标签'."\n" .'- QD_ADVANCED_FEATURE：高级标签'."\n" .'- QD_CLUSTER：群组'."\n" .'- QD_EVENT：事件'."\n" .'- QD_OFFLINE_SERVICE：标签离线服务任务'."\n" .'- PHYSICAL_MATERIALIZED_VIEW：物化视图', 'type' => 'string', 'required' => true, 'example' => 'PHYSICAL_TABLE', ], 'ResourceList' => [ 'title' => '权限资源列表', 'description' => '权限资源列表', 'type' => 'array', 'items' => [ 'title' => '权限资源', 'description' => '权限资源', 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'title' => '资源Id', 'description' => '资源Id', 'type' => 'string', 'required' => true, 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01', ], ], 'required' => false, ], 'required' => true, ], 'Operate' => [ 'title' => '操作类型', 'description' => '操作类型', 'type' => 'string', 'required' => true, 'example' => 'UPDATE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ResourcePermissionList' => [ 'title' => '资源权限列表', 'description' => '资源权限列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'title' => '资源Id', 'description' => '资源Id', 'type' => 'string', 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01'."\n", ], 'HasPermission' => [ 'title' => '是否有指定资源点权限', 'description' => '是否有指定资源点权限', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ResourcePermissionList\\": [\\n {\\n \\"ResourceId\\": \\"hadoop.300000806.data_distill.behavior_gameinfor_01\\\\n\\",\\n \\"HasPermission\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '校验用户是否有指定资源权限点', ], 'RemoveTenantMember' => [ 'summary' => '移除租户成员，该API仅支持超级管理员和系统管理员能发起调用。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'SourceId' => [ 'title' => '用户来源Id', 'description' => '用户来源Id', 'type' => 'string', 'required' => true, 'example' => '123@xx.com', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '移除租户成员', ], 'RemoveUserGroupMember' => [ 'summary' => '移除用户组成员。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '移除用户组成员', 'description' => '移除用户组成员', 'type' => 'object', 'properties' => [ 'UserGroupId' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'required' => true, 'example' => '2311', ], 'UserIdList' => [ 'title' => '用户Id列表', 'description' => '用户Id列表', 'type' => 'array', 'items' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '131313', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '移除用户组成员结果', 'description' => '移除用户组成员结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '移除用户组成员', ], 'DeleteRowPermission' => [ 'summary' => '删除行级权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'RowPermissionId' => [ 'title' => '行级权限ID', 'description' => '行级权限ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001234', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '操作结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '删除行级权限', ], 'GetAccountByRowPermissionId' => [ 'summary' => '根据行级权限ID获取某一行级权限下的所有授权账号。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'GetAccountByRowPermissionIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'RowPermissionId' => [ 'title' => '行级权限ID', 'description' => '行级权限ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001234', ], 'RuleIds' => [ 'description' => '行级权限规则ID', 'type' => 'array', 'items' => [ 'description' => '行级权限规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001235', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '查询结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '行级权限规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '300001235', ], 'UserMappingList' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountType' => [ 'title' => '规则绑定账号类型', 'description' => '规则绑定账号类型', 'type' => 'string', 'enumValueTitles' => [ 'PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE', ], 'example' => 'PERSONAL', ], 'Accounts' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '规则绑定账号ID', 'description' => '规则绑定账号ID', 'type' => 'string', 'example' => '300901111', ], 'AccountName' => [ 'title' => '规则绑定账号名称', 'description' => '规则绑定账号名称', 'type' => 'string', 'example' => '张三', ], ], ], 'enum' => [ 'PERSONAL', 'PRODUCE', 'USER_GROUP', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 300001235,\\n \\"UserMappingList\\": [\\n {\\n \\"AccountType\\": \\"PERSONAL\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountId\\": \\"300901111\\",\\n \\"AccountName\\": \\"张三\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '根据行级权限ID获取某一行级权限下的所有授权账号', 'extraInfo' => '接口上线版本：v5.1.0', ], 'ListRowPermission' => [ 'summary' => '分页查询行级权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PageRowPermissionQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => '业务', ], 'PageNum' => [ 'title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'description' => '分页条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Data' => [ 'description' => '查询结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RowPermissionId' => [ 'title' => '行级权限ID', 'description' => '行级权限ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30008888', ], 'RowPermissionDesc' => [ 'title' => '行级权限描述', 'description' => '行级权限描述', 'type' => 'string', 'example' => '管控业务数据', ], 'RowPermissionName' => [ 'title' => '行级权限名称', 'description' => '行级权限名称', 'type' => 'string', 'example' => '业务管控', ], 'MappingColumns' => [ 'title' => '映射字段', 'description' => '映射字段', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'example' => 'business_id', ], 'ColumnType' => [ 'title' => '映射字段类型', 'description' => '映射字段类型', 'type' => 'string', 'example' => 'string', 'enum' => [ 'STRING', 'NUMBER', ], ], 'ColumnDesc' => [ 'title' => '映射字段描述', 'description' => '映射字段描述', 'type' => 'string', 'example' => '业务ID', ], ], ], ], 'Rules' => [ 'title' => '规则', 'description' => '规则', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'example' => '管控ID 100以内数据', ], 'ScopeType' => [ 'title' => '规则范围类型', 'description' => '规则范围类型', 'type' => 'string', 'example' => 'SELECT_COLUMN', 'enum' => [ 'ALL_COLUMN', 'SELECT_COLUMN', ], ], 'IsDelete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'enum' => [ '0', '1', ], ], 'Status' => [ 'title' => '规则状态', 'description' => '规则状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0', '1', ], ], 'Expressions' => [ 'title' => '规则表达式', 'description' => '规则表达式', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'example' => 'business_id', ], 'Values' => [ 'title' => '表达式操作值', 'description' => '表达式操作值', 'type' => 'array', 'items' => [ 'description' => '表达式操作值', 'type' => 'string', 'example' => '123', ], ], 'Type' => [ 'title' => '表达式类型', 'description' => '表达式类型', 'type' => 'string', 'example' => 'EXPRESSION', 'enum' => [ 'EXPRESSION', 'RELATION', ], ], 'SubConditions' => [ 'title' => '子表达式', 'description' => '子表达式', 'type' => 'array', 'items' => [ 'description' => '子表达式，同Expressions', 'type' => 'any', 'example' => '同Expressions', ], ], 'Operator' => [ 'title' => '表达式操作符号', 'description' => '表达式操作符号', 'type' => 'string', 'example' => '30008888', 'enum' => [ 'EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND', ], ], ], ], ], 'UserMappingList' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountType' => [ 'title' => '规则绑定账号类型', 'description' => '规则绑定账号类型', 'type' => 'string', 'example' => 'PERSONAL', ], 'Accounts' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '规则绑定账号ID', 'description' => '规则绑定账号ID', 'type' => 'string', 'example' => '30008888', ], ], ], 'enum' => [ 'PERSONAL', 'PRODUCE', 'USER_GROUP', ], ], ], ], ], ], ], ], 'Tables' => [ 'title' => '相关表', 'description' => '相关表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'example' => 'business_id', ], 'ResourceId' => [ 'title' => '表GUID', 'description' => '表GUID', 'type' => 'string', 'example' => 'odps.300199897.project_name.table_name', ], 'ColumnName' => [ 'title' => '表字段', 'description' => '表字段', 'type' => 'string', 'example' => 'business_id', ], ], ], ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2023-08-23T08:01:44Z', ], 'GmtModified' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '2025-02-12T02:16:45Z', ], 'Creator' => [ 'description' => '创建者', 'type' => 'string', 'example' => '30008888', ], 'Modifier' => [ 'description' => '修改者', 'type' => 'string', 'example' => '30008888', ], 'TenantId' => [ 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 10,\\n \\"Data\\": [\\n {\\n \\"RowPermissionId\\": 30008888,\\n \\"RowPermissionDesc\\": \\"管控业务数据\\",\\n \\"RowPermissionName\\": \\"业务管控\\",\\n \\"MappingColumns\\": [\\n {\\n \\"ColumnName\\": \\"business_id\\",\\n \\"ColumnType\\": \\"string\\",\\n \\"ColumnDesc\\": \\"业务ID\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"RuleName\\": \\"管控ID 100以内数据\\",\\n \\"ScopeType\\": \\"SELECT_COLUMN\\",\\n \\"IsDelete\\": true,\\n \\"Status\\": 1,\\n \\"Expressions\\": [\\n {\\n \\"MappingColumnName\\": \\"business_id\\",\\n \\"Values\\": [\\n \\"123\\"\\n ],\\n \\"Type\\": \\"EXPRESSION\\",\\n \\"SubConditions\\": [\\n \\"同Expressions\\"\\n ],\\n \\"Operator\\": \\"30008888\\"\\n }\\n ],\\n \\"UserMappingList\\": [\\n {\\n \\"AccountType\\": \\"PERSONAL\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountId\\": \\"30008888\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"MappingColumnName\\": \\"business_id\\",\\n \\"ResourceId\\": \\"odps.300199897.project_name.table_name\\",\\n \\"ColumnName\\": \\"business_id\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"2023-08-23T08:01:44Z\\",\\n \\"GmtModified\\": \\"2025-02-12T02:16:45Z\\",\\n \\"Creator\\": \\"30008888\\",\\n \\"Modifier\\": \\"30008888\\",\\n \\"TenantId\\": 30000001\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询行级权限', 'extraInfo' => '接口上线版本：v5.1.0', ], 'ListRowPermissionByUserId' => [ 'summary' => '分页查询指定用户行级权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListRowPermissionByUserIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'Operator' => [ 'title' => '指定操作人', 'description' => '指定操作人', 'type' => 'string', 'required' => true, 'example' => '30008888', ], 'PageNum' => [ 'title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '121', ], 'Data' => [ 'description' => '查询结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Rules' => [ 'title' => '规则', 'description' => '规则', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'example' => '业务管控', ], 'ScopeType' => [ 'title' => '规则范围类型', 'description' => '规则范围类型', 'type' => 'string', 'example' => 'SELECT_COLUMN', 'enum' => [ 'ALL_COLUMN', 'SELECT_COLUMN', ], ], 'IsDelete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'example' => '0', 'enum' => [ '0', '1', ], ], 'Status' => [ 'title' => '规则状态', 'description' => '规则状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0', '1', ], ], 'Expressions' => [ 'title' => '规则表达式', 'description' => '规则表达式', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'example' => 'business_id', ], 'Values' => [ 'title' => '表达式操作值', 'description' => '表达式操作值', 'type' => 'array', 'items' => [ 'description' => '表达式操作值', 'type' => 'string', 'example' => '123', ], ], 'Type' => [ 'title' => '表达式类型', 'description' => '表达式类型', 'type' => 'string', 'example' => 'EXPRESSION', 'enum' => [ 'EXPRESSION', 'RELATION', ], ], 'SubConditions' => [ 'title' => '子表达式', 'description' => '子表达式', 'type' => 'array', 'items' => [ 'description' => '子表达式，同Expressions', 'type' => 'any', 'example' => '同Expressions', ], ], 'Operator' => [ 'title' => '表达式操作符号', 'description' => '表达式操作符号', 'type' => 'string', 'example' => 'EQUAL', 'enum' => [ 'EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND', ], ], ], ], ], 'UserMappingList' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountType' => [ 'title' => '规则绑定账号类型', 'description' => '规则绑定账号类型', 'type' => 'string', 'example' => 'PERSONAL', ], 'Accounts' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '规则绑定账号ID', 'description' => '规则绑定账号ID', 'type' => 'string', 'example' => '30008888', ], ], ], 'enum' => [ 'PERSONAL', 'PRODUCE', 'USER_GROUP', ], ], ], ], ], ], ], ], 'Tables' => [ 'title' => '相关表', 'description' => '相关表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'example' => '拦截规则', ], 'ResourceId' => [ 'title' => '表GUID', 'description' => '表GUID', 'type' => 'string', 'example' => 'odps.300199897.project_name.table_name', ], 'ColumnName' => [ 'title' => '表字段', 'description' => '表字段', 'type' => 'string', 'example' => 'business_id', ], ], ], ], 'GmtCreate' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '2023-03-30T21:37:23Z', ], 'GmtModified' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '2025-03-03T10:14Z', ], 'Creator' => [ 'description' => '创建者', 'type' => 'string', 'example' => '30008888', ], 'Modifier' => [ 'description' => '修改者', 'type' => 'string', 'example' => '30008888', ], 'TenantId' => [ 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 121,\\n \\"Data\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"RuleName\\": \\"业务管控\\",\\n \\"ScopeType\\": \\"SELECT_COLUMN\\",\\n \\"IsDelete\\": true,\\n \\"Status\\": 1,\\n \\"Expressions\\": [\\n {\\n \\"MappingColumnName\\": \\"business_id\\",\\n \\"Values\\": [\\n \\"123\\"\\n ],\\n \\"Type\\": \\"EXPRESSION\\",\\n \\"SubConditions\\": [\\n \\"同Expressions\\"\\n ],\\n \\"Operator\\": \\"EQUAL\\"\\n }\\n ],\\n \\"UserMappingList\\": [\\n {\\n \\"AccountType\\": \\"PERSONAL\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountId\\": \\"30008888\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"MappingColumnName\\": \\"拦截规则\\",\\n \\"ResourceId\\": \\"odps.300199897.project_name.table_name\\",\\n \\"ColumnName\\": \\"business_id\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"2023-03-30T21:37:23Z\\",\\n \\"GmtModified\\": \\"2025-03-03T10:14Z\\",\\n \\"Creator\\": \\"30008888\\",\\n \\"Modifier\\": \\"30008888\\",\\n \\"TenantId\\": 30000001\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询指定用户行级权限', 'extraInfo' => '接口上线版本：v5.1.0', ], 'UpdateRowPermission' => [ 'summary' => '更新行级权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'RowPermissionId' => [ 'title' => '行级权限ID', 'description' => '行级权限ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30009999', ], 'RowPermissionName' => [ 'title' => '行级权限名称', 'description' => '行级权限名称', 'type' => 'string', 'required' => true, 'example' => '业务管控', ], 'RowPermissionDesc' => [ 'title' => '行级权限描述', 'description' => '行级权限描述', 'type' => 'string', 'required' => false, 'example' => '管控业务数据', ], 'MappingColumns' => [ 'title' => '映射字段', 'description' => '映射字段', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], 'ColumnType' => [ 'title' => '映射字段类型', 'description' => '映射字段类型', 'type' => 'string', 'required' => true, 'example' => 'STRING', 'enum' => [ 'STRING', 'NUMBER', ], ], 'ColumnDesc' => [ 'title' => '映射字段描述', 'description' => '映射字段描述', 'type' => 'string', 'required' => false, 'example' => '业务ID', ], ], 'required' => true, ], 'required' => true, ], 'Rules' => [ 'title' => '规则', 'description' => '规则', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'required' => true, 'example' => '管控业务ID大于100', ], 'ScopeType' => [ 'title' => '规则范围类型', 'description' => '规则范围类型', 'type' => 'string', 'required' => true, 'example' => 'SELECT_COLUMN', 'enum' => [ 'ALL_COLUMN', 'SELECT_COLUMN', ], ], 'IsDelete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', ], ], 'Status' => [ 'title' => '规则状态', 'description' => '规则状态', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enum' => [ '0', '1', ], ], 'Expressions' => [ 'title' => '规则表达式', 'description' => '规则表达式', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], 'Values' => [ 'title' => '表达式操作值', 'description' => '表达式操作值', 'type' => 'array', 'items' => [ 'description' => '表达式操作值', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, ], 'Type' => [ 'title' => '表达式类型', 'description' => '表达式类型', 'type' => 'string', 'required' => true, 'example' => 'EXPRESSION', 'enum' => [ 'EXPRESSION', 'RELATION', ], ], 'SubConditions' => [ 'title' => '子表达式', 'description' => '子表达式', 'type' => 'array', 'items' => [ 'description' => '子表达式，同Expressions', 'type' => 'any', 'required' => true, 'example' => '同Expressions', ], 'required' => true, ], 'Operator' => [ 'title' => '表达式操作符号', 'description' => '表达式操作符号', 'type' => 'string', 'required' => true, 'example' => 'OR', 'enum' => [ 'EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND', ], ], ], 'required' => true, ], 'required' => true, ], 'UserMappingList' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountType' => [ 'title' => '规则绑定账号类型', 'description' => '规则绑定账号类型', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE', ], 'example' => 'PERSONAL', ], 'Accounts' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '规则绑定账号ID', 'description' => '规则绑定账号ID', 'type' => 'string', 'required' => true, 'example' => '30001011', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], 'required' => false, ], ], 'required' => true, ], 'required' => false, ], 'Tables' => [ 'title' => '相关表', 'description' => '相关表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], 'ResourceId' => [ 'title' => '表GUID', 'description' => '表GUID', 'type' => 'string', 'required' => true, 'example' => 'odps.300199897.project_name.table_name'."\n", ], 'ColumnName' => [ 'title' => '表字段', 'description' => '表字段', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], ], 'required' => true, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '更新结果', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '更新行级权限', 'extraInfo' => '接口上线版本：v5.1.0', ], 'CreateRowPermission' => [ 'summary' => '创建行级权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求命令', 'description' => '请求命令', 'type' => 'object', 'properties' => [ 'RowPermissionName' => [ 'title' => '行级权限名称', 'description' => '行级权限名称', 'type' => 'string', 'required' => true, 'example' => '业务管控', ], 'RowPermissionDesc' => [ 'title' => '行级权限描述', 'description' => '行级权限描述', 'type' => 'string', 'required' => false, 'example' => '管控业务数据', ], 'MappingColumns' => [ 'title' => '映射字段', 'description' => '映射字段', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], 'ColumnType' => [ 'title' => '映射字段类型', 'description' => '映射字段类型', 'type' => 'string', 'required' => true, 'example' => 'STRING', 'enum' => [ 'STRING', 'NUMBER', ], ], 'ColumnDesc' => [ 'title' => '映射字段描述', 'description' => '映射字段描述', 'type' => 'string', 'required' => false, 'example' => '控制业务ID字段', ], ], 'required' => true, ], 'required' => true, ], 'Rules' => [ 'title' => '规则', 'description' => '规则', 'type' => 'array', 'items' => [ 'description' => '规则对象', 'type' => 'object', 'properties' => [ 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'required' => true, 'example' => '中台', ], 'ScopeType' => [ 'title' => '规则范围类型', 'description' => '规则范围类型', 'type' => 'string', 'required' => true, 'example' => 'SELECT_COLUMN', 'enum' => [ 'ALL_COLUMN', 'SELECT_COLUMN', ], ], 'IsDelete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'required' => false, 'example' => '1', 'enum' => [ '0', '1', ], ], 'Status' => [ 'title' => '规则状态', 'description' => '规则状态', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enum' => [ '0', '1', ], ], 'Expressions' => [ 'title' => '规则表达式', 'description' => '规则表达式', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'id', ], 'Values' => [ 'title' => '表达式操作值', 'description' => '表达式操作值', 'type' => 'array', 'items' => [ 'description' => '表达式操作值', 'type' => 'string', 'required' => true, 'example' => '123', ], 'required' => true, ], 'Type' => [ 'title' => '表达式类型', 'description' => '表达式类型', 'type' => 'string', 'required' => true, 'example' => 'RELATION', 'enum' => [ 'EXPRESSION', 'RELATION', ], ], 'SubConditions' => [ 'title' => '子表达式', 'description' => '子表达式', 'type' => 'array', 'items' => [ 'description' => '子表达式，结构同Expressions', 'type' => 'any', 'required' => true, 'example' => '子表达式，结构同Expressions', ], 'required' => true, ], 'Operator' => [ 'title' => '表达式操作符号', 'description' => '表达式操作符号', 'type' => 'string', 'required' => true, 'example' => 'EQUAL', 'enum' => [ 'EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND', ], ], ], 'required' => true, ], 'required' => true, ], 'UserMappingList' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountType' => [ 'title' => '规则绑定账号类型', 'description' => '规则绑定账号类型', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE', ], 'example' => 'PERSONAL', ], 'Accounts' => [ 'title' => '规则绑定账号', 'description' => '规则绑定账号', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '规则绑定账号ID', 'description' => '规则绑定账号ID', 'type' => 'string', 'required' => true, 'example' => '300001111', ], ], 'required' => true, ], 'required' => true, 'example' => 'PERSONAL', 'enum' => [ 'PERSONAL', 'PRODUCE', 'USER_GROUP', ], ], ], 'required' => true, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'Tables' => [ 'title' => '相关表', 'description' => '相关表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MappingColumnName' => [ 'title' => '映射字段名称', 'description' => '映射字段名称', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], 'ResourceId' => [ 'title' => '表GUID', 'description' => '表GUID', 'type' => 'string', 'required' => true, 'example' => 'odps.300199897.project_name.table_name', ], 'ColumnName' => [ 'title' => '表字段', 'description' => '表字段', 'type' => 'string', 'required' => true, 'example' => 'business_id', ], ], 'required' => true, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '创建结果', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 0\\n}","type":"json"}]', 'title' => '创建行级权限', 'description' => '可以根据appKey查询已发布接口的详细信息', 'extraInfo' => '接口上线版本：v5.1.0', ], 'CreateDirectory' => [ 'summary' => '创建菜单树目录，支持计算任务、数据集成、同步任务等功能。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1212344', ], 'Category' => [ 'title' => '菜单树类目'."\n" .'即席查询：tempCode'."\n" .'代码任务：codeManage'."\n" .'离线管道：offlinePipeline'."\n" .'管道自定义组件：offlinePipelineCustomPlugin'."\n" .'同步任务：dataX'."\n" .'实时元表：streamMeta'."\n" .'实时自定义源：streamCustomDataSource'."\n" .'实时计算模板：streamTemplate'."\n" .'资源管理：resourceManage'."\n" .'离线函数：udfResource'."\n" .'实时函数：streamFunction', 'description' => '菜单树类目'."\n" .'- 即席查询：tempCode'."\n" .'- 代码任务：codeManage'."\n" .'- 离线管道：offlinePipeline'."\n" .'- 管道自定义组件：offlinePipelineCustomPlugin'."\n" .'- 同步任务：dataX'."\n" .'- 实时元表：streamMeta'."\n" .'- 实时自定义源：streamCustomDataSource'."\n" .'- 实时计算模板：streamTemplate'."\n" .'- 资源管理：resourceManage'."\n" .'- 离线函数：udfResource'."\n" .'- 实时函数：streamFunction', 'type' => 'string', 'required' => true, 'example' => 'tempCode', ], 'Name' => [ 'title' => '新建文件目录名称', 'description' => '新建文件目录名称', 'type' => 'string', 'required' => true, 'example' => 'test_xx', ], 'Directory' => [ 'title' => '新建文件目录父目录', 'description' => '新建文件目录父目录', 'type' => 'string', 'required' => true, 'example' => '/', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'FileId' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1311113211', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FileId\\": 1311113211\\n}","type":"json"}]', 'title' => '创建菜单树目录', ], 'DeleteDirectory' => [ 'summary' => '删除菜单树文件目录。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除菜单树文件目录', ], 'UpdateFileName' => [ 'summary' => '更新文件名。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '更改后文件名', 'description' => '更改后文件名', 'type' => 'string', 'required' => true, 'example' => 'xxNew', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '更新文件名', ], 'UpdateFileDirectory' => [ 'summary' => '移动菜单树文件位置。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111', ], ], [ 'name' => 'Directory', 'in' => 'query', 'schema' => [ 'title' => '更改后文件目录', 'description' => '更改后文件目录', 'type' => 'string', 'required' => true, 'example' => '/xx测试/目录new', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '移动菜单树文件位置', ], 'GetDirectoryTree' => [ 'summary' => '获取文件夹目录树。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [ 'Dataphin公共云', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'title' => '目录名称；'."\n" ."\n" .'部分根目录枚举值如下：实时计算表：streamMeta；离线物理表：PhysicalTable；计算任务：codeManage；实时计算模板：streamTemplate；离线计算模板：batchTaskTemplate；资源：resourceManage；FLINK函数：streamFunction；MAXC函数：udfResource；', 'description' => '目录类型；'."\n" .'- 即席查询：tempCode'."\n" .'- 代码任务：codeManage'."\n" .'- 离线管道：offlinePipeline'."\n" .'- 管道自定义组件：offlinePipelineCustomPlugin'."\n" .'- 同步任务：dataX'."\n" .'- 实时元表：streamMeta'."\n" .'- 实时自定义源：streamCustomDataSource'."\n" .'- 实时计算模板：streamTemplate'."\n" .'- 资源管理：resourceManage'."\n" .'- 离线函数：udfResource'."\n" .'- 实时函数：streamFunction', 'type' => 'string', 'required' => true, 'example' => 'codeManage', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '目录树信息（返回目录树，边的所有信息，层次遍历，从根节点逐层遍历返回）；', 'description' => '目录树信息（返回目录树，边的所有信息，层次遍历，从根节点逐层遍历返回）；', 'type' => 'array', 'items' => [ 'title' => '树节点二元组', 'description' => '树节点二元组', 'type' => 'object', 'properties' => [ 'Parent' => [ 'title' => '父节点', 'description' => '父节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '目录ID', 'description' => '目录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'StringId' => [ 'title' => '目录StringID', 'description' => '目录StringID', 'type' => 'string', 'example' => '3', 'default' => 'null', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7081229106458752', ], 'CategoryType' => [ 'title' => '目录类型', 'description' => '目录类型', 'type' => 'string', 'example' => 'codeManage', ], 'DataCellId' => [ 'title' => '数据单元ID', 'description' => '数据单元ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3213', 'default' => 'null', ], 'DirName' => [ 'title' => '所在目录路径 仅对文件/资源节点有效', 'description' => '所在目录路径 仅对文件/资源节点有效', 'type' => 'string', 'example' => '/', ], 'Name' => [ 'title' => '对象显示名称', 'description' => '对象显示名称', 'type' => 'string', 'example' => '代码管理', ], 'Type' => [ 'title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'example' => 'codeManage', ], 'Creator' => [ 'title' => '创建人ID', 'description' => '创建人ID', 'type' => 'string', 'example' => '300000907', ], 'CreatorName' => [ 'title' => '创建人名称', 'description' => '创建人名称', 'type' => 'string', 'example' => 'John', ], 'GmtCreate' => [ 'title' => '创建时间 非实体对象节点为空', 'description' => '创建时间 非实体对象节点为空', 'type' => 'string', 'example' => '2024-11-01 18:08:17', ], 'GmtModified' => [ 'title' => '修改时间 非实体对象节点为空', 'description' => '修改时间 非实体对象节点为空', 'type' => 'string', 'example' => '2024-11-01 18:08:17', ], 'LastModifier' => [ 'title' => '修改人ID', 'description' => '修改人ID', 'type' => 'string', 'example' => '300000907', ], 'LastModifierName' => [ 'title' => '修改人名称'."\n" ."\n", 'description' => '修改人名称'."\n" ."\n", 'type' => 'string', 'example' => 'John', ], ], ], 'Children' => [ 'title' => '子节点', 'description' => '子节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '目录ID', 'description' => '目录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'StringId' => [ 'title' => '目录StringID', 'description' => '目录StringID', 'type' => 'string', 'example' => '3', 'default' => 'null', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7081229106458752', ], 'CategoryType' => [ 'title' => '目录类型', 'description' => '目录类型', 'type' => 'string', 'example' => 'codeManage', ], 'DataCellId' => [ 'title' => '数据单元ID', 'description' => '数据单元ID', 'type' => 'integer', 'format' => 'int64', 'example' => '41342', ], 'DirName' => [ 'title' => '所在目录路径 仅对文件/资源节点有效', 'description' => '所在目录路径 仅对文件/资源节点有效', 'type' => 'string', 'example' => '/', ], 'Name' => [ 'title' => '对象显示名称', 'description' => '对象显示名称', 'type' => 'string', 'example' => '代码管理', ], 'Type' => [ 'title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'example' => 'codeManage', ], 'Creator' => [ 'title' => '创建人ID', 'description' => '创建人ID', 'type' => 'string', 'example' => '300000907', ], 'CreatorName' => [ 'title' => '创建人名称', 'description' => '创建人名称', 'type' => 'string', 'example' => 'John', ], 'GmtCreate' => [ 'title' => '创建时间 非实体对象节点为空', 'description' => '创建时间 非实体对象节点为空', 'type' => 'string', 'example' => '2024-11-01 18:08:17', ], 'GmtModified' => [ 'title' => '修改时间 非实体对象节点为空', 'description' => '修改时间 非实体对象节点为空', 'type' => 'string', 'example' => '2024-11-01 18:08:17', ], 'LastModifier' => [ 'title' => '修改人ID', 'description' => '修改人ID', 'type' => 'string', 'example' => '300000907', ], 'LastModifierName' => [ 'title' => '修改人名称'."\n" ."\n", 'description' => '修改人名称'."\n" ."\n", 'type' => 'string', 'example' => 'John', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Parent\\": {\\n \\"Id\\": 3,\\n \\"StringId\\": \\"3\\",\\n \\"ProjectId\\": 7081229106458752,\\n \\"CategoryType\\": \\"codeManage\\",\\n \\"DataCellId\\": 3213,\\n \\"DirName\\": \\"/\\",\\n \\"Name\\": \\"代码管理\\",\\n \\"Type\\": \\"codeManage\\",\\n \\"Creator\\": \\"300000907\\",\\n \\"CreatorName\\": \\"John\\",\\n \\"GmtCreate\\": \\"2024-11-01 18:08:17\\",\\n \\"GmtModified\\": \\"2024-11-01 18:08:17\\",\\n \\"LastModifier\\": \\"300000907\\",\\n \\"LastModifierName\\": \\"John\\"\\n },\\n \\"Children\\": {\\n \\"Id\\": 3,\\n \\"StringId\\": \\"3\\",\\n \\"ProjectId\\": 7081229106458752,\\n \\"CategoryType\\": \\"codeManage\\",\\n \\"DataCellId\\": 41342,\\n \\"DirName\\": \\"/\\",\\n \\"Name\\": \\"代码管理\\",\\n \\"Type\\": \\"codeManage\\",\\n \\"Creator\\": \\"300000907\\",\\n \\"CreatorName\\": \\"John\\",\\n \\"GmtCreate\\": \\"2024-11-01 18:08:17\\",\\n \\"GmtModified\\": \\"2024-11-01 18:08:17\\",\\n \\"LastModifier\\": \\"300000907\\",\\n \\"LastModifierName\\": \\"John\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取文件夹目录树', ], 'ListFiles' => [ 'summary' => '查询目录树文件列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询条件', 'description' => '查询条件', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11112311', ], 'Category' => [ 'title' => '菜单树类目'."\n" .'即席查询：tempCode'."\n" .'代码任务：codeManage'."\n" .'离线管道：offlinePipeline'."\n" .'管道自定义组件：offlinePipelineCustomPlugin'."\n" .'同步任务：dataX'."\n" .'实时元表：streamMeta'."\n" .'实时自定义源：streamCustomDataSource'."\n" .'实时计算模板：streamTemplate'."\n" .'资源管理：resourceManage'."\n" .'离线函数：udfResource'."\n" .'实时函数：streamFunction', 'description' => '菜单树类目'."\n" .'- 即席查询：tempCode'."\n" .'- 代码任务：codeManage'."\n" .'- 离线管道：offlinePipeline'."\n" .'- 管道自定义组件：offlinePipelineCustomPlugin'."\n" .'- 同步任务：dataX'."\n" .'- 实时元表：streamMeta'."\n" .'- 实时自定义源：streamCustomDataSource'."\n" .'- 实时计算模板：streamTemplate'."\n" .'- 资源管理：resourceManage'."\n" .'- 离线函数：udfResource'."\n" .'- 实时函数：streamFunction', 'type' => 'string', 'required' => true, 'example' => 'tempCode', ], 'Recursive' => [ 'title' => '是否递归遍历查询'."\n" .'true：是， 返回目录下的所有节点'."\n" .'false：否，返回目录下第一层级节点', 'description' => '是否递归遍历查询'."\n" .'- true：是， 返回目录下的所有节点'."\n" .'- false：否，返回目录下第一层级节点', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], 'Directory' => [ 'title' => '文件目录', 'description' => '文件目录', 'type' => 'string', 'required' => true, 'example' => '/xx/x', ], 'Env' => [ 'title' => '环境标识'."\n" .'DEV'."\n" .'PROD', 'description' => '环境标识'."\n" .'- DEV'."\n" .'- PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'FileList' => [ 'title' => '文件列表', 'description' => '文件列表', 'type' => 'array', 'items' => [ 'title' => '文件', 'description' => '文件', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111231112', ], 'Name' => [ 'title' => '文件名', 'description' => '文件名', 'type' => 'string', 'example' => 'xx测试', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '312112121', ], 'Category' => [ 'title' => '文件类目', 'description' => '文件类目', 'type' => 'string', 'example' => 'tempCode', ], 'FileType' => [ 'title' => '文件类型, 如 directory', 'description' => '文件类型, 如 directory', 'type' => 'string', 'example' => 'directory', ], 'Directory' => [ 'title' => '文件目录', 'description' => '文件目录', 'type' => 'string', 'example' => '/xx/x', ], 'Content' => [ 'title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'example' => 'select 1;', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717483193830', ], 'GmtModified' => [ 'title' => '编辑时间', 'description' => '编辑时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717483193830', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '1212111', ], 'LastModifier' => [ 'title' => '修改者', 'description' => '修改者', 'type' => 'string', 'example' => '1212111', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FileList\\": [\\n {\\n \\"Id\\": 111231112,\\n \\"Name\\": \\"xx测试\\",\\n \\"ProjectId\\": 312112121,\\n \\"Category\\": \\"tempCode\\",\\n \\"FileType\\": \\"directory\\",\\n \\"Directory\\": \\"/xx/x\\",\\n \\"Content\\": \\"select 1;\\",\\n \\"GmtCreate\\": 1717483193830,\\n \\"GmtModified\\": 1717483193830,\\n \\"Creator\\": \\"1212111\\",\\n \\"LastModifier\\": \\"1212111\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询文件列表', ], 'GetBizEntityInfoByVersion' => [ 'summary' => '查询指定版本的业务实体的详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => '版本', 'description' => '版本', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'BizEntityInfo' => [ 'title' => '新建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'BizObject' => [ 'title' => '业务对象', 'description' => '业务对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务对象Id', 'description' => '业务对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], 'Name' => [ 'title' => '业务对象编码名称', 'description' => '业务对象编码名称', 'type' => 'string', 'example' => 'create_object_code_name', ], 'DisplayName' => [ 'title' => '业务对象名称', 'description' => '业务对象名称', 'type' => 'string', 'example' => 'create_object_name', ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'Type' => [ 'title' => '业务对象类型：普通对象 NORMAL、枚举对象 ENUM、虚拟对象 VIRTUAL、层级对象 HIERARCHY', 'description' => '业务对象类型，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => 'NORMAL', ], 'ParentId' => [ 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'description' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'type' => 'integer', 'format' => 'int64', 'example' => '116306', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '116106', ], ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'RefDimTableCount' => [ 'title' => '关联维度逻辑表数量', 'description' => '关联维度逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RefSummaryTableCount' => [ 'title' => '关联汇总逻辑表数量', 'description' => '关联汇总逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ChildBizEntityIdList' => [ 'title' => '业务对象的子业务对象', 'description' => '业务对象的子业务对象', 'type' => 'array', 'items' => [ 'title' => '子业务对象', 'description' => '子业务对象', 'type' => 'integer', 'format' => 'int64', 'example' => '1015', ], ], 'OnlineStatus' => [ 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '上线状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => '1', ], 'Status' => [ 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', 'description' => '状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => '100', ], 'ApprovalId' => [ 'title' => '审批流程Id', 'description' => '审批流程Id', 'type' => 'string', 'example' => '221323121212', ], 'ApprovalStatus' => [ 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', 'description' => '审批状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => 'APPROVING', ], ], ], 'BizProcess' => [ 'title' => '业务活动', 'description' => '业务活动', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务活动Id', 'description' => '业务活动Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], 'Name' => [ 'title' => '业务活动名称', 'description' => '业务活动名称', 'type' => 'string', 'example' => 'create_process_code_name', ], 'DisplayName' => [ 'title' => '业务活动展示名', 'description' => '业务活动展示名', 'type' => 'string', 'example' => '业务活动测试', ], 'Description' => [ 'title' => '业务活动描述', 'description' => '业务活动描述', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'Type' => [ 'title' => '业务活动类型：业务事件 BIZ_EVENT、业务快照 BIZ_SNAPSHOT、业务流程 BIZ_PROCESS', 'description' => '业务活动类型，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => 'BIZ_EVENT', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '116106', ], ], 'BizEventEntityIdList' => [ 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'description' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'type' => 'array', 'items' => [ 'title' => '业务流程活动包含的业务事件活动', 'description' => '业务流程活动包含的业务事件活动', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106', ], ], 'PreBizProcessIdList' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'array', 'items' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106', ], ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'HasDependent' => [ 'title' => '是否被依赖', 'description' => '是否被依赖', 'type' => 'boolean', ], 'OnlineStatus' => [ 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '上线状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => '1', ], 'Status' => [ 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', 'description' => '状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => '100', ], 'ApprovalId' => [ 'title' => '审批流程Id', 'description' => '审批流程Id', 'type' => 'string', 'example' => '221323121212', ], 'ApprovalStatus' => [ 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', 'description' => '审批状态，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => 'APPROVING', ], 'RefFactTableCount' => [ 'title' => '关联事实逻辑表数量', 'description' => '关联事实逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，参考“查询业务实体详情”接口', 'type' => 'string', 'example' => 'BIZ_OBJECT', ], 'DataDomainId' => [ 'title' => '所属主题域', 'description' => '所属主题域', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011', ], 'BizUnitId' => [ 'title' => '业务对象业务板块Id', 'description' => '业务对象业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"BizEntityInfo\\": {\\n \\"BizObject\\": {\\n \\"Id\\": 1011,\\n \\"Name\\": \\"create_object_code_name\\",\\n \\"DisplayName\\": \\"create_object_name\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Type\\": \\"NORMAL\\",\\n \\"ParentId\\": 116306,\\n \\"RefBizEntityIdList\\": [\\n 116106\\n ],\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"RefDimTableCount\\": 1,\\n \\"RefSummaryTableCount\\": 1,\\n \\"ChildBizEntityIdList\\": [\\n 1015\\n ],\\n \\"OnlineStatus\\": \\"1\\",\\n \\"Status\\": \\"100\\",\\n \\"ApprovalId\\": \\"221323121212\\",\\n \\"ApprovalStatus\\": \\"APPROVING\\"\\n },\\n \\"BizProcess\\": {\\n \\"Id\\": 1011,\\n \\"Name\\": \\"create_process_code_name\\",\\n \\"DisplayName\\": \\"业务活动测试\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Type\\": \\"BIZ_EVENT\\",\\n \\"RefBizEntityIdList\\": [\\n 116106\\n ],\\n \\"BizEventEntityIdList\\": [\\n 1016106\\n ],\\n \\"PreBizProcessIdList\\": [\\n 1016106\\n ],\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"HasDependent\\": true,\\n \\"OnlineStatus\\": \\"1\\",\\n \\"Status\\": \\"100\\",\\n \\"ApprovalId\\": \\"221323121212\\",\\n \\"ApprovalStatus\\": \\"APPROVING\\",\\n \\"RefFactTableCount\\": 1\\n },\\n \\"Type\\": \\"BIZ_OBJECT\\",\\n \\"DataDomainId\\": 20101011,\\n \\"BizUnitId\\": 6798087749072704\\n }\\n}","type":"json"}]', 'title' => '查询指定版本业务实体详情', ], 'GetBizEntityInfo' => [ 'summary' => '获取业务实体详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，具体参考“创建业务实体”接口', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'BizEntityInfo' => [ 'title' => '业务实体详情', 'description' => '业务实体详情', 'type' => 'object', 'properties' => [ 'BizObject' => [ 'title' => '业务对象', 'description' => '业务对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务对象Id', 'description' => '业务对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], 'Name' => [ 'title' => '业务对象编码名称', 'description' => '业务对象编码名称', 'type' => 'string', 'example' => 'create_object_code_name', ], 'DisplayName' => [ 'title' => '业务对象名称', 'description' => '业务对象名称', 'type' => 'string', 'example' => 'create_object_name', ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'Type' => [ 'title' => '业务对象类型：普通对象 NORMAL、枚举对象 ENUM、虚拟对象 VIRTUAL、层级对象 HIERARCHY', 'description' => '业务对象类型，具体参考“创建业务实体”接口', 'type' => 'string', 'example' => 'NORMAL', ], 'ParentId' => [ 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'description' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'type' => 'integer', 'format' => 'int64', 'example' => '116306', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '116106', ], ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'RefDimTableCount' => [ 'title' => '关联维度逻辑表数量', 'description' => '关联维度逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RefSummaryTableCount' => [ 'title' => '关联汇总逻辑表数量', 'description' => '关联汇总逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ChildBizEntityIdList' => [ 'title' => '业务对象的子业务对象', 'description' => '业务对象的子业务对象', 'type' => 'array', 'items' => [ 'title' => '子业务对象', 'description' => '子业务对象', 'type' => 'integer', 'format' => 'int64', 'example' => '1015', ], ], 'OnlineStatus' => [ 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '上线状态 '."\n" .'- 未上线 SUBMITTED'."\n" .'- 审批中 APPROVING'."\n" .'- 已上线 PUBLISHED'."\n" .'- 上线失败 REJECT', 'type' => 'string', 'example' => 'SUBMITTED', ], 'Status' => [ 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', 'description' => '状态:'."\n" .'- 草稿态/未上线 DRAFT'."\n" .'- 提交中 SUBMITTING'."\n" .'- 已提交 SUBMITTED'."\n" .'- 开发中 DEVELOPING'."\n" .'- 发布中 PUBLISHING'."\n" .'- 已发布 PUBLISHED', 'type' => 'string', 'example' => 'SUBMITTED', ], 'ApprovalId' => [ 'title' => '审批流程Id', 'description' => '审批流程Id', 'type' => 'string', 'example' => '221323121212', ], 'ApprovalStatus' => [ 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', 'description' => '审批状态:'."\n" .'- 未提交 INIT'."\n" .'- 审批中 APPROVING'."\n" .'- 已通过 AGREE'."\n" .'- 已拒绝 REJECT'."\n" .'- 校验失败 FAILED'."\n" .'- 主动撤回 REVOKE', 'type' => 'string', 'example' => 'APPROVING', ], ], ], 'BizProcess' => [ 'title' => '业务活动', 'description' => '业务活动', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务活动Id', 'description' => '业务活动Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], 'Name' => [ 'title' => '业务活动名称', 'description' => '业务活动名称', 'type' => 'string', 'example' => 'create_process_code_name', ], 'DisplayName' => [ 'title' => '业务活动展示名', 'description' => '业务活动展示名', 'type' => 'string', 'example' => '业务活动测试', ], 'Description' => [ 'title' => '业务活动描述', 'description' => '业务活动描述', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'Type' => [ 'title' => '业务活动类型：业务事件 BIZ_EVENT、业务快照 BIZ_SNAPSHOT、业务流程 BIZ_PROCESS', 'description' => '业务活动类型，具体参考“创建业务实体”接口', 'type' => 'string', 'example' => 'BIZ_EVENT', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '116106', ], ], 'BizEventEntityIdList' => [ 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'description' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'type' => 'array', 'items' => [ 'title' => '业务流程活动包含的业务事件活动', 'description' => '业务流程活动包含的业务事件活动', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106', ], ], 'PreBizProcessIdList' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'array', 'items' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106', ], ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'HasDependent' => [ 'title' => '是否被依赖', 'description' => '是否被依赖', 'type' => 'boolean', ], 'OnlineStatus' => [ 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '上线状态 '."\n" .'- 未上线 SUBMITTED'."\n" .'- 审批中 APPROVING'."\n" .'- 已上线 PUBLISHED'."\n" .'- 上线失败 REJECT', 'type' => 'string', 'example' => 'SUBMITTED', ], 'Status' => [ 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', 'description' => '状态:'."\n" .'- 草稿态/未上线 DRAFT'."\n" .'- 提交中 SUBMITTING'."\n" .'- 已提交 SUBMITTED'."\n" .'- 开发中 DEVELOPING'."\n" .'- 发布中 PUBLISHING'."\n" .'- 已发布 PUBLISHED', 'type' => 'string', 'example' => 'SUBMITTED', ], 'ApprovalId' => [ 'title' => '审批流程Id', 'description' => '审批流程Id', 'type' => 'string', 'example' => '221323121212', ], 'ApprovalStatus' => [ 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', 'description' => '审批状态'."\n" .'- 未提交 INIT'."\n" .'- 审批中 APPROVING'."\n" .'- 已通过 AGREE'."\n" .'- 已拒绝 REJECT'."\n" .'- 校验失败 FAILED'."\n" .'- 主动撤回 REVOKE', 'type' => 'string', 'example' => 'APPROVING', ], 'RefFactTableCount' => [ 'title' => '关联事实逻辑表数量', 'description' => '关联事实逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，具体参考“创建业务实体”接口', 'type' => 'string', 'example' => 'BIZ_OBJECT', ], 'DataDomainId' => [ 'title' => '业务活动所属主题域Id', 'description' => '业务活动所属主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011', ], 'BizUnitId' => [ 'title' => '业务活动所属业务板块Id', 'description' => '业务活动所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"BizEntityInfo\\": {\\n \\"BizObject\\": {\\n \\"Id\\": 1011,\\n \\"Name\\": \\"create_object_code_name\\",\\n \\"DisplayName\\": \\"create_object_name\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Type\\": \\"NORMAL\\",\\n \\"ParentId\\": 116306,\\n \\"RefBizEntityIdList\\": [\\n 116106\\n ],\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"RefDimTableCount\\": 1,\\n \\"RefSummaryTableCount\\": 1,\\n \\"ChildBizEntityIdList\\": [\\n 1015\\n ],\\n \\"OnlineStatus\\": \\"SUBMITTED\\",\\n \\"Status\\": \\"SUBMITTED\\",\\n \\"ApprovalId\\": \\"221323121212\\",\\n \\"ApprovalStatus\\": \\"APPROVING\\"\\n },\\n \\"BizProcess\\": {\\n \\"Id\\": 1011,\\n \\"Name\\": \\"create_process_code_name\\",\\n \\"DisplayName\\": \\"业务活动测试\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Type\\": \\"BIZ_EVENT\\",\\n \\"RefBizEntityIdList\\": [\\n 116106\\n ],\\n \\"BizEventEntityIdList\\": [\\n 1016106\\n ],\\n \\"PreBizProcessIdList\\": [\\n 1016106\\n ],\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"HasDependent\\": true,\\n \\"OnlineStatus\\": \\"SUBMITTED\\",\\n \\"Status\\": \\"SUBMITTED\\",\\n \\"ApprovalId\\": \\"221323121212\\",\\n \\"ApprovalStatus\\": \\"APPROVING\\",\\n \\"RefFactTableCount\\": 1\\n },\\n \\"Type\\": \\"BIZ_OBJECT\\",\\n \\"DataDomainId\\": 20101011,\\n \\"BizUnitId\\": 6798087749072704\\n }\\n}","type":"json"}]', 'title' => '查询业务实体详情', ], 'UpdateBizUnit' => [ 'summary' => '更新数据板块。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '数据板块ID', 'description' => '数据板块ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456', ], 'Name' => [ 'title' => '数据板块编码', 'description' => '数据板块编码', 'type' => 'string', 'required' => true, 'example' => 'bz_code_name', ], 'DisplayName' => [ 'title' => '数据板块展示名', 'description' => '数据板块展示名', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Icon' => [ 'title' => '预制icon'."\n" .' 电商：icon-e-commerce, 金融：icon-finance, 云计算：con-cloud-computing, 广告营销：icon-advertisement, 物流：icon-logistics, 文娱：icon-entertainment, 出行：icon-traffic, 健康：icon-health, 社交&通信：icon-social-contact, 餐饮：con-dining, 教育：icon-education, 环境：icon-environment 等', 'description' => '预制icon，具体可参考”创建数据板块“接口', 'type' => 'string', 'required' => true, 'example' => 'icon-environment', ], 'BizUnitAccountList' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'array', 'items' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '20001201', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '更新数据板块', ], 'ListBizUnits' => [ 'summary' => '获取当前租户下的所有数据板块。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'BizUnitList' => [ 'title' => '数据板块详情', 'description' => '数据板块详情', 'type' => 'array', 'items' => [ 'title' => '数据板块详情', 'description' => '数据板块详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据板块Id', 'description' => '数据板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '101001201', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'test01', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => '测试', ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'Icon' => [ 'title' => '数据板块图标', 'description' => '数据板块图标', 'type' => 'string', 'example' => 'icon-e-commerce', ], 'Env' => [ 'title' => '环境标识: DEV：开发环境，PROD：生产环境', 'description' => '环境标识: DEV：开发环境，PROD：生产环境', 'type' => 'string', 'example' => 'DEV', ], 'Mode' => [ 'title' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'description' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'type' => 'string', 'example' => 'DEV_PROD', ], 'AccountList' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'array', 'items' => [ 'title' => '用户', 'description' => '用户', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '20001201', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"BizUnitList\\": [\\n {\\n \\"Id\\": 101001201,\\n \\"Name\\": \\"test01\\",\\n \\"DisplayName\\": \\"测试\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"Icon\\": \\"icon-e-commerce\\",\\n \\"Env\\": \\"DEV\\",\\n \\"Mode\\": \\"DEV_PROD\\",\\n \\"AccountList\\": [\\n {\\n \\"Id\\": \\"20001201\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询当前租户下的所有数据板块', ], 'GetBizUnitInfo' => [ 'summary' => '获取数据板块详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '数据板块Id', 'description' => '数据板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'BizUnitInfo' => [ 'title' => '数据板块详情', 'description' => '数据板块详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据板块Id', 'description' => '数据板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '101001201', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'test01', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => '测试', ], 'EnvList' => [ 'title' => '生产/开发 2个环境对应的板块英文名', 'description' => '生产/开发 2个环境对应的板块英文名', 'type' => 'array', 'items' => [ 'title' => '生产/开发 2个环境对应的板块英文名', 'description' => '生产/开发 2个环境对应的板块英文名', 'type' => 'object', 'properties' => [ 'EnvName' => [ 'title' => '环境标识: PROD / DEV', 'description' => '环境标识: PROD / DEV', 'type' => 'string', 'example' => 'DEV', ], 'Name' => [ 'title' => '英文名', 'description' => '英文名', 'type' => 'string', 'example' => 'LD_test001_dev', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => '测试数据板块001_开发', ], ], ], ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'Icon' => [ 'title' => '数据板块图标', 'description' => '数据板块图标', 'type' => 'string', 'example' => 'icon-e-commerce', ], 'Mode' => [ 'title' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'description' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'type' => 'string', 'example' => 'DEV_PROD', ], 'AccountList' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'array', 'items' => [ 'title' => '用户', 'description' => '用户', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '20001201', ], ], ], ], 'BusinessLeaderList' => [ 'title' => '业务负责人', 'description' => '业务负责人', 'type' => 'array', 'items' => [ 'title' => '用户', 'description' => '用户', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '20001201', ], ], ], ], 'DataLeaderList' => [ 'title' => '数据负责人', 'description' => '数据负责人', 'type' => 'array', 'items' => [ 'title' => '用户', 'description' => '用户', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '20001201', ], ], ], ], 'DataDomainCount' => [ 'title' => '主题域个数', 'description' => '主题域个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BizObjectCount' => [ 'title' => '业务对象个数', 'description' => '业务对象个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BizProcessCount' => [ 'title' => '业务活动个数', 'description' => '业务活动个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"BizUnitInfo\\": {\\n \\"Id\\": 101001201,\\n \\"Name\\": \\"test01\\",\\n \\"DisplayName\\": \\"测试\\",\\n \\"EnvList\\": [\\n {\\n \\"EnvName\\": \\"DEV\\",\\n \\"Name\\": \\"LD_test001_dev\\",\\n \\"DisplayName\\": \\"测试数据板块001_开发\\"\\n }\\n ],\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"Icon\\": \\"icon-e-commerce\\",\\n \\"Mode\\": \\"DEV_PROD\\",\\n \\"AccountList\\": [\\n {\\n \\"Id\\": \\"20001201\\"\\n }\\n ],\\n \\"BusinessLeaderList\\": [\\n {\\n \\"Id\\": \\"20001201\\"\\n }\\n ],\\n \\"DataLeaderList\\": [\\n {\\n \\"Id\\": \\"20001201\\"\\n }\\n ],\\n \\"DataDomainCount\\": 1,\\n \\"BizObjectCount\\": 1,\\n \\"BizProcessCount\\": 1\\n }\\n}","type":"json"}]', 'title' => '查询数据板块详情', ], 'DeleteBizUnit' => [ 'summary' => '删除数据板块。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除数据板块', ], 'CreateBizUnit' => [ 'summary' => '创建数据板块。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'description' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name', ], 'DisplayName' => [ 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'description' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'type' => 'string', 'required' => true, 'example' => 'create_object_name', ], 'Description' => [ 'title' => '业务对象描述信息，128字符以内', 'description' => '业务对象描述信息，128字符以内', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Icon' => [ 'title' => '预制icon'."\n" .' 电商：icon-e-commerce, 金融：icon-finance, 云计算：con-cloud-computing, 广告营销：icon-advertisement, 物流：icon-logistics, 文娱：icon-entertainment, 出行：icon-traffic, 健康：icon-health, 社交&通信：icon-social-contact, 餐饮：con-dining, 教育：icon-education, 环境：icon-environment 等', 'description' => '预制icon'."\n" .'- 电商：icon-e-commerce'."\n" .'- 金融：icon-finance'."\n" .'- 云计算：con-cloud-computing'."\n" .'- 广告营销：icon-advertisement'."\n" .'- 物流：icon-logistics'."\n" .'- 文娱：icon-entertainment'."\n" .'- 出行：icon-traffic'."\n" .'- 健康：icon-health'."\n" .'- 社交&通信：icon-social-contact'."\n" .'- 餐饮：con-dining'."\n" .'- 教育：icon-education'."\n" .'- 环境：icon-environment', 'type' => 'string', 'required' => true, 'example' => 'icon-environment', ], 'Mode' => [ 'title' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'description' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', 'type' => 'string', 'required' => false, 'example' => 'DEV_PROD', ], 'BizUnitAccountList' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'array', 'items' => [ 'title' => '板块架构师', 'description' => '板块架构师', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '20001201', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '新建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '新建的数据板块ID', 'description' => '新建的数据板块ID', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"BizUnitId\\": 545844456\\n }\\n}","type":"json"}]', 'title' => '创建数据板块', ], 'UpdateBizEntity' => [ 'summary' => '更新业务实体。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '变更请求', 'description' => '变更请求', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，参考”创建业务实体“接口', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], 'DataDomainId' => [ 'title' => '业务活动所属主题域Id', 'description' => '业务活动所属主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20101011', ], 'BizUnitId' => [ 'title' => '业务活动所属业务板块Id', 'description' => '业务活动所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], 'BizObject' => [ 'title' => '业务对象', 'description' => '业务对象', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'description' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name', ], 'DisplayName' => [ 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'description' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'type' => 'string', 'required' => true, 'example' => 'create_object_name', ], 'Description' => [ 'title' => '业务对象描述信息，128字符以内', 'description' => '业务对象描述信息，128字符以内', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人用户Id', 'description' => '业务对象负责人用户Id', 'type' => 'string', 'required' => true, 'example' => '30010010', ], 'ParentId' => [ 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'description' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '116306', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', 'description' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106', ], 'required' => false, ], ], 'required' => false, ], 'BizProcess' => [ 'title' => '业务活动', 'description' => '业务活动', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'description' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'type' => 'string', 'required' => true, 'example' => 'create_process_code_name', ], 'DisplayName' => [ 'title' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'description' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'type' => 'string', 'required' => true, 'example' => 'create_process_name', ], 'Description' => [ 'title' => '业务活动描述信息，128字符以内', 'description' => '业务活动描述信息，128字符以内', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务活动负责人用户Id', 'description' => '业务活动负责人用户Id', 'type' => 'string', 'required' => true, 'example' => '30010010', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', 'description' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106', ], 'required' => false, ], 'BizEventEntityIdList' => [ 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'description' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'type' => 'array', 'items' => [ 'title' => '业务流程活动包含的业务事件活动', 'description' => '业务流程活动包含的业务事件活动', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106', ], 'required' => false, ], 'PreBizProcessIdList' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'array', 'items' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106', ], 'required' => false, ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '更新业务实体', ], 'OnlineBizEntity' => [ 'summary' => '上线业务实体。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'OnlineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '上线请求', 'description' => '上线请求', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '所属业务板块Id', 'description' => '所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], 'Id' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], 'Comment' => [ 'title' => '下线备注', 'description' => '下线备注', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '上线业务实体', ], 'OfflineBizEntity' => [ 'summary' => '下线业务实体。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '下线请求', 'description' => '下线请求', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '所属业务板块Id', 'description' => '所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，参考”创建业务实体“接口', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], 'Id' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], 'Comment' => [ 'title' => '下线备注', 'description' => '下线备注', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '下线业务实体', ], 'ListBizEntities' => [ 'summary' => '查询业务实体列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'object_', ], 'Page' => [ 'title' => '页码, 默认 1', 'description' => '页码, 默认 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认 10', 'description' => '分页记录数, 默认 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'FilterCriteria' => [ 'title' => '查询过滤条件', 'description' => '查询过滤条件', 'type' => 'object', 'properties' => [ 'BizUnitIdList' => [ 'title' => '所属业务板块', 'description' => '所属业务板块', 'type' => 'array', 'items' => [ 'title' => '所属业务板块', 'description' => '所属业务板块', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102323411', ], 'required' => false, ], 'BizUnitNameList' => [ 'title' => '所属业务板块', 'description' => '所属业务板块', 'type' => 'array', 'items' => [ 'title' => '所属业务板块', 'description' => '所属业务板块', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'required' => false, ], 'DataDomainIdList' => [ 'title' => '所属主题域', 'description' => '所属主题域', 'type' => 'array', 'items' => [ 'title' => '所属业务板块', 'description' => '所属业务板块', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102323411', ], 'required' => false, ], 'DataDomainNameList' => [ 'title' => '所属主题域', 'description' => '所属主题域', 'type' => 'array', 'items' => [ 'title' => '所属主题域', 'description' => '所属主题域', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'required' => false, ], 'SubTypeList' => [ 'title' => '业务实体细分类型: 普通对象 NORMAL、枚举对象 ENUM、虚拟对象 VIRTUAL、层级对象 HIERARCHY、业务事件 BIZ_EVENT、业务快照 BIZ_SNAPSHOT、业务流程 BIZ_PROCESS', 'description' => '业务实体细分类型，参考”查询业务实体详情“接口', 'type' => 'array', 'items' => [ 'title' => '所属主题域', 'description' => '所属主题域', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'required' => false, ], 'OwnerUserIdList' => [ 'title' => '所属负责人Id', 'description' => '所属负责人Id', 'type' => 'array', 'items' => [ 'title' => '所属负责人Id', 'description' => '所属负责人Id', 'type' => 'string', 'required' => true, 'example' => '30001326', ], 'required' => false, ], 'HasTableRef' => [ 'title' => '是否有逻辑表关联', 'description' => '是否有逻辑表关联', 'type' => 'boolean', 'required' => false, ], 'StatusList' => [ 'title' => '业务实体状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '业务实体状态，参考”查询业务实体详情“接口', 'type' => 'array', 'items' => [ 'title' => '业务实体状态', 'description' => '业务实体状态', 'type' => 'string', 'required' => true, 'example' => 'PUBLISHED', ], 'required' => false, ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页结果', 'description' => '分页结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '66', ], 'BizEntityList' => [ 'title' => '业务实体列表', 'description' => '业务实体列表', 'type' => 'array', 'items' => [ 'title' => '业务实体', 'description' => '业务实体', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12121111', ], 'Name' => [ 'title' => '业务实体名称', 'description' => '业务实体名称', 'type' => 'string', 'example' => 'create_process_code_name', ], 'DisplayName' => [ 'title' => '业务实体展示名', 'description' => '业务实体展示名', 'type' => 'string', 'example' => '业务活动测试', ], 'Description' => [ 'title' => '业务实体描述', 'description' => '业务实体描述', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务实体负责人', 'description' => '业务实体负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务实体负责人', 'description' => '业务实体负责人', 'type' => 'string', 'example' => '张三', ], 'Type' => [ 'title' => '业务实体类型：业务对象 BIZ_OBJECT、业务活动 BIZ_PROCESS', 'description' => '业务实体类型：业务对象 BIZ_OBJECT、业务活动 BIZ_PROCESS', 'type' => 'string', 'example' => 'BIZ_OBJECT', ], 'SubType' => [ 'title' => '业务实体细分类型', 'description' => '业务实体细分类型', 'type' => 'string', 'example' => 'NORMAL', ], 'DataDomainId' => [ 'title' => '业务活动所属主题域Id', 'description' => '业务活动所属主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011', ], 'BizUnitId' => [ 'title' => '业务活动所属业务板块Id', 'description' => '业务活动所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'OnlineStatus' => [ 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', 'description' => '上线状态 '."\n" .'- 未上线 SUBMITTED'."\n" .'- 审批中 APPROVING'."\n" .'- 已上线 PUBLISHED'."\n" .'- 上线失败 REJECT', 'type' => 'string', 'example' => 'SUBMITTED', ], 'Status' => [ 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', 'description' => '状态:'."\n" .'- 草稿态/未上线 DRAFT'."\n" .'- 提交中 SUBMITTING'."\n" .'- 已提交 SUBMITTED'."\n" .'- 开发中 DEVELOPING'."\n" .'- 发布中 PUBLISHING'."\n" .'- 已发布 PUBLISHED', 'type' => 'string', 'example' => 'SUBMITTED', ], 'RefTableCount' => [ 'title' => '关联逻辑表数量', 'description' => '关联逻辑表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HasChildBizEntity' => [ 'title' => '是否子业务对象', 'description' => '是否子业务对象', 'type' => 'boolean', ], 'LevelSubBizObject' => [ 'title' => '是否层级维度的子层级', 'description' => '是否层级维度的子层级', 'type' => 'boolean', ], 'RefBizEntityIdList' => [ 'title' => '被关联的中心业务实体列表', 'description' => '被关联的中心业务实体列表', 'type' => 'array', 'items' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11023', ], ], 'BelongToBizEntityIdList' => [ 'title' => '被从属的业务流程, 当前类型是业务活动时有效', 'description' => '被从属的业务流程, 当前类型是业务活动时有效', 'type' => 'array', 'items' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11023', ], ], 'ChildBizEntityIdList' => [ 'title' => '子业务对象Id列表, 当前类型是业务对象时有效', 'description' => '子业务对象Id列表, 当前类型是业务对象时有效', 'type' => 'array', 'items' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11023', ], ], 'SuffixBizEntityIdList' => [ 'title' => '后续业务流程, 当前类型是业务活动时有效', 'description' => '后续业务流程, 当前类型是业务活动时有效', 'type' => 'array', 'items' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11023', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 66,\\n \\"BizEntityList\\": [\\n {\\n \\"Id\\": 12121111,\\n \\"Name\\": \\"create_process_code_name\\",\\n \\"DisplayName\\": \\"业务活动测试\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"Type\\": \\"BIZ_OBJECT\\",\\n \\"SubType\\": \\"NORMAL\\",\\n \\"DataDomainId\\": 20101011,\\n \\"BizUnitId\\": 6798087749072704,\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"OnlineStatus\\": \\"SUBMITTED\\",\\n \\"Status\\": \\"SUBMITTED\\",\\n \\"RefTableCount\\": 1,\\n \\"HasChildBizEntity\\": true,\\n \\"LevelSubBizObject\\": true,\\n \\"RefBizEntityIdList\\": [\\n 11023\\n ],\\n \\"BelongToBizEntityIdList\\": [\\n 11023\\n ],\\n \\"ChildBizEntityIdList\\": [\\n 11023\\n ],\\n \\"SuffixBizEntityIdList\\": [\\n 11023\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询业务实体列表', ], 'CreateBizEntity' => [ 'summary' => '创建业务实体。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'BizObject' => [ 'title' => '业务对象', 'description' => '业务对象', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'description' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name', ], 'DisplayName' => [ 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'description' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'type' => 'string', 'required' => true, 'example' => 'create_object_name', ], 'Description' => [ 'title' => '业务对象描述信息，128字符以内', 'description' => '业务对象描述信息，128字符以内', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人用户Id', 'description' => '业务对象负责人用户Id', 'type' => 'string', 'required' => false, 'example' => '30010010', ], 'Type' => [ 'title' => '业务对象类型：普通对象 NORMAL、枚举对象 ENUM、虚拟对象 VIRTUAL、层级对象 HIERARCHY', 'description' => '业务对象类型'."\n" .'- 普通对象 NORMAL'."\n" .'- 枚举对象 ENUM'."\n" .'- 虚拟对象 VIRTUAL'."\n" .'- 层级对象 HIERARCHY', 'type' => 'string', 'required' => true, 'example' => 'NORMAL', ], 'ParentId' => [ 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'description' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '116306', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106', ], 'required' => false, ], ], 'required' => false, ], 'BizProcess' => [ 'title' => '业务活动', 'description' => '业务活动', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'description' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', 'type' => 'string', 'required' => true, 'example' => 'create_process_code_name', ], 'DisplayName' => [ 'title' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'description' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', 'type' => 'string', 'required' => true, 'example' => 'create_process_name', ], 'Description' => [ 'title' => '业务活动描述信息，128字符以内', 'description' => '业务活动描述信息，128字符以内', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务活动负责人用户Id', 'description' => '业务活动负责人用户Id', 'type' => 'string', 'required' => false, 'example' => '30010010', ], 'Type' => [ 'title' => '业务活动类型：业务事件 BIZ_EVENT、业务快照 BIZ_SNAPSHOT、业务流程 BIZ_PROCESS', 'description' => '业务活动类型'."\n" .'- 业务事件 BIZ_EVENT'."\n" .'- 业务快照 BIZ_SNAPSHOT'."\n" .'- 业务流程 BIZ_PROCESS', 'type' => 'string', 'required' => true, 'example' => 'BIZ_EVENT', ], 'RefBizEntityIdList' => [ 'title' => '关联已上线业务实体Id列表', 'description' => '关联已上线业务实体Id列表', 'type' => 'array', 'items' => [ 'title' => '关联已上线业务实体Id', 'description' => '关联已上线业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106', ], 'required' => false, ], 'BizEventEntityIdList' => [ 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'description' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', 'type' => 'array', 'items' => [ 'title' => '业务流程活动包含的业务事件活动', 'description' => '业务流程活动包含的业务事件活动', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106', ], 'required' => false, ], 'PreBizProcessIdList' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'array', 'items' => [ 'title' => '业务流程活动的前序业务流程活动', 'description' => '业务流程活动的前序业务流程活动', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106', ], 'required' => false, ], ], 'required' => false, ], 'Type' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务类型: '."\n" .'- BIZ_OBJECT：业务对象'."\n" .'- BIZ_PROCESS：业务活动', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], 'DataDomainId' => [ 'title' => '业务活动所属主题域Id', 'description' => '业务活动所属主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20101011', ], 'BizUnitId' => [ 'title' => '业务活动所属业务板块Id', 'description' => '业务活动所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '新建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'BizEntityId' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"BizEntityId\\": 12113111\\n }\\n}","type":"json"}]', 'title' => '创建业务实体', ], 'UpdateDataDomain' => [ 'summary' => '更新主题域。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '数据板块ID', 'description' => '数据板块ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456', ], 'DataDomainId' => [ 'title' => '主题域ID', 'description' => '主题域ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456', ], 'Name' => [ 'title' => '主题域编码', 'description' => '主题域编码', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name', ], 'DisplayName' => [ 'title' => '主题域展示名', 'description' => '主题域展示名', 'type' => 'string', 'required' => true, 'example' => '主题域测试', ], 'Abbreviation' => [ 'title' => '主题域缩写', 'description' => '主题域缩写', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name', ], 'Description' => [ 'title' => '主题域描述', 'description' => '主题域描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ParentId' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10232311', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '更新主题域', ], 'ListDataDomains' => [ 'summary' => '获取主题域列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'BizUnitIdList' => [ 'title' => '所属数据板块Id', 'description' => '所属数据板块Id', 'type' => 'array', 'items' => [ 'title' => '所属数据板块Id', 'description' => '所属数据板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456', ], 'required' => false, ], 'ParentIdList' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'array', 'items' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10232311', ], 'required' => false, ], 'Keyword' => [ 'title' => '搜索关键词: 主题名称/编码/描述', 'description' => '搜索关键词: 主题名称/编码/描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'DataDomainList' => [ 'title' => '主题域详情', 'description' => '主题域详情', 'type' => 'array', 'items' => [ 'title' => '主题域详情', 'description' => '主题域详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主题域Id', 'description' => '主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456', ], 'BizUnitId' => [ 'title' => '所属数据板块', 'description' => '所属数据板块', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'dm_code_name', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => '测试', ], 'Abbreviation' => [ 'title' => '主题域缩写', 'description' => '主题域缩写', 'type' => 'string', 'example' => 'dm_code_name', ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'ParentId' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10232311', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DataDomainList\\": [\\n {\\n \\"Id\\": 1241844456,\\n \\"BizUnitId\\": 545844456,\\n \\"Name\\": \\"dm_code_name\\",\\n \\"DisplayName\\": \\"测试\\",\\n \\"Abbreviation\\": \\"dm_code_name\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"ParentId\\": 10232311\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询主题域列表', ], 'GetDataDomainInfo' => [ 'summary' => '获取主题域详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '主题域Id', 'description' => '主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'DataDomainInfo' => [ 'title' => '主题域详情', 'description' => '主题域详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主题域Id', 'description' => '主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456', ], 'BizUnitId' => [ 'title' => '所属数据板块', 'description' => '所属数据板块', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'dm_code_name', ], 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => '测试', ], 'Abbreviation' => [ 'title' => '主题域缩写', 'description' => '主题域缩写', 'type' => 'string', 'example' => 'dm_code_name', ], 'Description' => [ 'title' => '业务对象描述信息', 'description' => '业务对象描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerUserId' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '30010010', ], 'OwnerName' => [ 'title' => '业务对象负责人', 'description' => '业务对象负责人', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'LastModifier' => [ 'title' => '最近一次修改人ID', 'description' => '最近一次修改人ID', 'type' => 'string', 'example' => '30010010', ], 'LastModifierName' => [ 'title' => '最近一次修改人', 'description' => '最近一次修改人', 'type' => 'string', 'example' => '张三', ], 'ParentId' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10232311', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"DataDomainInfo\\": {\\n \\"Id\\": 1241844456,\\n \\"BizUnitId\\": 545844456,\\n \\"Name\\": \\"dm_code_name\\",\\n \\"DisplayName\\": \\"测试\\",\\n \\"Abbreviation\\": \\"dm_code_name\\",\\n \\"Description\\": \\"test\\",\\n \\"OwnerUserId\\": \\"30010010\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModified\\": \\"2024-10-10 10:00:00\\",\\n \\"LastModifier\\": \\"30010010\\",\\n \\"LastModifierName\\": \\"张三\\",\\n \\"ParentId\\": 10232311\\n }\\n}","type":"json"}]', 'title' => '查询主题域详情', ], 'DeleteDataDomain' => [ 'summary' => '删除主题域。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'BizUnitId', 'in' => 'query', 'schema' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '主题域Id', 'description' => '主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除主题域', ], 'CreateDataDomain' => [ 'summary' => '创建主题域。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'BizUnitId' => [ 'title' => '所属数据板块Id', 'description' => '所属数据板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456', ], 'Name' => [ 'title' => '主题域编码', 'description' => '主题域编码', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name', ], 'DisplayName' => [ 'title' => '主题域名称', 'description' => '主题域名称', 'type' => 'string', 'required' => true, 'example' => '主题域测试', ], 'Abbreviation' => [ 'title' => '主题域缩写', 'description' => '主题域缩写', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name', ], 'Description' => [ 'title' => '主题域描述', 'description' => '主题域描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ParentId' => [ 'title' => '上级主题域Id', 'description' => '上级主题域Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10232311', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '新建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'DataDomainId' => [ 'title' => '主题域Id', 'description' => '主题域Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"DataDomainId\\": 1241844456\\n }\\n}","type":"json"}]', 'title' => '创建主题域', ], 'DeleteBizEntity' => [ 'summary' => '删除业务实体。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'BizUnitId', 'in' => 'query', 'schema' => [ 'title' => '所属业务板块Id', 'description' => '所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', 'description' => '业务实体类型，具体参考“创建业务实体”接口', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '业务实体Id', 'description' => '业务实体Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除业务实体', ], 'CreateAdHocFile' => [ 'summary' => '创建即席查询文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '新建即席查询请求', 'description' => '新建即席查询请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11212133', ], 'Name' => [ 'title' => '文件名', 'description' => '文件名', 'type' => 'string', 'required' => true, 'example' => 'test_xx', ], 'Directory' => [ 'title' => '文件所在目录', 'description' => '文件所在目录', 'type' => 'string', 'required' => true, 'example' => '/xx1/xx2/', ], 'Content' => [ 'title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'required' => true, 'example' => 'select 1;', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'FileId' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1212313222', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FileId\\": 1212313222\\n}","type":"json"}]', 'title' => '创建即席查询文件', ], 'DeleteAdHocFile' => [ 'summary' => '删除菜单树即席查询文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除即席查询文件', ], 'UpdateAdHocFile' => [ 'summary' => '修改即席查询文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑请求', 'description' => '编辑请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1212313', ], 'FileId' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2311113', ], 'Content' => [ 'title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'required' => true, 'example' => 'select 1;', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '修改即席查询文件', ], 'GetAdHocFile' => [ 'summary' => '查询目录树即席查询文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'FileInfo' => [ 'title' => '即席查询文件详情', 'description' => '即席查询文件详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12121111', ], 'Name' => [ 'title' => '文件名', 'description' => '文件名', 'type' => 'string', 'example' => 'xx测试', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12132323', ], 'Directory' => [ 'title' => '文件所在目录', 'description' => '文件所在目录', 'type' => 'string', 'example' => '/xx1/xx2/', ], 'Content' => [ 'title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'example' => 'select 1;', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '12121', ], 'LastModifier' => [ 'title' => '编辑者', 'description' => '编辑者', 'type' => 'string', 'example' => '12121', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FileInfo\\": {\\n \\"Id\\": 12121111,\\n \\"Name\\": \\"xx测试\\",\\n \\"ProjectId\\": 12132323,\\n \\"Directory\\": \\"/xx1/xx2/\\",\\n \\"Content\\": \\"select 1;\\",\\n \\"Creator\\": \\"12121\\",\\n \\"LastModifier\\": \\"12121\\"\\n }\\n}","type":"json"}]', 'title' => '查询即席查询文件', ], 'StopAdHocTask' => [ 'summary' => '终止即席查询任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '终止即席查询任务', ], 'GetAdHocTaskResult' => [ 'summary' => '获取即席查询的任务运行结果。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], ], [ 'name' => 'SubTaskId', 'in' => 'query', 'schema' => [ 'title' => '子任务ID', 'description' => '子任务ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ExecuteResult' => [ 'title' => '运行结果', 'description' => '运行结果', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], 'ScheduleTaskId' => [ 'title' => '对应调度任务ID', 'description' => '对应调度任务ID', 'type' => 'string', 'example' => 't_2242892326444990464_20210125_2242892326444990465', ], 'Result' => [ 'title' => '任务执行结果', 'description' => '任务执行结果', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ExecuteResult\\": {\\n \\"TaskId\\": \\"MaxCompute_SQL_300000843_1611548758327\\",\\n \\"ScheduleTaskId\\": \\"t_2242892326444990464_20210125_2242892326444990465\\",\\n \\"Result\\": \\"1\\"\\n }\\n}","type":"json"}]', 'title' => '获取即席查询的任务运行结果', ], 'ExecuteAdHocTask' => [ 'summary' => '执行即席查询任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ExecuteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '执行命令', 'description' => '执行命令', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '任务脚本', 'description' => '任务脚本', 'type' => 'string', 'required' => true, 'example' => 'show tables;', ], 'ParamList' => [ 'title' => '运行参数列表', 'description' => '运行参数', 'type' => 'array', 'items' => [ 'title' => '运行参数', 'description' => '运行参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '运行参数名称', 'description' => '参数', 'type' => 'string', 'required' => true, 'example' => 'param1', ], 'Value' => [ 'title' => '运行参数值', 'description' => '参数值', 'type' => 'string', 'required' => true, 'example' => 'value1', ], ], 'required' => true, ], 'required' => false, ], 'OperatorType' => [ 'title' => '任务类型', 'description' => '任务类型', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123222121', ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'erp', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ExecuteResult' => [ 'title' => '执行结果', 'description' => '执行结果', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], 'SubTaskCount' => [ 'title' => '任务解析, 拆分出来子任务个数', 'description' => '任务解析, 拆分出来子任务个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ExecuteResult\\": {\\n \\"TaskId\\": \\"MaxCompute_SQL_300000843_1611548758327\\",\\n \\"SubTaskCount\\": 1\\n }\\n}","type":"json"}]', 'title' => '执行即席查询任务', ], 'GetAdHocTaskLog' => [ 'summary' => '获取即席查询任务运行日志。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], ], [ 'name' => 'SubTaskId', 'in' => 'query', 'schema' => [ 'title' => '子任务ID, 从0开始', 'description' => '子任务ID, 从0开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'Offset', 'in' => 'query', 'schema' => [ 'title' => '查询日志的偏移量, 根据返回的结果递增 初始值传0', 'description' => '查询日志的偏移量, 根据返回的结果递增 初始值传0', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1021', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'LogInfo' => [ 'title' => '日志详情', 'description' => '日志详情', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327', ], 'SubTaskId' => [ 'title' => '子任务ID', 'description' => '子任务ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TaskStatus' => [ 'title' => '任务运行状态: 等待资源 WAIT_RESOURCE', 'description' => '任务运行状态: 等待资源 WAIT_RESOURCE', 'type' => 'string', 'example' => 'WAIT_RESOURCE', ], 'HasNext' => [ 'title' => '是否有下一条日志', 'description' => '是否有下一条日志', 'type' => 'boolean', ], 'HasResult' => [ 'title' => '当前查询是否会产生结果', 'description' => '当前查询是否会产生结果', 'type' => 'boolean', ], 'NextOffset' => [ 'title' => '下条日志的起始位置', 'description' => '下条日志的起始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '2021', ], 'Content' => [ 'title' => '运行日志', 'description' => '运行日志', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"LogInfo\\": {\\n \\"TaskId\\": \\"MaxCompute_SQL_300000843_1611548758327\\",\\n \\"SubTaskId\\": 0,\\n \\"TaskStatus\\": \\"WAIT_RESOURCE\\",\\n \\"HasNext\\": true,\\n \\"HasResult\\": true,\\n \\"NextOffset\\": 2021,\\n \\"Content\\": \\"test\\"\\n }\\n}","type":"json"}]', 'title' => '获取即席查询任务运行日志', ], 'UpdatePipelineByAsync' => [ 'summary' => '异步更新集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新管道任务配置', 'description' => '更新管道任务配置', 'type' => 'object', 'properties' => [ 'ScheduleConfig' => [ 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'description' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}', ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'PipelineConfig' => [ 'title' => '集成管道组件配置', 'description' => '集成管道组件配置', 'type' => 'object', 'properties' => [ 'Steps' => [ 'title' => '组件配置：包含所有用到的组件详细配置', 'description' => '组件配置：包含所有用到的组件详细配置', 'type' => 'array', 'items' => [ 'title' => '组件具体配置', 'description' => '组件具体配置', 'type' => 'object', 'properties' => [ 'PluginConfig' => [ 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => '{}', ], 'StepType' => [ 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'input', ], 'StepName' => [ 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'description' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], 'IsDistribute' => [ 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'description' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'type' => 'boolean', 'required' => false, ], 'Key' => [ 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput', ], ], 'required' => false, ], 'required' => true, ], 'Hops' => [ 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'description' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'type' => 'array', 'items' => [ 'title' => '集成管道输入输出组件关系配置', 'description' => '集成管道输入输出组件关系配置', 'type' => 'object', 'properties' => [ 'Target' => [ 'title' => '输出步骤名称，即Steps[*].StepName', 'description' => '输出步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer', ], 'SendTo' => [ 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'description' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'type' => 'boolean', 'required' => false, ], 'Source' => [ 'title' => '输入步骤名称，即Steps[*].StepName', 'description' => '输入步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'NodeInfo' => [ 'title' => '集成管道任务基本信息', 'description' => '集成管道任务基本信息', 'type' => 'object', 'properties' => [ 'NodeName' => [ 'title' => '集成管道任务名称', 'description' => '集成管道任务名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'NodeId' => [ 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'Directory' => [ 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'description' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'type' => 'string', 'required' => false, 'example' => '/', ], ], 'required' => true, ], 'PipelineType' => [ 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'description' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Mode' => [ 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'description' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE', ], 'Submit' => [ 'title' => '是否提交，默认提交', 'description' => '是否提交，默认提交', 'type' => 'boolean', 'required' => false, ], 'PipelineJson' => [ 'title' => '脚本模式下：集成管道配置（json字符串格式）', 'description' => '脚本模式下：集成管道配置（json字符串格式）', 'type' => 'string', 'required' => false, 'example' => '{}', ], 'Settings' => [ 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'description' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '异步执行查询Id', 'description' => '异步执行查询Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '异步更新管道', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'OfflinePipelineByAsync' => [ 'summary' => '异步下线集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '下线管道任务', 'description' => '下线管道任务', 'type' => 'object', 'properties' => [ 'Delete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'required' => true, ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'NodeId' => [ 'title' => '支持使用集成任务调度节点nodeId查询', 'description' => '支持使用集成任务调度节点nodeId查询', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '支持使用集成管道主键pipelineId查询', 'description' => '支持使用集成管道主键pipelineId查询', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '支持使用集成任务文件fileId查询', 'description' => '支持使用集成任务文件fileId查询', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '异步执行查询Id', 'description' => '异步执行查询Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '异步下线管道任务', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'GetPipelineById' => [ 'summary' => '根据管道任务id查询管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'QueryId', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '用户查询管道任务的Id', 'description' => '用户查询管道任务的Id', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '支持使用集成任务调度节点nodeId查询', 'description' => '支持使用集成任务调度节点nodeId查询', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '支持使用集成管道主键pipelineId查询', 'description' => '支持使用集成管道主键pipelineId查询', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '支持使用集成任务文件fileId查询', 'description' => '支持使用集成任务文件fileId查询', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '管道任务详情', 'description' => '管道任务详情', 'type' => 'object', 'properties' => [ 'ScheduleConfig' => [ 'title' => '集成管道调度配置，json字符串，通过工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.vo.OAScheduleConfigVO进行反序列化', 'description' => '集成管道调度配置，json字符串，通过工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.vo.OAScheduleConfigVO进行反序列化', 'type' => 'string', 'example' => '{}', ], 'PipelineConfig' => [ 'title' => '集成管道组件配置', 'description' => '集成管道组件配置', 'type' => 'object', 'properties' => [ 'Steps' => [ 'title' => '组件配置：包含所有用到的组件详细配置', 'description' => '组件配置：包含所有用到的组件详细配置', 'type' => 'array', 'items' => [ 'title' => '组件具体配置', 'description' => '组件具体配置', 'type' => 'object', 'properties' => [ 'PluginConfig' => [ 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'example' => '{}', ], 'StepType' => [ 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'example' => 'input', ], 'StepName' => [ 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'description' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'type' => 'string', 'example' => 'mysql_reader', ], 'IsDistribute' => [ 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'description' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'type' => 'boolean', ], 'Key' => [ 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'example' => 'mysqlinput', ], ], ], ], 'Hops' => [ 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'description' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'type' => 'array', 'items' => [ 'title' => '集成管道输入输出组件关系配置', 'description' => '集成管道输入输出组件关系配置', 'type' => 'object', 'properties' => [ 'Target' => [ 'title' => '输出步骤名称，即Steps[*].StepName', 'description' => '输出步骤名称，即Steps[*].StepName', 'type' => 'string', 'example' => 'odps_writer', ], 'SendTo' => [ 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'description' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'type' => 'boolean', ], 'Source' => [ 'title' => '输入步骤名称，即Steps[*].StepName', 'description' => '输入步骤名称，即Steps[*].StepName', 'type' => 'string', 'example' => 'mysql_reader', ], ], ], ], ], ], 'NodeInfo' => [ 'title' => '管道任务基本信息', 'description' => '管道任务基本信息', 'type' => 'object', 'properties' => [ 'Desc' => [ 'title' => '', 'description' => '任务描述', 'type' => 'string', 'example' => 'comment', ], 'NodeName' => [ 'title' => '集成管道任务名称', 'description' => '集成管道任务名称', 'type' => 'string', 'example' => 'test', ], 'NodeId' => [ 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'string', 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'FileId' => [ 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Directory' => [ 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'description' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'type' => 'string', 'example' => '/', ], ], ], 'PipelineType' => [ 'title' => '管道任务类型', 'description' => '管道任务类型', 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'Mode' => [ 'title' => '集成管道配置模式', 'description' => '集成管道配置模式', 'type' => 'string', 'example' => 'PIPELINE', ], 'PipelineJson' => [ 'title' => '集成管道脚本模式配置', 'description' => '集成管道脚本模式配置', 'type' => 'string', 'example' => '{}', ], 'Settings' => [ 'title' => '集成管道的通道配置，json字符串,通过工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting进行反序列化', 'description' => '集成管道的通道配置，json字符串,通过工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting进行反序列化', 'type' => 'string', 'example' => '{}', ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ScheduleConfig\\": \\"{}\\",\\n \\"PipelineConfig\\": {\\n \\"Steps\\": [\\n {\\n \\"PluginConfig\\": \\"{}\\",\\n \\"StepType\\": \\"input\\",\\n \\"StepName\\": \\"mysql_reader\\",\\n \\"IsDistribute\\": true,\\n \\"Key\\": \\"mysqlinput\\"\\n }\\n ],\\n \\"Hops\\": [\\n {\\n \\"Target\\": \\"odps_writer\\",\\n \\"SendTo\\": true,\\n \\"Source\\": \\"mysql_reader\\"\\n }\\n ]\\n },\\n \\"NodeInfo\\": {\\n \\"Desc\\": \\"comment\\",\\n \\"NodeName\\": \\"test\\",\\n \\"NodeId\\": \\"n_123\\",\\n \\"PipelineId\\": 123,\\n \\"FileId\\": 123,\\n \\"Directory\\": \\"/\\"\\n },\\n \\"PipelineType\\": 123,\\n \\"Mode\\": \\"PIPELINE\\",\\n \\"PipelineJson\\": \\"{}\\",\\n \\"Settings\\": \\"{}\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '根据ID查询管道任务', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'OfflinePipeline' => [ 'summary' => '下线集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '下线管道任务', 'description' => '下线管道任务', 'type' => 'object', 'properties' => [ 'Delete' => [ 'title' => '是否删除', 'description' => '是否删除', 'type' => 'boolean', 'required' => true, ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'NodeId' => [ 'title' => '支持使用集成任务调度节点nodeId查询', 'description' => '支持使用集成任务调度节点nodeId查询，pipelineId、fileId、nodeId设置任意一个即可', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '支持使用集成管道主键pipelineId查询', 'description' => '支持使用集成管道主键pipelineId查询，pipelineId、fileId、nodeId设置任意一个即可', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '支持使用集成任务文件fileId查询', 'description' => '支持使用集成任务文件fileId查询，pipelineId、fileId、nodeId设置任意一个即可', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '管道下线结果', 'description' => '管道下线结果', 'type' => 'object', 'properties' => [ 'SubmitId' => [ 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'description' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'HostMachine' => [ 'title' => '服务端执行机器名称和ip', 'description' => '服务端执行机器名称和ip', 'type' => 'string', 'example' => 'hostName:hostIp', ], 'Version' => [ 'title' => '提交后生成的版本号', 'description' => '提交后生成的版本号', 'type' => 'string', 'example' => '1', ], 'NodeId' => [ 'title' => '创建成功后的管道任务调度节点Id', 'description' => '创建成功后的管道任务调度节点Id', 'type' => 'string', 'example' => '123', ], 'PipelineId' => [ 'title' => '创建成功后的管道ID', 'description' => '创建成功后的管道ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SubmitId\\": 123,\\n \\"HostMachine\\": \\"hostName:hostIp\\",\\n \\"Version\\": \\"1\\",\\n \\"NodeId\\": \\"123\\",\\n \\"PipelineId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '下线管道任务', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'CreatePipeline' => [ 'summary' => '创建集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建管道任务配置', 'description' => '创建管道任务配置', 'type' => 'object', 'properties' => [ 'ScheduleConfig' => [ 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'description' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}', ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'PipelineConfig' => [ 'title' => '集成管道组件配置', 'description' => '集成管道组件配置', 'type' => 'object', 'properties' => [ 'Steps' => [ 'title' => '组件配置：包含所有用到的组件详细配置', 'description' => '组件配置：包含所有用到的组件详细配置', 'type' => 'array', 'items' => [ 'title' => '组件具体配置', 'description' => '组件具体配置', 'type' => 'object', 'properties' => [ 'PluginConfig' => [ 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => '{}', ], 'StepType' => [ 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'input', ], 'StepName' => [ 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'description' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], 'IsDistribute' => [ 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'description' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'type' => 'boolean', 'required' => false, ], 'Key' => [ 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput', ], ], 'required' => false, ], 'required' => true, ], 'Hops' => [ 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'description' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'type' => 'array', 'items' => [ 'title' => '集成管道输入输出组件关系配置', 'description' => '集成管道输入输出组件关系配置', 'type' => 'object', 'properties' => [ 'Target' => [ 'title' => '输出步骤名称，即Steps[*].StepName', 'description' => '输出步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer', ], 'SendTo' => [ 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'description' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'type' => 'boolean', 'required' => false, ], 'Source' => [ 'title' => '输入步骤名称，即Steps[*].StepName', 'description' => '输入步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'NodeInfo' => [ 'title' => '集成管道任务基本信息', 'description' => '集成管道任务基本信息', 'type' => 'object', 'properties' => [ 'NodeName' => [ 'title' => '集成管道任务名称', 'description' => '集成管道任务名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'NodeId' => [ 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'Directory' => [ 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'description' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'type' => 'string', 'required' => false, 'example' => '/', ], ], 'required' => true, ], 'PipelineType' => [ 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'description' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Mode' => [ 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'description' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE', ], 'Submit' => [ 'title' => '是否提交，默认提交', 'description' => '是否提交，默认提交', 'type' => 'boolean', 'required' => false, ], 'PipelineJson' => [ 'title' => '脚本模式下：集成管道配置（json字符串格式）', 'description' => '脚本模式下：集成管道配置（json字符串格式）', 'type' => 'string', 'required' => false, 'example' => '{}', ], 'Settings' => [ 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'description' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '集成管道任务创建结果', 'description' => '集成管道任务创建结果', 'type' => 'object', 'properties' => [ 'SubmitId' => [ 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'description' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'HostMachine' => [ 'title' => '服务端执行机器名称和ip', 'description' => '服务端执行机器名称和ip', 'type' => 'string', 'example' => 'hostName:hostIp', ], 'Version' => [ 'title' => '提交后生成的版本号', 'description' => '提交后生成的版本号', 'type' => 'string', 'example' => '1', ], 'NodeId' => [ 'title' => '创建成功后的管道任务调度节点Id', 'description' => '创建成功后的管道任务调度节点Id', 'type' => 'string', 'example' => '123', ], 'PipelineId' => [ 'title' => '创建成功后的管道ID', 'description' => '创建成功后的管道ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SubmitId\\": 123,\\n \\"HostMachine\\": \\"hostName:hostIp\\",\\n \\"Version\\": \\"1\\",\\n \\"NodeId\\": \\"123\\",\\n \\"PipelineId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '创建集成管道任务', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'GetPipelineAsyncResult' => [ 'summary' => '查询异步操作管道任务的执行结果。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'AsyncId', 'in' => 'query', 'schema' => [ 'title' => '异步执行Id', 'description' => '异步执行Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '异步执行结果', 'description' => '异步执行结果', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '当前执行状态：SUCCESS-执行成功，FAILED-执行失败，RUNNING-执行中', 'description' => '当前执行状态：SUCCESS-执行成功，FAILED-执行失败，RUNNING-执行中', 'type' => 'string', 'example' => 'SUCCESS', ], 'SubmitId' => [ 'title' => '管道任务提交后的带发布ID，通过发布域进行发布', 'description' => '管道任务提交后的带发布ID，通过发布域进行发布', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'HostMachine' => [ 'title' => '执行请求的服务端主机信息', 'description' => '执行请求的服务端主机信息', 'type' => 'string', 'example' => 'hostName:hostIp', ], 'Version' => [ 'title' => '管道任务提交生成的版本号', 'description' => '管道任务提交生成的版本号', 'type' => 'string', 'example' => '1', ], 'NodeId' => [ 'title' => '管道任务调度节点ID', 'description' => '管道任务调度节点ID', 'type' => 'string', 'example' => 'n_123', ], 'AsyncId' => [ 'title' => '异步执行查询Id', 'description' => '异步执行查询Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'PipelineId' => [ 'title' => '管道主键ID', 'description' => '管道主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'ErrorCode' => [ 'title' => '执行异常时异常码', 'description' => '执行异常时异常码', 'type' => 'string', 'example' => 'DPN.Pipeline.InnerError', ], 'ErrorMessage' => [ 'title' => '执行异常时异常信息', 'description' => '执行异常时异常信息', 'type' => 'string', 'example' => 'NullPointException', ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubmitId\\": 123,\\n \\"HostMachine\\": \\"hostName:hostIp\\",\\n \\"Version\\": \\"1\\",\\n \\"NodeId\\": \\"n_123\\",\\n \\"AsyncId\\": 123,\\n \\"PipelineId\\": 123,\\n \\"ErrorCode\\": \\"DPN.Pipeline.InnerError\\",\\n \\"ErrorMessage\\": \\"NullPointException\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询异步执行结果', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'CreatePipelineByAsync' => [ 'summary' => '异步创建集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建管道任务配置', 'description' => '创建管道任务配置', 'type' => 'object', 'properties' => [ 'ScheduleConfig' => [ 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'description' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}', ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'PipelineConfig' => [ 'title' => '集成管道组件配置', 'description' => '集成管道组件配置', 'type' => 'object', 'properties' => [ 'Steps' => [ 'title' => '组件配置：包含所有用到的组件详细配置', 'description' => '组件配置：包含所有用到的组件详细配置', 'type' => 'array', 'items' => [ 'title' => '组件具体配置', 'description' => '组件具体配置', 'type' => 'object', 'properties' => [ 'PluginConfig' => [ 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => '{}', ], 'StepType' => [ 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'input', ], 'StepName' => [ 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'description' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], 'IsDistribute' => [ 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'description' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'type' => 'boolean', 'required' => false, ], 'Key' => [ 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput', ], ], 'required' => false, ], 'required' => true, ], 'Hops' => [ 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'description' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'type' => 'array', 'items' => [ 'title' => '集成管道输入输出组件关系配置', 'description' => '集成管道输入输出组件关系配置', 'type' => 'object', 'properties' => [ 'Target' => [ 'title' => '输出步骤名称，即Steps[*].StepName', 'description' => '输出步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer', ], 'SendTo' => [ 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'description' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'type' => 'boolean', 'required' => false, ], 'Source' => [ 'title' => '输入步骤名称，即Steps[*].StepName', 'description' => '输入步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'NodeInfo' => [ 'title' => '集成管道任务基本信息', 'description' => '集成管道任务基本信息', 'type' => 'object', 'properties' => [ 'NodeName' => [ 'title' => '集成管道任务名称', 'description' => '集成管道任务名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'NodeId' => [ 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'Directory' => [ 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'description' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'type' => 'string', 'required' => false, 'example' => '/', ], ], 'required' => true, ], 'PipelineType' => [ 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'description' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Mode' => [ 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'description' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE', ], 'Submit' => [ 'title' => '是否提交，默认提交', 'description' => '是否提交，默认提交', 'type' => 'boolean', 'required' => false, ], 'PipelineJson' => [ 'title' => '脚本模式下：集成管道配置（json字符串格式）', 'description' => '脚本模式下：集成管道配置（json字符串格式）', 'type' => 'string', 'required' => false, 'example' => '{}', ], 'Settings' => [ 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'description' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '异步执行查询Id', 'description' => '异步执行查询Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '异步创建管道', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'UpdatePipeline' => [ 'summary' => '更新集成管道任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Context', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '请求上下文信息', 'description' => '请求上下文信息', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '集成管道任务所属项目ID', 'description' => '集成管道任务所属项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'Env' => [ 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'description' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], 'required' => true, ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新管道任务配置', 'description' => '更新管道任务配置', 'type' => 'object', 'properties' => [ 'ScheduleConfig' => [ 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'description' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}', ], 'Comment' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'comment', ], 'PipelineConfig' => [ 'title' => '集成管道组件配置', 'description' => '集成管道组件配置', 'type' => 'object', 'properties' => [ 'Steps' => [ 'title' => '组件配置：包含所有用到的组件详细配置', 'description' => '组件配置：包含所有用到的组件详细配置', 'type' => 'array', 'items' => [ 'title' => '组件具体配置', 'description' => '组件具体配置', 'type' => 'object', 'properties' => [ 'PluginConfig' => [ 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => '{}', ], 'StepType' => [ 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'input', ], 'StepName' => [ 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'description' => '步骤名称，在同一个管道任务所有步骤名称不能重复', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], 'IsDistribute' => [ 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'description' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', 'type' => 'boolean', 'required' => false, ], 'Key' => [ 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'description' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput', ], ], 'required' => false, ], 'required' => true, ], 'Hops' => [ 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'description' => 'DAG有向无环图链接配置：描述所有组件的连接关系', 'type' => 'array', 'items' => [ 'title' => '集成管道输入输出组件关系配置', 'description' => '集成管道输入输出组件关系配置', 'type' => 'object', 'properties' => [ 'Target' => [ 'title' => '输出步骤名称，即Steps[*].StepName', 'description' => '输出步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer', ], 'SendTo' => [ 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'description' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', 'type' => 'boolean', 'required' => false, ], 'Source' => [ 'title' => '输入步骤名称，即Steps[*].StepName', 'description' => '输入步骤名称，即Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'NodeInfo' => [ 'title' => '集成管道任务基本信息', 'description' => '集成管道任务基本信息', 'type' => 'object', 'properties' => [ 'NodeName' => [ 'title' => '集成管道任务名称', 'description' => '集成管道任务名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'NodeId' => [ 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'string', 'required' => false, 'example' => 'n_123', ], 'PipelineId' => [ 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'FileId' => [ 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'description' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'Directory' => [ 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'description' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', 'type' => 'string', 'required' => false, 'example' => '/', ], ], 'required' => true, ], 'PipelineType' => [ 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'description' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Mode' => [ 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'description' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE', ], 'Submit' => [ 'title' => '是否提交，默认提交', 'description' => '是否提交，默认提交', 'type' => 'boolean', 'required' => false, ], 'PipelineJson' => [ 'title' => '脚本模式下：集成管道配置（json字符串格式）', 'description' => '脚本模式下：集成管道配置（json字符串格式）', 'type' => 'string', 'required' => false, 'example' => '{}', ], 'Settings' => [ 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'description' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => '管道任务更新结果', 'description' => '管道任务更新结果', 'type' => 'object', 'properties' => [ 'SubmitId' => [ 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'description' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'HostMachine' => [ 'title' => '服务端执行机器名称和ip', 'description' => '服务端执行机器名称和ip', 'type' => 'string', 'example' => 'hostName:hostIp', ], 'Version' => [ 'title' => '提交后生成的版本号', 'description' => '提交后生成的版本号', 'type' => 'string', 'example' => '1', ], 'NodeId' => [ 'title' => '创建成功后的管道任务调度节点Id', 'description' => '创建成功后的管道任务调度节点Id', 'type' => 'string', 'example' => '123', ], 'PipelineId' => [ 'title' => '创建成功后的管道ID', 'description' => '创建成功后的管道ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SubmitId\\": 123,\\n \\"HostMachine\\": \\"hostName:hostIp\\",\\n \\"Version\\": \\"1\\",\\n \\"NodeId\\": \\"123\\",\\n \\"PipelineId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '更新管道任务', 'extraInfo' => '使用详情请参考辅助工具包中的demo：com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', ], 'CreatePipelineNode' => [ 'summary' => '创建数据集成任务。备注：从dataphin v5.3.1版本开始不建议使用，请使用CreatePipeline。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreatePipelineNodeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建pipeline管道,支持离线管道和实时管道', 'description' => '创建pipeline管道,支持离线管道和实时管道', 'type' => 'object', 'properties' => [ 'PipelineName' => [ 'title' => '管道名称', 'description' => '管道名称', 'type' => 'string', 'required' => true, 'example' => 'test_pipeline', ], 'PipelineType' => [ 'title' => '管道类型[OFFLINE_PIPELINE,REAL_TIME_PIPELINE]', 'description' => '管道类型[OFFLINE_PIPELINE,REAL_TIME_PIPELINE]', 'type' => 'string', 'required' => true, 'example' => 'REAL_TIME_PIPELINE', 'enum' => [ 'OFFLINE_PIPELINE', 'REAL_TIME_PIPELINE', ], ], 'NodeType' => [ 'title' => '管道类型[NORMAL,MANUAL,REAL_TIME]', 'description' => '管道类型[NORMAL,MANUAL,REAL_TIME]', 'type' => 'string', 'required' => true, 'example' => 'REAL_TIME', 'enum' => [ 'NORMAL', 'MANUAL', 'REAL_TIME', ], ], 'FileInfo' => [ 'title' => '任务文件信息', 'description' => '任务文件信息', 'type' => 'object', 'properties' => [ 'FileName' => [ 'title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'required' => true, 'example' => 'test_pipeline', ], 'Directory' => [ 'title' => '文件父目录全路径(为空，则为根路径\'/\')', 'description' => '文件父目录全路径(为空，则为根路径\'/\')', 'type' => 'string', 'required' => false, 'example' => 'test', 'default' => '/', ], 'Description' => [ 'title' => '文件描述', 'description' => '文件描述', 'type' => 'string', 'required' => false, 'example' => 'desc', ], ], 'required' => true, ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7091124176569088', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '管道节点信息', 'description' => '管道节点信息', 'type' => 'object', 'properties' => [ 'PipelineId' => [ 'title' => '创建成功后的管道ID', 'description' => '创建成功后的管道ID', 'type' => 'integer', 'format' => 'int64', 'example' => '33749', ], 'ErrorCodeList' => [ 'title' => '错误码', 'description' => '错误码', 'type' => 'array', 'items' => [ 'title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DPN.Pipeline.Config.ErrorReason', ], ], 'ErrorMessageList' => [ 'title' => '异常信息', 'description' => '异常信息', 'type' => 'array', 'items' => [ 'title' => '异常消息', 'description' => '异常消息', 'type' => 'string', 'example' => '管道配置错误：{0}', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"PipelineId\\": 33749,\\n \\"ErrorCodeList\\": [\\n \\"DPN.Pipeline.Config.ErrorReason\\"\\n ],\\n \\"ErrorMessageList\\": [\\n \\"管道配置错误：{0}\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建数据集成管道任务', ], 'UpdateBatchTaskUdfLineages' => [ 'summary' => '编辑离线计算任务自定义血缘。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑指令', 'description' => '编辑指令', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], 'LineageGroupList' => [ 'title' => '血缘组列表', 'description' => '血缘组列表', 'type' => 'array', 'items' => [ 'title' => '血缘组', 'description' => '血缘组', 'type' => 'object', 'properties' => [ 'InputLineageList' => [ 'title' => '血缘输入表集合', 'description' => '血缘输入表集合', 'type' => 'array', 'items' => [ 'title' => '血缘表', 'description' => '血缘表', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'required' => true, 'example' => 't_input', ], 'Env' => [ 'title' => '环境 prod/dev/auto', 'description' => '环境 prod/dev/auto', 'type' => 'string', 'required' => true, 'example' => 'dev', ], 'FullTable' => [ 'title' => '是否选择全表', 'description' => '是否选择全表', 'type' => 'boolean', 'required' => true, ], 'ColumnList' => [ 'title' => '血缘字段列表', 'description' => '血缘字段列表', 'type' => 'array', 'items' => [ 'title' => '血缘相关字段集合: 跟FullTable二选一，默认全表', 'description' => '血缘相关字段集合: 跟FullTable二选一，默认全表', 'type' => 'string', 'required' => true, 'example' => 'column1', ], 'required' => true, ], ], 'required' => true, ], 'required' => true, ], 'OutputLineageList' => [ 'title' => '血缘输出表集合', 'description' => '血缘输出表集合', 'type' => 'array', 'items' => [ 'title' => '血缘表', 'description' => '血缘表', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'required' => true, 'example' => 't_output', ], 'Env' => [ 'title' => '环境 prod/dev/auto', 'description' => '环境 prod/dev/auto', 'type' => 'string', 'required' => true, 'example' => 'dev', ], 'FullTable' => [ 'title' => '是否选择全表', 'description' => '是否选择全表', 'type' => 'boolean', 'required' => true, ], 'ColumnList' => [ 'title' => '血缘字段列表', 'description' => '血缘字段列表', 'type' => 'array', 'items' => [ 'title' => '血缘相关字段集合: 跟FullTable二选一，默认全表', 'description' => '血缘相关字段集合: 跟FullTable二选一，默认全表', 'type' => 'string', 'required' => true, 'example' => 'column1', ], 'required' => true, ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '更新离线计算任务自定义血缘', ], 'UpdateBatchTask' => [ 'summary' => '编辑离线计算任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑请求', 'description' => '编辑请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '任务所属项目Id', 'description' => '任务所属项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101', ], 'Name' => [ 'title' => '离线任务名', 'description' => '离线任务名', 'type' => 'string', 'required' => true, 'example' => 'test111', ], 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], 'NodeOutputNameList' => [ 'title' => '节点输出名列表', 'description' => '节点输出名列表', 'type' => 'array', 'items' => [ 'title' => '节点输出名', 'description' => '节点输出名', 'type' => 'string', 'required' => true, 'example' => 'test1011', ], 'required' => false, ], 'NodeDescription' => [ 'title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Engine' => [ 'title' => '任务执行引擎: PYTHON2_7,PYTHON3_7,PYTHON3_11', 'description' => '任务执行引擎，如Python任务'."\n" .'- 1. PYTHON2_7'."\n" .'- 2. PYTHON3_7'."\n" .'- 3. PYTHON3_11', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7', ], 'SchedulePeriod' => [ 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', 'description' => '调度周期'."\n" .'- 年：YEARLY'."\n" .'- 月：MONTHLY'."\n" .'- 周：WEEKLY'."\n" .'- 日：DAILY'."\n" .'- 小时：HOURLY'."\n" .'- 分钟：MINUTELY', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'CronExpression' => [ 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', 'description' => '自动调度的cron表达式, 可参考Linux cron表达式', 'type' => 'string', 'required' => false, 'example' => '0 0 1 * * ?', ], 'CustomScheduleConfig' => [ 'title' => '自定义调度间隔配置', 'description' => '自定义调度间隔配置', 'type' => 'object', 'properties' => [ 'SchedulePeriod' => [ 'title' => '调度周期', 'description' => '调度周期'."\n" .'- 年 YEARLY'."\n" .'- 月 MONTHLY'."\n" .'- 周 WEEKLY'."\n" .'- 日 DAILY'."\n" .'- 小时 HOURLY'."\n" .'- 分钟 MINUTELY', 'type' => 'string', 'required' => true, 'example' => 'DAILY', ], 'Interval' => [ 'title' => '自定义间隔', 'description' => '自定义间隔', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'IntervalUnit' => [ 'title' => '间隔单位：MINUTE、HOUR', 'description' => '间隔单位'."\n" .'- MINUTE:分钟'."\n" .'- HOUR:小时', 'type' => 'string', 'required' => true, 'example' => 'HOUR', ], 'StartTime' => [ 'title' => '开始时间: HH:mm', 'description' => '开始时间: HH:mm', 'type' => 'string', 'required' => true, 'example' => '08:00', ], 'EndTime' => [ 'title' => '结束时间: HH:mm', 'description' => '结束时间: HH:mm', 'type' => 'string', 'required' => true, 'example' => '20:59', ], ], 'required' => false, ], 'Code' => [ 'title' => '任务代码', 'description' => '任务代码', 'type' => 'string', 'required' => true, 'example' => 'show tables;', ], 'ParamList' => [ 'title' => '运行参数列表', 'description' => '自定义参数列表', 'type' => 'array', 'items' => [ 'title' => '运行参数', 'description' => '运行参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '运行参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => true, 'example' => 'key', ], 'Value' => [ 'title' => '运行参数值', 'description' => '参数值', 'type' => 'string', 'required' => true, 'example' => 'value', ], ], 'required' => true, ], 'required' => false, ], 'Priority' => [ 'title' => '任务调度优先级, 1-9值越大表示优先级越低', 'description' => '任务调度优先级, 1-9值越大表示优先级越低', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NodeStatus' => [ 'title' => '节点状态: 正常 1、暂停 2、空跑 3', 'description' => '节点状态: 正常 1、暂停 2、空跑 3', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'TaskType' => [ 'title' => '任务类型: Hive_SQL: 1、MaxCompute_SQL: 5、Shell 10、Python 21', 'description' => '任务类型: Hive_SQL: 1、MaxCompute_SQL: 5、Shell 10、Python 21', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '21', ], 'UpStreamList' => [ 'title' => '上游依赖', 'description' => '上游依赖', 'type' => 'array', 'items' => [ 'title' => '节点关联', 'description' => '节点关联', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', 'description' => '上游依赖节点类型'."\n" .'- PHYSICAL：物理节点'."\n" .'- LOGICAL：逻辑表依赖', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL', ], 'SourceNodeId' => [ 'title' => '上游节点Id', 'description' => '上游节点Id', 'type' => 'string', 'required' => false, 'example' => 'n_2001', ], 'SourceNodeOutputName' => [ 'title' => '上游节点的输出名称', 'description' => '上游节点的输出名称', 'type' => 'string', 'required' => true, 'example' => 't_input1', ], 'SourceTableName' => [ 'title' => '输入表名称', 'description' => '输入表名称', 'type' => 'string', 'required' => false, 'example' => 't_input1', ], 'PeriodDiff' => [ 'title' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'description' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'FieldList' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'array', 'items' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'required' => false, ], 'DependPeriod' => [ 'title' => '依赖周期', 'description' => '依赖周期', 'type' => 'object', 'properties' => [ 'PeriodType' => [ 'title' => '依赖周期类型 CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', 'description' => '依赖周期类型'."\n" .'- CURRENT_PERIOD:本周期'."\n" .'- LAST_PERIOD:上周期'."\n" .'- LAST_N_PERIOD:最近N日'."\n" .'- LAST_24_HOUR:最近24小时', 'type' => 'string', 'required' => true, 'example' => 'CURRENT_PERIOD', ], 'PeriodOffset' => [ 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', 'description' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'DependStrategy' => [ 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', 'description' => '依赖策略'."\n" .'- ALL:全部'."\n" .'- FIRST:第一个'."\n" .'- LAST:最后一个'."\n" .'- NEAR:最近一个', 'type' => 'string', 'required' => false, 'example' => 'LAST', ], 'SourceNodeEnabled' => [ 'title' => '上游节点是否生效', 'description' => '上游节点是否生效', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], 'required' => false, ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'string', 'required' => false, 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'erp', ], 'PythonModuleList' => [ 'title' => '任务依赖python三方包', 'description' => '任务依赖python三方包', 'type' => 'array', 'items' => [ 'title' => 'python三方包', 'description' => 'python三方包', 'type' => 'string', 'required' => true, 'example' => 'numpy', ], 'required' => false, ], 'SparkClientInfo' => [ 'title' => 'spark客户端', 'description' => 'spark客户端', 'type' => 'object', 'properties' => [ 'SparkClientVersion' => [ 'title' => 'spark客户端版本名称', 'description' => 'spark客户端版本名称', 'type' => 'string', 'required' => true, 'example' => 'abc', ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'UpdateResult' => [ 'title' => '编辑结果', 'description' => '编辑结果', 'type' => 'object', 'properties' => [ 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"UpdateResult\\": {\\n \\"FileId\\": 12113111\\n }\\n}","type":"json"}]', 'title' => '更新离线计算任务', ], 'SubmitBatchTask' => [ 'summary' => '提交离线计算任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑请求', 'description' => '编辑请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '任务所属项目Id', 'description' => '任务所属项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101', ], 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], 'Comment' => [ 'title' => '提交操作备注', 'description' => '提交操作备注', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Name' => [ 'title' => '离线任务名', 'description' => '离线任务名', 'type' => 'string', 'required' => true, 'example' => 'test111', ], 'NodeOutputNameList' => [ 'title' => '节点输出名列表', 'description' => '节点输出名列表', 'type' => 'array', 'items' => [ 'title' => '节点输出名', 'description' => '节点输出名', 'type' => 'string', 'required' => true, 'example' => 'test1011', ], 'required' => false, ], 'NodeDescription' => [ 'title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'Engine' => [ 'title' => '任务执行引擎: PYTHON2_7,PYTHON3_7,PYTHON3_11', 'description' => '任务执行引擎，如Python任务：'."\n" .'- PYTHON2_7'."\n" .'- PYTHON3_7'."\n" .'- PYTHON3_11', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7', ], 'SchedulePeriod' => [ 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', 'description' => '调度周期'."\n" .'- 年：YEARLY'."\n" .'- 月：MONTHLY'."\n" .'- 周：WEEKLY'."\n" .'- 日：DAILY'."\n" .'- 小时：HOURLY'."\n" .'- 分钟：MINUTELY', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'CronExpression' => [ 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', 'description' => '自动调度的cron表达式, 可参考Linux cron表达式', 'type' => 'string', 'required' => false, 'example' => '0 0 1 * * ?', ], 'CustomScheduleConfig' => [ 'title' => '自定义调度间隔配置', 'description' => '自定义调度间隔配置', 'type' => 'object', 'properties' => [ 'SchedulePeriod' => [ 'title' => '调度周期', 'description' => '调度周期'."\n" .'- 年 YEARLY'."\n" .'- 月 MONTHLY'."\n" .'- 周 WEEKLY'."\n" .'- 日 DAILY'."\n" .'- 小时 HOURLY'."\n" .'- 分钟 MINUTELY', 'type' => 'string', 'required' => true, 'example' => 'DAILY', ], 'Interval' => [ 'title' => '自定义间隔', 'description' => '自定义间隔', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'IntervalUnit' => [ 'title' => '间隔单位：MINUTE、HOUR', 'description' => '间隔单位'."\n" .'- MINUTE:分钟'."\n" .'- HOUR:小时', 'type' => 'string', 'required' => true, 'example' => 'HOUR', ], 'StartTime' => [ 'title' => '开始时间: HH:mm', 'description' => '开始时间: HH:mm', 'type' => 'string', 'required' => true, 'example' => '10:00', ], 'EndTime' => [ 'title' => '结束时间: HH:mm', 'description' => '结束时间: HH:mm', 'type' => 'string', 'required' => true, 'example' => '10:00', ], ], 'required' => false, ], 'Code' => [ 'title' => '任务代码', 'description' => '任务代码', 'type' => 'string', 'required' => true, 'example' => 'show tables;', ], 'ParamList' => [ 'title' => '运行参数列表', 'description' => '自定义参数列表', 'type' => 'array', 'items' => [ 'title' => '运行参数', 'description' => '运行参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '运行参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => true, 'example' => 'key', ], 'Value' => [ 'title' => '运行参数值', 'description' => '参数值', 'type' => 'string', 'required' => true, 'example' => 'key', ], ], 'required' => true, ], 'required' => false, ], 'Priority' => [ 'title' => '任务调度优先级, 1-9值越大表示优先级越低', 'description' => '任务调度优先级, 1-9值越大表示优先级越低', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NodeStatus' => [ 'title' => '节点状态: 正常 1、暂停 2、空跑 3', 'description' => '节点状态: 正常 1、暂停 2、空跑 3', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'UpStreamList' => [ 'title' => '上游依赖', 'description' => '上游依赖', 'type' => 'array', 'items' => [ 'title' => '节点关联', 'description' => '节点关联', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', 'description' => '上游依赖节点类型'."\n" .'- PHYSICAL：物理节点'."\n" .'- LOGICAL：逻辑表依赖', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL', ], 'SourceNodeId' => [ 'title' => '上游节点Id', 'description' => '上游节点Id', 'type' => 'string', 'required' => false, 'example' => 'n_2001', ], 'SourceNodeOutputName' => [ 'title' => '上游节点的输出名称', 'description' => '上游节点的输出名称', 'type' => 'string', 'required' => true, 'example' => 't_input1', ], 'SourceTableName' => [ 'title' => '输入表名称', 'description' => '输入表名称', 'type' => 'string', 'required' => false, 'example' => 't_input1', ], 'PeriodDiff' => [ 'title' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'description' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'FieldList' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'array', 'items' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'required' => false, ], 'SourceNodeEnabled' => [ 'title' => '上游节点是否生效', 'description' => '上游节点是否生效', 'type' => 'boolean', 'required' => false, ], 'DependStrategy' => [ 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', 'description' => '依赖策略'."\n" .'- ALL:全部'."\n" .'- FIRST:第一个'."\n" .'- LAST:最后一个'."\n" .'- NEAR:最近一个', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'DependPeriod' => [ 'title' => '依赖周期', 'description' => '依赖周期', 'type' => 'object', 'properties' => [ 'PeriodType' => [ 'title' => '依赖周期类型 CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', 'description' => '依赖周期类型'."\n" .'- CURRENT_PERIOD:本周期'."\n" .'- LAST_PERIOD:上周期'."\n" .'- LAST_N_PERIOD:最近N日'."\n" .'- LAST_24_HOUR:最近24小时', 'type' => 'string', 'required' => true, 'example' => 'CURRENT_PERIOD', ], 'PeriodOffset' => [ 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', 'description' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], ], 'required' => true, ], 'required' => false, ], 'PythonModuleList' => [ 'title' => '任务依赖python三方包', 'description' => '任务依赖python三方包', 'type' => 'array', 'items' => [ 'title' => 'python三方包', 'description' => 'python三方包', 'type' => 'string', 'required' => true, 'example' => 'numpy', ], 'required' => false, ], 'SparkClientInfo' => [ 'title' => 'spark客户端', 'description' => 'spark客户端', 'type' => 'object', 'properties' => [ 'SparkClientVersion' => [ 'title' => 'spark客户端版本名称', 'description' => 'spark客户端版本名称', 'type' => 'string', 'required' => true, 'example' => 'abc', ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'SubmitResult' => [ 'title' => '编辑结果', 'description' => '编辑结果', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '任务调度节点ID', 'description' => '任务调度节点ID', 'type' => 'string', 'example' => 'n_12113111', ], 'SubmitId' => [ 'title' => '待发布对象Id', 'description' => '待发布对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1010312911', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitResult\\": {\\n \\"NodeId\\": \\"n_12113111\\",\\n \\"SubmitId\\": 1010312911\\n }\\n}","type":"json"}]', 'title' => '提交离线计算任务', ], 'ParseBatchTaskDependency' => [ 'summary' => '解析离线计算任务的逻辑表依赖，注意解析结果上游依赖信息中可能包含自依赖节点（上游节点ID和解析代码的任务节点ID相同）需要用户自己进行处理。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ParseCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '解析请求', 'description' => '解析请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], 'Code' => [ 'title' => '待解析的SQL代码', 'description' => '待解析的SQL代码', 'type' => 'string', 'required' => true, 'example' => 'select * from t_test limit 1;', ], 'IncludeAllInputTables' => [ 'title' => '包含未找到对应节点的输入表的依赖信息, 默认 false', 'description' => '包含未找到对应节点的输入表的依赖信息, 默认 false', 'type' => 'boolean', 'required' => false, ], 'NeedQueryLineages' => [ 'title' => '查询上游依赖时是否查询血缘数据, 默认 false', 'description' => '查询上游依赖时是否查询血缘数据, 默认 false', 'type' => 'boolean', 'required' => false, ], 'OperatorType' => [ 'title' => '任务类型: MAX_COMPUTE_SQL等', 'description' => '任务类型: MAX_COMPUTE_SQL等', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL', ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'erp', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ParseResult' => [ 'title' => '解析结果', 'description' => '解析结果', 'type' => 'object', 'properties' => [ 'DependNodeList' => [ 'title' => '依赖节点', 'description' => '依赖节点', 'type' => 'array', 'items' => [ 'title' => '依赖节点', 'description' => '依赖节点', 'type' => 'object', 'properties' => [ 'NodeIoType' => [ 'title' => '输入输出类型: 依赖节点 input、节点输出名 output', 'description' => '输入输出类型: 依赖节点 input、节点输出名 output', 'type' => 'string', 'example' => 'input', ], 'ScheduleNodeInfoList' => [ 'title' => '调度节点列表', 'description' => '调度节点列表', 'type' => 'array', 'items' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'TableName' => [ 'title' => '节点输出表名', 'description' => '节点输出表名', 'type' => 'string', 'example' => 't_test', ], 'OutputName' => [ 'title' => '节点输出名', 'description' => '节点输出名', 'type' => 'string', 'example' => 't_test', ], 'FieldList' => [ 'title' => '字段列表，仅适用于逻辑表依赖', 'description' => '字段列表，仅适用于逻辑表依赖', 'type' => 'array', 'items' => [ 'title' => '字段', 'description' => '字段', 'type' => 'string', 'example' => 'column1', ], ], 'OwnerUserId' => [ 'title' => '节点owner, 当未找到对应输入表的节点时为空', 'description' => '节点owner, 当未找到对应输入表的节点时为空', 'type' => 'string', 'example' => '201122301', ], 'OwnerName' => [ 'title' => '节点owner, 当未找到对应输入表的节点时为空', 'description' => '节点owner, 当未找到对应输入表的节点时为空', 'type' => 'string', 'example' => '张三', ], 'NodeId' => [ 'title' => '节点名称, 当未找到对应输入表的节点时为-1', 'description' => '节点名称, 当未找到对应输入表的节点时为-1', 'type' => 'string', 'example' => 'n_11013121', ], 'NodeName' => [ 'title' => '节点名称, 当未找到对应输入表的节点时为空', 'description' => '节点名称, 当未找到对应输入表的节点时为空', 'type' => 'string', 'example' => 'test11', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ParseResult\\": {\\n \\"DependNodeList\\": [\\n {\\n \\"NodeIoType\\": \\"input\\",\\n \\"ScheduleNodeInfoList\\": [\\n {\\n \\"TableName\\": \\"t_test\\",\\n \\"OutputName\\": \\"t_test\\",\\n \\"FieldList\\": [\\n \\"column1\\"\\n ],\\n \\"OwnerUserId\\": \\"201122301\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"NodeId\\": \\"n_11013121\\",\\n \\"NodeName\\": \\"test11\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '解析离线计算任务的逻辑表依赖', ], 'OfflineBatchTask' => [ 'summary' => '下线离线计算任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'title' => '下线操作备注', 'description' => '下线操作备注', 'type' => 'string', 'required' => true, 'example' => 'test xx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'OfflineResult' => [ 'title' => '下线结果', 'description' => '下线结果', 'type' => 'object', 'properties' => [ 'PublishObjectId' => [ 'title' => '待发布对象ID', 'description' => '待发布对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10211123', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"OfflineResult\\": {\\n \\"PublishObjectId\\": 10211123\\n }\\n}","type":"json"}]', 'title' => '下线离线计算任务', ], 'GetBatchTaskUdfLineages' => [ 'summary' => '获取离线任务自定义血缘。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'object', 'properties' => [ 'LineageGroupList' => [ 'title' => '血缘组列表', 'description' => '血缘组列表', 'type' => 'array', 'items' => [ 'title' => '血缘组', 'description' => '血缘组', 'type' => 'object', 'properties' => [ 'InputLineageList' => [ 'title' => '血缘输入表集合', 'description' => '血缘输入表集合', 'type' => 'array', 'items' => [ 'title' => '血缘表', 'description' => '血缘表', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_input', ], 'DisplayName' => [ 'title' => '表显示名', 'description' => '表显示名', 'type' => 'string', 'example' => 't_input', ], 'Guid' => [ 'title' => '全局Id', 'description' => '全局Id', 'type' => 'string', 'example' => 'Guid_101121', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test xx', ], 'OwnerName' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'example' => '张三', ], 'OwnerUserId' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'example' => '20112101', ], 'ProjectName' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'string', 'example' => 'prj_test', ], 'ProjectId' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'string', 'example' => '131211211', ], 'BizUnitId' => [ 'title' => '板块ID', 'description' => '板块ID', 'type' => 'string', 'example' => '103111231', ], 'BizUnitName' => [ 'title' => '板块名称', 'description' => '板块名称', 'type' => 'string', 'example' => 'xx测试', ], 'Env' => [ 'title' => '环境 prod/dev', 'description' => '环境 prod/dev', 'type' => 'string', 'example' => 'dev', ], 'SubType' => [ 'title' => '表子类型: 维度逻辑表 dim', 'description' => '表子类型: 维度逻辑表 dim', 'type' => 'string', 'example' => 'dim', ], 'FullTable' => [ 'title' => '是否选择全表', 'description' => '是否选择全表', 'type' => 'boolean', ], 'ColumnList' => [ 'title' => '血缘字段列表', 'description' => '血缘字段列表', 'type' => 'array', 'items' => [ 'title' => '血缘字段', 'description' => '血缘字段', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '字段Id', 'description' => '字段Id', 'type' => 'string', 'example' => 'c011', ], 'Name' => [ 'title' => '字段名称', 'description' => '字段名称', 'type' => 'string', 'example' => 'c011', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx', ], 'DataType' => [ 'title' => '数据类型', 'description' => '数据类型', 'type' => 'string', 'example' => 'varchar', ], 'PartitionKey' => [ 'title' => '是否分区键', 'description' => '是否分区键', 'type' => 'boolean', ], 'PrimaryKey' => [ 'title' => '是否主键', 'description' => '是否主键', 'type' => 'boolean', ], ], ], ], ], ], ], 'OutputLineageList' => [ 'title' => '血缘输出表集合', 'description' => '血缘输出表集合', 'type' => 'array', 'items' => [ 'title' => '血缘表', 'description' => '血缘表', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_input', ], 'DisplayName' => [ 'title' => '表显示名', 'description' => '表显示名', 'type' => 'string', 'example' => 't_input', ], 'Guid' => [ 'title' => '全局Id', 'description' => '全局Id', 'type' => 'string', 'example' => 'Guid_101121', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test xx', ], 'OwnerName' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'example' => '张三', ], 'OwnerUserId' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'example' => '20112101', ], 'ProjectName' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'string', 'example' => 'prj_test', ], 'ProjectId' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'string', 'example' => '131211211', ], 'BizUnitId' => [ 'title' => '板块ID', 'description' => '板块ID', 'type' => 'string', 'example' => '103111231', ], 'BizUnitName' => [ 'title' => '板块名称', 'description' => '板块名称', 'type' => 'string', 'example' => 'xx测试', ], 'Env' => [ 'title' => '环境 prod/dev', 'description' => '环境 prod/dev', 'type' => 'string', 'example' => 'dev', ], 'SubType' => [ 'title' => '表子类型: 维度逻辑表 dim', 'description' => '表子类型: 维度逻辑表 dim', 'type' => 'string', 'example' => 'dim', ], 'FullTable' => [ 'title' => '是否选择全表', 'description' => '是否选择全表', 'type' => 'boolean', ], 'ColumnList' => [ 'title' => '血缘字段列表', 'description' => '血缘字段列表', 'type' => 'array', 'items' => [ 'title' => '血缘字段', 'description' => '血缘字段', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '字段Id', 'description' => '字段Id', 'type' => 'string', 'example' => 'c011', ], 'Name' => [ 'title' => '字段名称', 'description' => '字段名称', 'type' => 'string', 'example' => 'c011', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx', ], 'DataType' => [ 'title' => '数据类型', 'description' => '数据类型', 'type' => 'string', 'example' => 'varchar', ], 'PartitionKey' => [ 'title' => '是否分区键', 'description' => '是否分区键', 'type' => 'boolean', ], 'PrimaryKey' => [ 'title' => '是否主键', 'description' => '是否主键', 'type' => 'boolean', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"LineageGroupList\\": [\\n {\\n \\"InputLineageList\\": [\\n {\\n \\"Name\\": \\"t_input\\",\\n \\"DisplayName\\": \\"t_input\\",\\n \\"Guid\\": \\"Guid_101121\\",\\n \\"Description\\": \\"test xx\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"OwnerUserId\\": \\"20112101\\",\\n \\"ProjectName\\": \\"prj_test\\",\\n \\"ProjectId\\": \\"131211211\\",\\n \\"BizUnitId\\": \\"103111231\\",\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"Env\\": \\"dev\\",\\n \\"SubType\\": \\"dim\\",\\n \\"FullTable\\": true,\\n \\"ColumnList\\": [\\n {\\n \\"Id\\": \\"c011\\",\\n \\"Name\\": \\"c011\\",\\n \\"Description\\": \\"xx\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"PartitionKey\\": true,\\n \\"PrimaryKey\\": true\\n }\\n ]\\n }\\n ],\\n \\"OutputLineageList\\": [\\n {\\n \\"Name\\": \\"t_input\\",\\n \\"DisplayName\\": \\"t_input\\",\\n \\"Guid\\": \\"Guid_101121\\",\\n \\"Description\\": \\"test xx\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"OwnerUserId\\": \\"20112101\\",\\n \\"ProjectName\\": \\"prj_test\\",\\n \\"ProjectId\\": \\"131211211\\",\\n \\"BizUnitId\\": \\"103111231\\",\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"Env\\": \\"dev\\",\\n \\"SubType\\": \\"dim\\",\\n \\"FullTable\\": true,\\n \\"ColumnList\\": [\\n {\\n \\"Id\\": \\"c011\\",\\n \\"Name\\": \\"c011\\",\\n \\"Description\\": \\"xx\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"PartitionKey\\": true,\\n \\"PrimaryKey\\": true\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询离线计算任务自定义血缘', ], 'GetBatchTaskVersions' => [ 'summary' => '获取离线计算任务版本列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'object', 'properties' => [ 'BatchTaskVersionList' => [ 'title' => '离线计算任务版本列表', 'description' => '离线计算任务版本列表', 'type' => 'array', 'items' => [ 'title' => '离线计算任务版本', 'description' => '离线计算任务版本', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点Id', 'description' => '节点Id', 'type' => 'string', 'example' => 'n_10231001', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'string', 'example' => '1', ], 'UserId' => [ 'title' => '提交人', 'description' => '提交人', 'type' => 'string', 'example' => '20110110', ], 'UserName' => [ 'title' => '提交人', 'description' => '提交人', 'type' => 'string', 'example' => '张三', ], 'Comment' => [ 'title' => '提交备注', 'description' => '提交备注', 'type' => 'string', 'example' => 'test', ], 'Published' => [ 'title' => '是否已经发布到线上', 'description' => '是否已经发布到线上', 'type' => 'boolean', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10232111011', ], 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-10 10:10:10', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-10 10:10:10', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"BatchTaskVersionList\\": [\\n {\\n \\"NodeId\\": \\"n_10231001\\",\\n \\"Version\\": \\"1\\",\\n \\"UserId\\": \\"20110110\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Comment\\": \\"test\\",\\n \\"Published\\": true,\\n \\"ProjectId\\": 10232111011,\\n \\"GmtCreate\\": \\"2024-10-10 10:10:10\\",\\n \\"GmtModified\\": \\"2024-10-10 10:10:10\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取离线计算任务版本列表', ], 'GetBatchTaskInfoByVersion' => [ 'summary' => '获取离线计算任务指定版本任务详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'TaskInfo' => [ 'title' => '任务详情', 'description' => '任务详情', 'type' => 'object', 'properties' => [ 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111', ], 'Name' => [ 'title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => '测试任务1', ], 'Status' => [ 'title' => '发布状态: 草稿0、已提交1、开发中100', 'description' => '发布状态: 草稿0、已提交1、开发中100', 'type' => 'string', 'example' => '测试任务1', ], 'Published' => [ 'title' => '是否已发布', 'description' => '是否已发布', 'type' => 'boolean', ], 'NeedPublish' => [ 'title' => '是否需要发布', 'description' => '是否需要发布', 'type' => 'boolean', ], 'HasDevNode' => [ 'title' => '是否有开发环境节点', 'description' => '是否有开发环境节点', 'type' => 'boolean', ], 'NodeId' => [ 'title' => '节点Id', 'description' => '节点Id', 'type' => 'string', 'example' => 'n_1011_21232132322', ], 'NodeName' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => '测试任务1', ], 'NodeOutputNameList' => [ 'title' => '节点输出名称列表', 'description' => '节点输出名称列表', 'type' => 'array', 'items' => [ 'title' => '节点输出名称', 'description' => '节点输出名称', 'type' => 'string', 'example' => 'xx测试', ], ], 'OwnerUserId' => [ 'title' => '节点负责人用户id', 'description' => '节点负责人用户id', 'type' => 'string', 'example' => '30231123', ], 'OwnerName' => [ 'title' => '节点负责人名称', 'description' => '节点负责人名称', 'type' => 'string', 'example' => '张三', ], 'OperatorUserId' => [ 'title' => '当前操作的用户id', 'description' => '当前操作的用户id', 'type' => 'string', 'example' => '30231123', ], 'NodeDescription' => [ 'title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'xx测试', ], 'TaskType' => [ 'title' => '任务类型: MaxCompute_SQL 5、Shell 10、Python 21', 'description' => '任务类型，可参见创建离线计算任务接口', 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'ScheduleType' => [ 'title' => '节点类型: 周期任务1、手动任务3', 'description' => '节点类型'."\n" .'- 周期任务：1'."\n" .'- 手动任务：3', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SchedulePeriod' => [ 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', 'description' => '调度周期'."\n" .'- 年：YEARLY'."\n" .'- 月：MONTHLY'."\n" .'- 周：WEEKLY'."\n" .'- 日：DAILY'."\n" .'- 小时：HOURLY'."\n" .'- 分钟：MINUTELY', 'type' => 'string', 'example' => 'DAILY', ], 'CronExpression' => [ 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', 'description' => '自动调度的cron表达式, 可参考Linux cron表达式', 'type' => 'string', 'example' => '0 0 1 * * ?', ], 'CustomScheduleConfig' => [ 'title' => '自定义调度间隔配置', 'description' => '自定义调度间隔配置', 'type' => 'object', 'properties' => [ 'SchedulePeriod' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'string', 'example' => 'DAILY', ], 'Interval' => [ 'title' => '自定义间隔', 'description' => '自定义间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IntervalUnit' => [ 'title' => '间隔单位：MINUTE、HOUR', 'description' => '间隔单位：MINUTE、HOUR', 'type' => 'string', 'example' => 'HOUR', ], 'StartTime' => [ 'title' => '开始时间: HH:mm', 'description' => '开始时间: HH:mm', 'type' => 'string', 'example' => '08:00', ], 'EndTime' => [ 'title' => '结束时间: HH:mm', 'description' => '结束时间: HH:mm', 'type' => 'string', 'example' => '20:59', ], ], ], 'Code' => [ 'title' => '任务代码', 'description' => '任务代码', 'type' => 'string', 'example' => 'show tables;', ], 'Remark' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => 'test xx', ], 'DagId' => [ 'title' => '所属的dagId', 'description' => '所属的dagId', 'type' => 'string', 'example' => 'dag_102121211', ], 'ParamList' => [ 'title' => '节点自定义参数列表', 'description' => '节点自定义参数列表', 'type' => 'array', 'items' => [ 'title' => '节点自定义参数', 'description' => '节点自定义参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'key', ], 'Value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => 'Value', ], ], ], ], 'Rerunable' => [ 'title' => '是否可以重跑', 'description' => '是否可以重跑', 'type' => 'boolean', ], 'Priority' => [ 'title' => '任务调度优先级, 1-9值越大表示优先级越低', 'description' => '任务调度优先级, 1-9值越大表示优先级越低', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeStatus' => [ 'title' => '节点状态: 正常 1、暂停 2、空跑 3', 'description' => '节点状态: 正常 1、暂停 2、空跑 3', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Paused' => [ 'title' => '节点是否被暂停调度', 'description' => '节点是否被暂停调度', 'type' => 'boolean', ], 'NodeFrom' => [ 'title' => '节点来源,节点由某个组织或应用创建的', 'description' => '节点来源,节点由某个组织或应用创建的', 'type' => 'string', 'example' => 'openapi', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211', ], 'UpStreamList' => [ 'title' => '上游依赖', 'description' => '上游依赖', 'type' => 'array', 'items' => [ 'title' => '节点关联', 'description' => '节点关联', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', 'description' => '上游依赖节点类型'."\n" .'- PHYSICAL：物理节点'."\n" .'- LOGICAL：逻辑表依赖', 'type' => 'string', 'example' => 'PHYSICAL', ], 'SourceNodeId' => [ 'title' => '上游节点Id', 'description' => '上游节点Id', 'type' => 'string', 'example' => 'n_2001', ], 'SourceNodeName' => [ 'title' => '上游节点名', 'description' => '上游节点名', 'type' => 'string', 'example' => 't_input1', ], 'SourceNodeUserName' => [ 'title' => '上游的用户名', 'description' => '上游的用户名', 'type' => 'string', 'example' => '张三', ], 'SourceNodeOutputName' => [ 'title' => '上游节点的输出名称', 'description' => '上游节点的输出名称', 'type' => 'string', 'example' => 't_input1', ], 'SourceTableName' => [ 'title' => '输入表名称', 'description' => '输入表名称', 'type' => 'string', 'example' => 't_input1', ], 'PeriodDiff' => [ 'title' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'description' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FieldList' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'array', 'items' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'string', 'example' => 'column1', ], ], 'DependPeriod' => [ 'title' => '依赖周期', 'description' => '依赖周期', 'type' => 'object', 'properties' => [ 'PeriodType' => [ 'title' => '依赖周期类型: CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', 'description' => '依赖周期类型'."\n" .'- CURRENT_PERIOD'."\n" .'- LAST_PERIOD'."\n" .'- LAST_N_PERIOD'."\n" .'- LAST_24_HOUR', 'type' => 'string', 'example' => 'CURRENT_PERIOD', ], 'PeriodOffset' => [ 'title' => '周期偏移量, LAST_N_PERIOD时须传值', 'description' => '周期偏移量, LAST_N_PERIOD时须传值', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'DependStrategy' => [ 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', 'description' => '依赖策略: ALL,FIRST,LAST,NEAR', 'type' => 'string', 'example' => 'LAST', ], 'SourceNodeEnabled' => [ 'title' => '上游节点是否生效', 'description' => '上游节点是否生效', 'type' => 'boolean', ], ], ], ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'string', 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'example' => 'erp', ], 'SparkClientInfo' => [ 'title' => 'spark客户端信息', 'description' => 'spark客户端', 'type' => 'object', 'properties' => [ 'SparkClientVersion' => [ 'title' => 'spark客户端版本名称', 'description' => 'spark客户端名称', 'type' => 'string', 'example' => 'abc', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskInfo\\": {\\n \\"FileId\\": 12113111,\\n \\"Name\\": \\"测试任务1\\",\\n \\"Status\\": \\"测试任务1\\",\\n \\"Published\\": true,\\n \\"NeedPublish\\": true,\\n \\"HasDevNode\\": true,\\n \\"NodeId\\": \\"n_1011_21232132322\\",\\n \\"NodeName\\": \\"测试任务1\\",\\n \\"NodeOutputNameList\\": [\\n \\"xx测试\\"\\n ],\\n \\"OwnerUserId\\": \\"30231123\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"OperatorUserId\\": \\"30231123\\",\\n \\"NodeDescription\\": \\"xx测试\\",\\n \\"TaskType\\": 21,\\n \\"ScheduleType\\": 3,\\n \\"SchedulePeriod\\": \\"DAILY\\",\\n \\"CronExpression\\": \\"0 0 1 * * ?\\",\\n \\"CustomScheduleConfig\\": {\\n \\"SchedulePeriod\\": \\"DAILY\\",\\n \\"Interval\\": 1,\\n \\"IntervalUnit\\": \\"HOUR\\",\\n \\"StartTime\\": \\"08:00\\",\\n \\"EndTime\\": \\"20:59\\"\\n },\\n \\"Code\\": \\"show tables;\\",\\n \\"Remark\\": \\"test xx\\",\\n \\"DagId\\": \\"dag_102121211\\",\\n \\"ParamList\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ],\\n \\"Rerunable\\": true,\\n \\"Priority\\": 1,\\n \\"NodeStatus\\": 1,\\n \\"Paused\\": true,\\n \\"NodeFrom\\": \\"openapi\\",\\n \\"ProjectId\\": 131211211,\\n \\"UpStreamList\\": [\\n {\\n \\"NodeType\\": \\"PHYSICAL\\",\\n \\"SourceNodeId\\": \\"n_2001\\",\\n \\"SourceNodeName\\": \\"t_input1\\",\\n \\"SourceNodeUserName\\": \\"张三\\",\\n \\"SourceNodeOutputName\\": \\"t_input1\\",\\n \\"SourceTableName\\": \\"t_input1\\",\\n \\"PeriodDiff\\": 1,\\n \\"FieldList\\": [\\n \\"column1\\"\\n ],\\n \\"DependPeriod\\": {\\n \\"PeriodType\\": \\"CURRENT_PERIOD\\",\\n \\"PeriodOffset\\": 1\\n },\\n \\"DependStrategy\\": \\"LAST\\",\\n \\"SourceNodeEnabled\\": true\\n }\\n ],\\n \\"DataSourceId\\": \\"12131111\\",\\n \\"DataSourceCatalog\\": \\"mysql_catalog\\",\\n \\"DataSourceSchema\\": \\"erp\\",\\n \\"SparkClientInfo\\": {\\n \\"SparkClientVersion\\": \\"abc\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '查询指定版本离线计算任务详情', ], 'GetBatchTaskInfo' => [ 'summary' => '获取离线计算任务详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识: dev、prod，默认值为dev', 'description' => '环境标识: dev、prod，默认值为dev', 'type' => 'string', 'required' => false, 'example' => 'dev', ], ], [ 'name' => 'IncludeAllUpStreams', 'in' => 'query', 'schema' => [ 'title' => '是否包含完整的上游节点（包括无效依赖），默认false', 'description' => '是否包含完整的上游节点（包括无效依赖），默认false', 'type' => 'boolean', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'TaskInfo' => [ 'title' => '任务详情', 'description' => '任务详情', 'type' => 'object', 'properties' => [ 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111', ], 'Name' => [ 'title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => '测试任务1', ], 'Status' => [ 'title' => '发布状态: 草稿0、已提交1、开发中100', 'description' => '发布状态: 草稿0、已提交1、开发中100', 'type' => 'string', 'example' => '测试任务1', ], 'Published' => [ 'title' => '是否已发布', 'description' => '是否已发布', 'type' => 'boolean', ], 'NeedPublish' => [ 'title' => '是否需要发布', 'description' => '是否需要发布', 'type' => 'boolean', ], 'HasDevNode' => [ 'title' => '是否有开发环境节点', 'description' => '是否有开发环境节点', 'type' => 'boolean', ], 'NodeId' => [ 'title' => '节点Id', 'description' => '节点Id', 'type' => 'string', 'example' => 'n_1011_21232132322', ], 'NodeName' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => '测试任务1', ], 'NodeOutputNameList' => [ 'title' => '节点输出名称列表', 'description' => '节点输出名称列表', 'type' => 'array', 'items' => [ 'title' => '节点输出名称', 'description' => '节点输出名称', 'type' => 'string', 'example' => 'xx测试', ], ], 'OwnerUserId' => [ 'title' => '节点负责人用户id', 'description' => '节点负责人用户id', 'type' => 'string', 'example' => '30231123', ], 'OwnerName' => [ 'title' => '节点负责人名称', 'description' => '节点负责人名称', 'type' => 'string', 'example' => '张三', ], 'OperatorUserId' => [ 'title' => '当前操作的用户id', 'description' => '当前操作的用户id', 'type' => 'string', 'example' => '30231123', ], 'NodeDescription' => [ 'title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'xx测试', ], 'TaskType' => [ 'title' => '任务类型: MaxCompute_SQL 5、Shell 10、Python 21', 'description' => '任务类型，可参见创建离线计算任务接口', 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'ScheduleType' => [ 'title' => '节点类型: 周期任务1、手动任务3', 'description' => '节点类型: '."\n" .'- 周期任务：1'."\n" .'- 手动任务：3', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SchedulePeriod' => [ 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', 'description' => '调度周期'."\n" .'- 年：YEARLY'."\n" .'- 月：MONTHLY'."\n" .'- 周：WEEKLY'."\n" .'- 日：DAILY'."\n" .'- 小时：HOURLY'."\n" .'- 分钟：MINUTELY', 'type' => 'string', 'example' => 'DAILY', ], 'CronExpression' => [ 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', 'description' => '自动调度的cron表达式, 可参考Linux cron表达式', 'type' => 'string', 'example' => '0 0 1 * * ?', ], 'CustomScheduleConfig' => [ 'title' => '自定义调度间隔配置', 'description' => '自定义调度间隔配置', 'type' => 'object', 'properties' => [ 'SchedulePeriod' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'string', 'example' => 'DAILY', ], 'Interval' => [ 'title' => '自定义间隔', 'description' => '自定义间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IntervalUnit' => [ 'title' => '间隔单位：MINUTE、HOUR', 'description' => '间隔单位：MINUTE、HOUR', 'type' => 'string', 'example' => 'HOUR', ], 'StartTime' => [ 'title' => '开始时间: HH:mm', 'description' => '开始时间: HH:mm', 'type' => 'string', 'example' => '08:00', ], 'EndTime' => [ 'title' => '结束时间: HH:mm', 'description' => '结束时间: HH:mm', 'type' => 'string', 'example' => '20:59', ], ], ], 'Code' => [ 'title' => '任务代码', 'description' => '任务代码', 'type' => 'string', 'example' => 'show tables;', ], 'Remark' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => 'test xx', ], 'DagId' => [ 'title' => '所属的dagId', 'description' => '所属的dagId', 'type' => 'string', 'example' => 'dag_102121211', ], 'ParamList' => [ 'title' => '节点自定义参数列表', 'description' => '节点自定义参数列表', 'type' => 'array', 'items' => [ 'title' => '节点自定义参数', 'description' => '节点自定义参数', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => 'Value', ], 'Key' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'key', ], ], ], ], 'Rerunable' => [ 'title' => '是否可以重跑', 'description' => '是否可以重跑', 'type' => 'boolean', ], 'Priority' => [ 'title' => '任务调度优先级, 1-9值越大表示优先级越低', 'description' => '任务调度优先级, 1-9值越大表示优先级越低', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeStatus' => [ 'title' => '节点状态: 正常 1、暂停 2、空跑 3', 'description' => '节点状态: 正常 1、暂停 2、空跑 3', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Paused' => [ 'title' => '节点是否被暂停调度', 'description' => '节点是否被暂停调度', 'type' => 'boolean', ], 'NodeFrom' => [ 'title' => '节点来源,节点由某个组织或应用创建的', 'description' => '节点来源,节点由某个组织或应用创建的', 'type' => 'string', 'example' => 'openapi', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211', ], 'UpStreamList' => [ 'title' => '上游依赖', 'description' => '上游依赖', 'type' => 'array', 'items' => [ 'title' => '节点关联', 'description' => '节点关联', 'type' => 'object', 'properties' => [ 'SourceTableName' => [ 'title' => '输入表名称', 'description' => '输入表名称', 'type' => 'string', 'example' => 't_input1', ], 'SourceNodeId' => [ 'title' => '上游节点Id', 'description' => '上游节点Id', 'type' => 'string', 'example' => 'n_2001', ], 'PeriodDiff' => [ 'title' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'description' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeType' => [ 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', 'description' => '上游依赖节点类型'."\n" .'- PHYSICAL：物理节点'."\n" .'- LOGICAL：逻辑表依赖', 'type' => 'string', 'example' => 'PHYSICAL', ], 'SourceNodeName' => [ 'title' => '上游节点名', 'description' => '上游节点名', 'type' => 'string', 'example' => 't_input1', ], 'DependPeriod' => [ 'title' => '依赖周期', 'description' => '依赖周期', 'type' => 'object', 'properties' => [ 'PeriodType' => [ 'title' => '依赖周期类型: CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', 'description' => '依赖周期类型: '."\n" .'- CURRENT_PERIOD'."\n" .'- LAST_PERIOD'."\n" .'- LAST_N_PERIOD'."\n" .'- LAST_24_HOUR', 'type' => 'string', 'example' => 'CURRENT_PERIOD', ], 'PeriodOffset' => [ 'title' => '周期偏移量, LAST_N_PERIOD时须传值', 'description' => '周期偏移量, LAST_N_PERIOD时须传值', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'SourceNodeUserName' => [ 'title' => '上游的用户名', 'description' => '上游的用户名', 'type' => 'string', 'example' => '张三', ], 'SourceNodeEnabled' => [ 'title' => '上游节点是否生效', 'description' => '上游节点是否生效', 'type' => 'boolean', ], 'SourceNodeOutputName' => [ 'title' => '上游节点的输出名称', 'description' => '上游节点的输出名称', 'type' => 'string', 'example' => 't_input1', ], 'DependStrategy' => [ 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', 'description' => '依赖策略: ALL,FIRST,LAST,NEAR', 'type' => 'string', 'example' => 'LAST', ], 'FieldList' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'array', 'items' => [ 'title' => '依赖的逻辑表字段', 'description' => '依赖的逻辑表字段', 'type' => 'string', 'example' => 'column1', ], ], ], ], ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'string', 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'example' => 'erp', ], 'SparkClientInfo' => [ 'title' => 'spark客户端信息', 'description' => 'spark客户端信息', 'type' => 'object', 'properties' => [ 'SparkClientVersion' => [ 'title' => 'spark客户端版本名称', 'description' => 'spark客户端版本名称', 'type' => 'string', 'example' => 'abc', ], ], ], 'DevelopOwnerId' => [ 'title' => '开发负责人用户id', 'description' => '开发负责人用户id', 'type' => 'string', 'example' => '30231123', ], 'DevelopOwnerName' => [ 'title' => '开发负责人名称', 'description' => '开发负责人名称', 'type' => 'string', 'example' => '张三', ], 'OpsOwnerId' => [ 'title' => '运维负责人用户id', 'description' => '运维负责人用户id', 'type' => 'string', 'example' => '30231123', ], 'OpsOwnerName' => [ 'title' => '运维负责人名称', 'description' => '运维负责人名称', 'type' => 'string', 'example' => '张三', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskInfo\\": {\\n \\"FileId\\": 12113111,\\n \\"Name\\": \\"测试任务1\\",\\n \\"Status\\": \\"测试任务1\\",\\n \\"Published\\": true,\\n \\"NeedPublish\\": true,\\n \\"HasDevNode\\": true,\\n \\"NodeId\\": \\"n_1011_21232132322\\",\\n \\"NodeName\\": \\"测试任务1\\",\\n \\"NodeOutputNameList\\": [\\n \\"xx测试\\"\\n ],\\n \\"OwnerUserId\\": \\"30231123\\",\\n \\"OwnerName\\": \\"张三\\",\\n \\"OperatorUserId\\": \\"30231123\\",\\n \\"NodeDescription\\": \\"xx测试\\",\\n \\"TaskType\\": 21,\\n \\"ScheduleType\\": 3,\\n \\"SchedulePeriod\\": \\"DAILY\\",\\n \\"CronExpression\\": \\"0 0 1 * * ?\\",\\n \\"CustomScheduleConfig\\": {\\n \\"SchedulePeriod\\": \\"DAILY\\",\\n \\"Interval\\": 1,\\n \\"IntervalUnit\\": \\"HOUR\\",\\n \\"StartTime\\": \\"08:00\\",\\n \\"EndTime\\": \\"20:59\\"\\n },\\n \\"Code\\": \\"show tables;\\",\\n \\"Remark\\": \\"test xx\\",\\n \\"DagId\\": \\"dag_102121211\\",\\n \\"ParamList\\": [\\n {\\n \\"Value\\": \\"Value\\",\\n \\"Key\\": \\"key\\"\\n }\\n ],\\n \\"Rerunable\\": true,\\n \\"Priority\\": 1,\\n \\"NodeStatus\\": 1,\\n \\"Paused\\": true,\\n \\"NodeFrom\\": \\"openapi\\",\\n \\"ProjectId\\": 131211211,\\n \\"UpStreamList\\": [\\n {\\n \\"SourceTableName\\": \\"t_input1\\",\\n \\"SourceNodeId\\": \\"n_2001\\",\\n \\"PeriodDiff\\": 1,\\n \\"NodeType\\": \\"PHYSICAL\\",\\n \\"SourceNodeName\\": \\"t_input1\\",\\n \\"DependPeriod\\": {\\n \\"PeriodType\\": \\"CURRENT_PERIOD\\",\\n \\"PeriodOffset\\": 1\\n },\\n \\"SourceNodeUserName\\": \\"张三\\",\\n \\"SourceNodeEnabled\\": true,\\n \\"SourceNodeOutputName\\": \\"t_input1\\",\\n \\"DependStrategy\\": \\"LAST\\",\\n \\"FieldList\\": [\\n \\"column1\\"\\n ]\\n }\\n ],\\n \\"DataSourceId\\": \\"12131111\\",\\n \\"DataSourceCatalog\\": \\"mysql_catalog\\",\\n \\"DataSourceSchema\\": \\"erp\\",\\n \\"SparkClientInfo\\": {\\n \\"SparkClientVersion\\": \\"abc\\"\\n },\\n \\"DevelopOwnerId\\": \\"30231123\\",\\n \\"DevelopOwnerName\\": \\"张三\\",\\n \\"OpsOwnerId\\": \\"30231123\\",\\n \\"OpsOwnerName\\": \\"张三\\"\\n }\\n}","type":"json"}]', 'title' => '查询离线计算任务详情', ], 'DeleteBatchTask' => [ 'summary' => '删除离线计算任务，如果任务还没下线需要先下线再删除。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除请求', 'description' => '删除请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '任务所属项目', 'description' => '任务所属项目', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211', ], 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111', ], 'Comment' => [ 'title' => '删除操作说明', 'description' => '删除操作说明', 'type' => 'string', 'required' => true, 'example' => 'test task', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'True', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', 'title' => '删除离线计算任务', ], 'CreateBatchTask' => [ 'summary' => '创建离线计算任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '任务所属菜单树目录', 'description' => '任务所属菜单树目录', 'type' => 'string', 'required' => true, 'example' => '/a/b', ], 'Name' => [ 'title' => '离线任务名', 'description' => '离线任务名', 'type' => 'string', 'required' => true, 'example' => 'test111', ], 'ProjectId' => [ 'title' => '任务所属项目Id', 'description' => '任务所属项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => true, 'example' => 'xx test.', ], 'ScheduleType' => [ 'title' => '调度类型: 周期任务:1、手动任务:3', 'description' => '调度类型'."\n" .'- 周期任务:1'."\n" .'- 手动任务:3', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', ], 'TaskType' => [ 'title' => '任务类型: Hive_SQL: 1、MaxCompute_SQL: 5、Shell 10、Python 21', 'description' => '任务类型'."\n" .'- Hive_SQL: 1'."\n" .'- Hive_SQL_23X: 101'."\n" .'- HIVE_SQL_FUSION_INSIGHT_80X: 111'."\n" .'- COMMON_HIVE_SQL: 131'."\n" .'- HADOOP_MR: 2'."\n" .'- MaxCompute_SQL: 5'."\n" .'- MaxCompute_MR: 6'."\n" .'- SPARK_SQL_ON_MAX_COMPUTE: 7'."\n" .'- SPARK_JAR_ON_MAX_COMPUTE: 8'."\n" .'- SPARK_SQL_ON_HIVE: 17'."\n" .'- Spark_JAR_ON_HIVE: 18'."\n" .'- Shell: 10'."\n" .'- PAI_DESIGNER: 71'."\n" .'- DataX: 15'."\n" .'- Merge: 16'."\n" .'- Python: 21'."\n" .'- Python37x: 22'."\n" .'- Perl: 23'."\n" .'- Python311x: 24'."\n" .'- OneService_SQL: 25'."\n" .'- ONE_SERVICE_SQL_ADB_FOR_PG: 26'."\n" .'- OneService_SQL_Hive11x: 27'."\n" .'- OneService_SQL_Hive23x: 29'."\n" .'- ONE_SERVICE_SQL_TDH_INCEPTOR: 75'."\n" .'- ONE_SERVICE_SQL_HIVE_CDP: 91'."\n" .'- ONE_SERVICE_SQL_HIVE_ASIA_INFO_DP_53X: 92'."\n" .'- Dlink: 30'."\n" .'- ONE_SERVICE_SQL_ADB_FOR_MYSQL: 33'."\n" .'- Logical: 31'."\n" .'- Flink_Streaming: 41'."\n" .'- Flink_Batch: 42'."\n" .'- ADB_FOR_PG: 51'."\n" .'- DryRun: 100'."\n" .'- CHECK: 902'."\n" .'- VIRTUAL: 999'."\n" .'- INCEPTOR_SQL: 10000'."\n" .'- HOLOGRES_SQL: 28'."\n" .'- ARGODB_SQL: 76'."\n" .'- IMPALA_SQL: 78'."\n" .'- STARROCKS_SQL: 79'."\n" .'- SPARK_SQL: 80'."\n" .'- GAUSS_SQL: 81'."\n" .'- DATABASE_SQL: 998'."\n" .'- EXTERNAL_TRIGGER: 997', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5', ], 'Engine' => [ 'title' => '任务执行引擎: PYTHON2_7,PYTHON3_7,PYTHON3_11', 'description' => '任务执行引擎，如Python任务'."\n" .'- 1. PYTHON2_7'."\n" .'- 2. PYTHON3_7'."\n" .'- 3. PYTHON3_11', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7', ], 'DataSourceId' => [ 'title' => '数据库sql任务，数据源Id', 'description' => '数据库sql任务，数据源Id', 'type' => 'string', 'required' => false, 'example' => '12131111', ], 'DataSourceCatalog' => [ 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'description' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog', ], 'DataSourceSchema' => [ 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'description' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', 'type' => 'string', 'required' => false, 'example' => 'erp', ], 'PythonModuleList' => [ 'title' => '任务依赖python三方包', 'description' => '任务依赖python三方包', 'type' => 'array', 'items' => [ 'title' => 'python三方包', 'description' => 'python三方包', 'type' => 'string', 'required' => true, 'example' => 'numpy', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'CreateResult' => [ 'title' => '新建结果', 'description' => '新建结果', 'type' => 'object', 'properties' => [ 'FileId' => [ 'title' => '任务目录树节点Id', 'description' => '任务目录树节点Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"FileId\\": 12113111\\n }\\n}","type":"json"}]', 'title' => '创建离线计算任务', ], 'GetStreamJobs' => [ 'summary' => '获取实时研发任务列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => 'dataphin项目id', 'description' => 'dataphin项目id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7162269257990111', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => 'dataphin环境，DEV或者PROD', 'description' => 'dataphin环境，DEV或者PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'description' => '返回的数据内容。', 'type' => 'array', 'items' => [ 'description' => '任务对象', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '任务状态', 'description' => '任务状态: 0 草稿 1 提交中 2 已提交 3 已发布 100 开发中', 'type' => 'string', 'example' => '0', ], 'Type' => [ 'title' => '任务类型，FLINK_SQL或者FLINK_DATASTREAM', 'description' => '任务类型，FLINK_SQL或者FLINK_DATASTREAM', 'type' => 'string', 'example' => 'FLINK_SQL', ], 'OwnerId' => [ 'title' => '创建者id', 'description' => '创建者id', 'type' => 'string', 'example' => '300006788', ], 'JobName' => [ 'title' => '实时任务名', 'description' => '实时任务名', 'type' => 'string', 'example' => 'flink_order_detail', ], 'ProjectId' => [ 'title' => 'dataphin项目id', 'description' => 'dataphin项目id', 'type' => 'string', 'example' => '7162269257990111', ], 'Id' => [ 'title' => '实时任务的mapping id', 'description' => '实时任务的mapping id', 'type' => 'integer', 'format' => 'int64', 'example' => '716555', ], 'Env' => [ 'title' => '环境标识：DEV 开发、PROD 生产', 'description' => '环境标识：DEV开发、PROD生产', 'type' => 'string', 'example' => 'DEV', ], 'ModifierId' => [ 'title' => '最近一次变更人的id', 'description' => '最近一次变更人的id', 'type' => 'string', 'example' => '300006788', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"Type\\": \\"FLINK_SQL\\",\\n \\"OwnerId\\": \\"300006788\\",\\n \\"JobName\\": \\"flink_order_detail\\",\\n \\"ProjectId\\": \\"7162269257990111\\",\\n \\"Id\\": 716555,\\n \\"Env\\": \\"DEV\\",\\n \\"ModifierId\\": \\"300006788\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取实时研发任务', ], 'GetQueueEngineVersionByEnv' => [ 'summary' => '根据集群ID获取集群版本。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [ 'Dataphin公共云', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境', 'description' => '环境', 'type' => 'string', 'required' => true, 'example' => 'PROD', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752', ], ], [ 'name' => 'StreamBatchMode', 'in' => 'query', 'schema' => [ 'title' => '流批模式'."\n", 'description' => '流批模式'."\n", 'type' => 'string', 'required' => true, 'example' => 'BOTH', 'enum' => [ 'BOTH', 'STREAM', 'BATCH', ], ], ], [ 'name' => 'QueueName', 'in' => 'query', 'schema' => [ 'title' => '队列名称', 'description' => '队列名称', 'type' => 'string', 'required' => true, 'example' => 'default-queue', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'title' => '集群Id', 'description' => '集群Id', 'type' => 'string', 'required' => true, 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '引擎版本信息', 'description' => '引擎版本信息', 'type' => 'array', 'items' => [ 'title' => '引擎版本信息', 'description' => '引擎版本信息', 'type' => 'string', 'example' => 'vvr-8.0.9-flink-1.17', ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n \\"vvr-8.0.9-flink-1.17\\"\\n ]\\n}","type":"json"}]', 'title' => '获取集群引擎的版本信息', ], 'GetClusterQueueInfoByEnv' => [ 'summary' => '根据环境获取集群信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [ 'Dataphin公共云', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境', 'description' => '环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752', ], ], [ 'name' => 'StreamBatchMode', 'in' => 'query', 'schema' => [ 'title' => '流批模式'."\n", 'description' => '流批模式'."\n", 'type' => 'string', 'required' => true, 'example' => 'BOTH', 'enum' => [ 'STREAM', 'BATCH', 'BOTH', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'default' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '返回结果'."\n", 'description' => '返回结果'."\n", 'type' => 'array', 'items' => [ 'title' => '集群详细信息', 'description' => '集群详细信息', 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'title' => '集群clusterId', 'description' => '集群clusterId', 'type' => 'string', 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d', ], 'QueueName' => [ 'title' => '队列名，唯一标示，k8s是资源组名称', 'description' => '队列名，唯一标示，k8s是资源组名称', 'type' => 'string', 'example' => 'default-queue', ], 'MaxVcore' => [ 'title' => '每个队列最大提供VCORE', 'description' => '每个队列最大提供VCORE', 'type' => 'string', 'example' => '10', ], 'Namespace' => [ 'title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'example' => 'dataphinv45prod', ], 'CreateAt' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-31 10:29:17', ], 'ModifiedAt' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-10-31 10:29:17', ], 'Annotations' => [ 'title' => '注释', 'description' => '注释', 'type' => 'string', 'example' => '{ "creator": "new_datasource@test.aliyunid.com", "modifier": "new_datasource@test.aliyunid.com" }', ], 'Labels' => [ 'title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => 'cdh', 'default' => 'null', ], 'ResourceVersion' => [ 'title' => '资源版本', 'description' => '资源版本', 'type' => 'string', 'example' => '1', ], 'Spec' => [ 'title' => '资源规范', 'description' => '资源规范', 'type' => 'string', 'example' => '{\\n \\"kind\\" : \\"kubernetes\\",\\n \\"kubernetes\\{"namespace" : "n1730341728989z7", "clusterName" : "a51578bdcce145" }, "state" : "ONLINE"}', ], 'VvpClusterType' => [ 'title' => 'VVP集群类型', 'description' => 'VVP集群类型', 'type' => 'string', 'example' => 'PREJOB', ], 'FlinkVersion' => [ 'title' => 'Flink版本', 'description' => 'Flink版本', 'type' => 'string', 'required' => false, 'example' => '1.15', 'default' => 'null', ], 'FlinkImageRegistry' => [ 'title' => 'Flink镜像地址', 'description' => 'Flink镜像地址', 'type' => 'string', 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com/xxxx/flink:1.15.4-scala_2.12', 'default' => 'null', ], 'FlinkImageRepository' => [ 'title' => 'Flink镜像仓库', 'description' => 'Flink镜像仓库', 'type' => 'string', 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com', 'default' => 'null', ], 'FlinkImageTag' => [ 'title' => 'Flink镜像标签', 'description' => 'Flink镜像标签', 'type' => 'string', 'example' => '1.15.4', 'default' => 'null', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"61187014-a3ba-4cdd-8609-1f0aa3df4a3d\\",\\n \\"QueueName\\": \\"default-queue\\",\\n \\"MaxVcore\\": \\"10\\",\\n \\"Namespace\\": \\"dataphinv45prod\\",\\n \\"CreateAt\\": \\"2024-10-31 10:29:17\\",\\n \\"ModifiedAt\\": \\"2024-10-31 10:29:17\\",\\n \\"Annotations\\": \\"{ \\\\\\"creator\\\\\\": \\\\\\"new_datasource@test.aliyunid.com\\\\\\", \\\\\\"modifier\\\\\\": \\\\\\"new_datasource@test.aliyunid.com\\\\\\" }\\",\\n \\"Labels\\": \\"cdh\\",\\n \\"ResourceVersion\\": \\"1\\",\\n \\"Spec\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"kind\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"kubernetes\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"kubernetes\\\\\\\\{\\\\\\"namespace\\\\\\" : \\\\\\"n1730341728989z7\\\\\\", \\\\\\"clusterName\\\\\\" : \\\\\\"a51578bdcce145\\\\\\" }, \\\\\\"state\\\\\\" : \\\\\\"ONLINE\\\\\\"}\\",\\n \\"VvpClusterType\\": \\"PREJOB\\",\\n \\"FlinkVersion\\": \\"1.15\\",\\n \\"FlinkImageRegistry\\": \\"xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com/xxxx/flink:1.15.4-scala_2.12\\",\\n \\"FlinkImageRepository\\": \\"xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com\\",\\n \\"FlinkImageTag\\": \\"1.15.4\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取环境集群队列信息', ], 'CreateStreamBatchJobMapping' => [ 'summary' => '创建流批一体任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [ 'Dataphin公共云', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'StreamBatchJobMappingCreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '流批一体任务信息', 'description' => '流批一体任务信息', 'type' => 'object', 'properties' => [ 'Env' => [ 'title' => '环境', 'description' => '环境', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'EngineVersion' => [ 'title' => 'flink引擎版本', 'description' => 'flink引擎版本', 'type' => 'string', 'required' => true, 'example' => 'vvr-8.0.9-flink-1.17', ], 'ClusterId' => [ 'title' => '集群ID', 'description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d', ], 'QueueName' => [ 'title' => '队列名', 'description' => '队列名', 'type' => 'string', 'required' => true, 'example' => 'default-queue', ], 'Directory' => [ 'title' => '任务生成的目录', 'description' => '任务生成的目录', 'type' => 'string', 'required' => true, 'example' => '/karel', ], 'FileName' => [ 'title' => '文件名', 'description' => '文件名', 'type' => 'string', 'required' => true, 'example' => 'karel_hover_3', ], 'FileType' => [ 'title' => '文件类型', 'description' => '文件类型', 'type' => 'string', 'required' => true, 'example' => 'FLINK_SQL', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752', ], 'VvpClusterType' => [ 'title' => 'SESSION 或PREJOB,vvp专用，如果没有就不传或者为空', 'description' => 'SESSION 或PREJOB,vvp专用，如果没有就不传或者为空', 'type' => 'string', 'required' => true, 'example' => 'PREJOB', ], 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => '这是一段任务的描述信息', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '任务创建成功的返回结果', 'description' => '任务创建成功的返回结果', 'type' => 'object', 'properties' => [ 'FileId' => [ 'title' => '作业文件ID', 'description' => '作业文件ID', 'type' => 'string', 'example' => '7083701105376640', ], 'Url' => [ 'title' => '跳转相对路径', 'description' => '跳转相对路径', 'type' => 'string', 'example' => '/dev/streamJob/7083701105376640?env=DEV&projectId=7081229106458752&tenantId=300001420', ], 'JobId' => [ 'description' => 'JobId', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"FileId\\": \\"7083701105376640\\",\\n \\"Url\\": \\"/dev/streamJob/7083701105376640?env=DEV&projectId=7081229106458752&tenantId=300001420\\",\\n \\"JobId\\": 123123\\n }\\n}","type":"json"}]', 'title' => '创建流批一体任务', ], 'GetResource' => [ 'summary' => '获取资源文件详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '资源文件名', 'description' => '资源文件名', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ResourceInfo' => [ 'title' => '资源文件详情', 'description' => '资源文件详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '资源id', 'description' => '资源id', 'type' => 'integer', 'format' => 'int64', 'example' => '10200121011', ], 'Name' => [ 'title' => '资源文件名', 'description' => '资源文件名', 'type' => 'string', 'example' => 'udf_sleep.jar', ], 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'JAR', ], 'Directory' => [ 'title' => '存放目录', 'description' => '存放目录', 'type' => 'string', 'example' => '/', ], 'StorageAddress' => [ 'title' => '资源存储地址', 'description' => '资源存储地址', 'type' => 'string', 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c', ], 'Size' => [ 'title' => '资源大小, 单位：b', 'description' => '资源大小, 单位：b', 'type' => 'integer', 'format' => 'int64', 'example' => '102400', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '测试', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'ComputeEngineType' => [ 'title' => '计算引擎源类型', 'description' => '计算引擎源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30011021', ], 'LastModifier' => [ 'title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '30011021', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ResourceInfo\\": {\\n \\"Id\\": 10200121011,\\n \\"Name\\": \\"udf_sleep.jar\\",\\n \\"ProjectId\\": 1030111021,\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Directory\\": \\"/\\",\\n \\"StorageAddress\\": \\"300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c\\",\\n \\"Size\\": 102400,\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"ComputeEngineType\\": \\"MAX_COMPUTE\\",\\n \\"Creator\\": \\"30011021\\",\\n \\"LastModifier\\": \\"30011021\\"\\n }\\n}","type":"json"}]', 'title' => '获取资源文件详情', ], 'GetResourceByVersion' => [ 'summary' => '获取资源文件指定版本详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '资源文件名', 'description' => '资源文件名', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ResourceInfo' => [ 'title' => '资源文件详情', 'description' => '资源文件详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '资源id', 'description' => '资源id', 'type' => 'integer', 'format' => 'int64', 'example' => '10200121011', ], 'Name' => [ 'title' => '资源文件名', 'description' => '资源文件名', 'type' => 'string', 'example' => 'udf_sleep.jar', ], 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'JAR', ], 'Directory' => [ 'title' => '存放目录', 'description' => '存放目录', 'type' => 'string', 'example' => '/', ], 'StorageAddress' => [ 'title' => '资源存储地址', 'description' => '资源存储地址', 'type' => 'string', 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c', ], 'Size' => [ 'title' => '资源大小, 单位：b', 'description' => '资源大小, 单位：b', 'type' => 'integer', 'format' => 'int64', 'example' => '102400', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '测试', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'ComputeEngineType' => [ 'title' => '计算引擎源类型', 'description' => '计算引擎源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30011021', ], 'LastModifier' => [ 'title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '30011021', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ResourceInfo\\": {\\n \\"Id\\": 10200121011,\\n \\"Name\\": \\"udf_sleep.jar\\",\\n \\"ProjectId\\": 1030111021,\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Directory\\": \\"/\\",\\n \\"StorageAddress\\": \\"300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c\\",\\n \\"Size\\": 102400,\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"ComputeEngineType\\": \\"MAX_COMPUTE\\",\\n \\"Creator\\": \\"30011021\\",\\n \\"LastModifier\\": \\"30011021\\"\\n }\\n}","type":"json"}]', 'title' => '获取资源文件指定版本详情', ], 'UpdateResource' => [ 'summary' => '编辑资源文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '编辑命令', 'description' => '编辑命令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '资源Id', 'description' => '资源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10112101', ], 'Name' => [ 'title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'StorageAddress' => [ 'title' => '资源存储地址', 'description' => '资源存储地址', 'type' => 'string', 'required' => true, 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c', ], 'Description' => [ 'title' => '资源描述', 'description' => '资源描述', 'type' => 'string', 'required' => true, 'example' => 'xx 测试', ], 'Comment' => [ 'title' => '提交备注', 'description' => '提交备注', 'type' => 'string', 'required' => true, 'example' => 'xx 测试', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], 'ComputeEngineType' => [ 'title' => '计算引擎类型: MAX_COMPUTE、HADOOP', 'description' => '计算引擎类型: MAX_COMPUTE、HADOOP', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '编辑资源文件', ], 'GetFileStorageCredential' => [ 'summary' => '获取文件存储临时读写授权。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id，临时授权用于创建资源文件时必填', 'description' => '项目Id，临时授权用于创建资源文件时必填', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1030131021', ], ], [ 'name' => 'UseVpcEndpoint', 'in' => 'query', 'schema' => [ 'title' => '使用内网地址, 默认：false', 'description' => '使用内网地址, 默认：false', 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'Purpose', 'in' => 'query', 'schema' => [ 'title' => '用途: RESOURCE 创建资源文件、COMPUTE_SOURCE_SETTING 存储计算源配置、NONE 无明确用途；默认：NONE', 'description' => '用途: RESOURCE 创建资源文件、COMPUTE_SOURCE_SETTING 存储计算源配置、NONE 无明确用途；默认：NONE', 'type' => 'string', 'required' => false, 'example' => 'RESOURCE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'StorageCredential' => [ 'title' => '临时读写授权详情', 'description' => '临时读写授权详情', 'type' => 'object', 'properties' => [ 'StorageType' => [ 'title' => '存储集群类型: oss、ceph', 'description' => '存储集群类型: oss、ceph', 'type' => 'string', 'example' => 'oss', ], 'Endpoint' => [ 'title' => '连接地址', 'description' => '连接地址', 'type' => 'string', 'example' => 'oss-cn-shanghai.aliyuncs.com', ], 'Bucket' => [ 'title' => '文件存储bucket', 'description' => '文件存储bucket', 'type' => 'string', 'example' => 'dataphin', ], 'Region' => [ 'title' => 'region', 'description' => 'region', 'type' => 'string', 'example' => 'cn-shanghai', ], 'AccessId' => [ 'title' => '临时AK', 'description' => '临时AK', 'type' => 'string', 'example' => 'temp.akId', ], 'AccessKey' => [ 'title' => '临时AK', 'description' => '临时AK', 'type' => 'string', 'example' => 'temp.akKey', ], 'ObjectName' => [ 'title' => '存储对象', 'description' => '存储对象', 'type' => 'string', 'example' => '1023231111/abc', ], 'Expiration' => [ 'title' => '到期时间', 'description' => '到期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '17343434343434', ], 'SecurityToken' => [ 'title' => '临时授权证书', 'description' => '临时授权证书', 'type' => 'string', 'example' => 'temp.token', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"StorageCredential\\": {\\n \\"StorageType\\": \\"oss\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Bucket\\": \\"dataphin\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"AccessId\\": \\"temp.akId\\",\\n \\"AccessKey\\": \\"temp.akKey\\",\\n \\"ObjectName\\": \\"1023231111/abc\\",\\n \\"Expiration\\": 17343434343434,\\n \\"SecurityToken\\": \\"temp.token\\"\\n }\\n}","type":"json"}]', 'title' => '获取文件存储临时读写授权', ], 'DeleteResource' => [ 'summary' => '删除资源文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '资源文件Id', 'description' => '资源文件Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10300010201', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => true, 'example' => '测试', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除资源文件', ], 'CreateResource' => [ 'summary' => '创建资源文件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建命令', 'description' => '创建命令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], 'Directory' => [ 'title' => '存放目录', 'description' => '存放目录', 'type' => 'string', 'required' => true, 'example' => '/', ], 'ResourceType' => [ 'title' => '资源类型: FILE: 普通文件、JAR: Jar文件、PYTHON: Python文件、OTHERS: 其他类型文件', 'description' => '资源类型: FILE: 普通文件、JAR: Jar文件、PYTHON: Python文件、OTHERS: 其他类型文件', 'type' => 'string', 'required' => true, 'example' => 'JAR', ], 'StorageAddress' => [ 'title' => '资源存储地址', 'description' => '资源存储地址', 'type' => 'string', 'required' => true, 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c', ], 'Description' => [ 'title' => '资源描述', 'description' => '资源描述', 'type' => 'string', 'required' => true, 'example' => 'xx 测试', ], 'Comment' => [ 'title' => '提交备注', 'description' => '提交备注', 'type' => 'string', 'required' => true, 'example' => 'xx 测试', ], 'ComputeEngineType' => [ 'title' => '计算引擎类型: MAX_COMPUTE、HADOOP、NONE', 'description' => '计算引擎类型: MAX_COMPUTE、HADOOP、NONE', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '资源文件Id', 'description' => '资源文件Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10112101', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 10112101\\n}","type":"json"}]', 'title' => '创建资源文件', ], 'GetUdf' => [ 'summary' => '获取自定义函数详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'UdfInfo' => [ 'title' => '自定义函数详情', 'description' => '自定义函数详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'Name' => [ 'title' => '函数名', 'description' => '函数名', 'type' => 'string', 'example' => 'udf_to_lower', ], 'ComputeEngineType' => [ 'title' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', 'description' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', 'type' => 'string', 'example' => 'HADOOP', ], 'Directory' => [ 'title' => '存放目录', 'description' => '存放目录', 'type' => 'string', 'example' => '/', ], 'ClassName' => [ 'title' => '注册类名', 'description' => '注册类名', 'type' => 'string', 'example' => 'com.lydaas.dataphin.UdfTest', ], 'Category' => [ 'title' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'description' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CommandHelp' => [ 'title' => '命令帮助', 'description' => '命令帮助', 'type' => 'string', 'example' => 'udf_to_lower(char x)', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-d HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-d HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012110', ], 'LastModifier' => [ 'title' => '最后更新人', 'description' => '最后更新人', 'type' => 'string', 'example' => '30012110', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"UdfInfo\\": {\\n \\"Id\\": 1030111021,\\n \\"Name\\": \\"udf_to_lower\\",\\n \\"ComputeEngineType\\": \\"HADOOP\\",\\n \\"Directory\\": \\"/\\",\\n \\"ClassName\\": \\"com.lydaas.dataphin.UdfTest\\",\\n \\"Category\\": 10,\\n \\"CommandHelp\\": \\"udf_to_lower(char x)\\",\\n \\"Description\\": \\"test\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"Creator\\": \\"30012110\\",\\n \\"LastModifier\\": \\"30012110\\"\\n }\\n}","type":"json"}]', 'title' => '获取自定义函数详情', ], 'GetUdfByVersion' => [ 'summary' => '查询自定义函数版本详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'UdfInfo' => [ 'title' => '自定义函数详情', 'description' => '自定义函数详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021', ], 'Name' => [ 'title' => '函数名', 'description' => '函数名', 'type' => 'string', 'example' => 'udf_to_lower', ], 'ComputeEngineType' => [ 'title' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', 'description' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', 'type' => 'string', 'example' => 'HADOOP', ], 'Directory' => [ 'title' => '存放目录', 'description' => '存放目录', 'type' => 'string', 'example' => '/', ], 'ClassName' => [ 'title' => '注册类名', 'description' => '注册类名', 'type' => 'string', 'example' => 'com.lydaas.dataphin.UdfTest', ], 'Category' => [ 'title' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'description' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CommandHelp' => [ 'title' => '命令帮助', 'description' => '命令帮助', 'type' => 'string', 'example' => 'udf_to_lower(char x)', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'GmtCreate' => [ 'title' => '创建时间, 格式：yyyy-MM-d HH:mm:ss', 'description' => '创建时间, 格式：yyyy-MM-d HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'GmtModified' => [ 'title' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', 'description' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', 'type' => 'string', 'example' => '2025-06-10 10:01:01', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012110', ], 'LastModifier' => [ 'title' => '最后更新人', 'description' => '最后更新人', 'type' => 'string', 'example' => '30012110', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"UdfInfo\\": {\\n \\"Id\\": 1030111021,\\n \\"Name\\": \\"udf_to_lower\\",\\n \\"ComputeEngineType\\": \\"HADOOP\\",\\n \\"Directory\\": \\"/\\",\\n \\"ClassName\\": \\"com.lydaas.dataphin.UdfTest\\",\\n \\"Category\\": 10,\\n \\"CommandHelp\\": \\"udf_to_lower(char x)\\",\\n \\"Description\\": \\"test\\",\\n \\"GmtCreate\\": \\"2025-06-10 10:01:01\\",\\n \\"GmtModified\\": \\"2025-06-10 10:01:01\\",\\n \\"Creator\\": \\"30012110\\",\\n \\"LastModifier\\": \\"30012110\\"\\n }\\n}","type":"json"}]', 'title' => '查询自定义函数指定版本详情', ], 'UpdateUdf' => [ 'summary' => '编辑自定义函数。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建命令', 'description' => '创建命令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], 'RefResourceIdList' => [ 'title' => '引用资源id', 'description' => '引用资源id', 'type' => 'array', 'items' => [ 'title' => '引用资源id', 'description' => '引用资源id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10200121011', ], 'required' => true, ], 'ClassName' => [ 'title' => '资源中实现函数的类名', 'description' => '资源中实现函数的类名', 'type' => 'string', 'required' => true, 'example' => 'com.lydaas.SleepTest', ], 'Category' => [ 'title' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'description' => '类目: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'CommandHelp' => [ 'title' => '函数调用的命令格式', 'description' => '函数调用的命令格式', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep(100)', ], 'Comment' => [ 'title' => '提交备注', 'description' => '提交备注', 'type' => 'string', 'required' => true, 'example' => '测试', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '编辑自定义函数', ], 'DeleteUdf' => [ 'summary' => '删除自定义函数。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '自定义函数Id', 'description' => '自定义函数Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10300010201', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => true, 'example' => '测试', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除自定义函数', ], 'CreateUdf' => [ 'summary' => '创建自定义函数。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建命令', 'description' => '创建命令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'udf_sleep', 'description' => '函数名', 'type' => 'string', 'required' => true, 'example' => 'my_udf', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833', ], 'ComputeEngineType' => [ 'title' => '计算引擎类型: MAX_COMPUTE、HADOOP', 'description' => '计算引擎类型: MAX_COMPUTE、HADOOP', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE', ], 'Directory' => [ 'title' => '存放目录, 默认：/', 'description' => '存放目录', 'type' => 'string', 'required' => false, 'example' => '/', ], 'RefResourceIdList' => [ 'title' => '引用资源id', 'description' => '引用资源id', 'type' => 'array', 'items' => [ 'title' => '引用资源id', 'description' => '引用资源id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10200121011', ], 'required' => true, ], 'ClassName' => [ 'title' => '资源中实现函数的类名', 'description' => '资源中实现函数的类名', 'type' => 'string', 'required' => true, 'example' => 'com.lydaas.SleepTest', ], 'Category' => [ 'title' => 'UDF的分类标识: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'description' => 'UDF的分类标识: 1 窗口函数、2 统计函数、3 数值函数、4 字符串函数、5 时间函数、6 IP地址辅助函数、7 URL相关函数、8 编解码函数、9 业务相关函数、10 其他', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => true, 'example' => '测试', ], 'CommandHelp' => [ 'title' => '函数调用的命令格式', 'description' => '函数调用的命令格式', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep(100)', ], 'Comment' => [ 'title' => '提交备注', 'description' => '提交备注', 'type' => 'string', 'required' => true, 'example' => '测试', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '函数Id', 'description' => '函数Id', 'type' => 'integer', 'format' => 'int64', 'example' => '10212101', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 10212101\\n}","type":"json"}]', 'title' => '创建自定义函数', ], 'ListSubmitRecords' => [ 'summary' => '分页获取待发布记录列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询指令', 'description' => '查询指令', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'SearchFilter' => [ 'title' => '待发布记录过滤器', 'description' => '待发布记录过滤器', 'type' => 'object', 'properties' => [ 'ProjectIdList' => [ 'title' => '项目id列表', 'description' => '项目ID', 'type' => 'array', 'items' => [ 'title' => '项目id', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '121321313519086', ], 'required' => true, ], 'SubmitterList' => [ 'title' => '提交人id列表', 'description' => '提交人', 'type' => 'array', 'items' => [ 'title' => '提交人id', 'description' => '提交人', 'type' => 'string', 'required' => true, 'example' => '3434222', ], 'required' => false, ], 'ChangeTypeList' => [ 'title' => '变更类型列表（0:新增/1:更新/2:删除', 'description' => '变更类型列表（0:新增/1:更新/2:删除', 'type' => 'array', 'items' => [ 'title' => '变更类型', 'description' => '变更类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'required' => false, ], 'SubmitStartTime' => [ 'title' => '提交开始时间 yyyy-MM-dd HH:mm:ss', 'description' => '提交开始时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00', ], 'SubmitEndTime' => [ 'title' => '提交结束时间 yyyy-MM-dd HH:mm:ss', 'description' => '提交结束时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页条数', 'description' => '分页条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ListResult' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Data' => [ 'title' => '待发布记录列表查询结果', 'description' => '待发布记录列表查询结果', 'type' => 'array', 'items' => [ 'title' => '待发布记录', 'description' => '待发布记录', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '待发布记录id（非对象ID，在发布列表中全局唯一', 'description' => '待发布记录id', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456', ], 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '1241844456', ], 'Submitter' => [ 'title' => '提交人id', 'description' => '提交人id', 'type' => 'string', 'example' => '307999999', ], 'SubmitterName' => [ 'title' => '提交人名称', 'description' => '提交人名称', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间 yyyy-MM-dd HH:mm:ss', 'description' => '创建时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModify' => [ 'title' => '修改时间 yyyy-MM-dd HH:mm:ss', 'description' => '修改时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'ChangeType' => [ 'title' => '变更类型 0:新增/1:更新/2:删除', 'description' => '变更类型 0:新增/1:更新/2:删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ObjectType' => [ 'title' => '对象类型', 'description' => '对象类型'."\n" .'- MAXCOUPUTE_SQL任务:MAX_COMPUTE_SQL'."\n" .'- MAXCOUPUTE_MR任务:MAX_COMPUTE_MR'."\n" .'- SPARK_JAR_ON_MAX_COMPUTE:SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- SHELL任务:SHELL'."\n" .'- PYTHON任务:PYTHON'."\n" .'- Perl脚本:PERL'."\n" .'- CHECK:CHECK'."\n" .'- 同步任务:DATA_X'."\n" .'- 虚拟节点:VIRTUAL'."\n" .'- 资源:IDE_RESOURCE'."\n" .'- 函数:UDF'."\n" .'- HIVE_SQL任务:HIVE_SQL'."\n" .'- HADOOP_MR任务:HADOOP_MR'."\n" .'- SPARK_JAR_ON_HIVE任务:SPARK_JAR_ON_HIVE'."\n" .'- FLINK_SQL任务:FLINK_SQL'."\n" .'- FLINK_SQL模板任务:FLINK_TEMPLATE_SQL'."\n" .'- 流计算模板:STREAM_TEMPLATE'."\n" .'- 元表:META_TABLE'."\n" .'- 流计算函数:STREAM_UDF'."\n" .'- 实时FLINK_DATASTREAM:FLINK_DATASTREAM'."\n" .'- 实时自定义数据源:STREAM_CUSTOM_DATASOURCE'."\n" .'- ADB_FOR_PG任务:ADB_FOR_PG'."\n" .'- TDH_SQL任务:INCEPTOR_SQL'."\n" .'- 镜像表:MIRROR_TABLE'."\n" .'- 中间表:MIDDLE_TABLE'."\n" .'- 应用表:APPLICATION_TABLE'."\n" .'- IMPALA_SQL任务:IMPALA_SQL'."\n" .'- 管道任务:OFFLINE_PIPELINE'."\n" .'- 实时管道任务:REAL_TIME_PIPELINE'."\n" .'- 维度逻辑表:DIM_LOGICAL_TABLE'."\n" .'- 事实逻辑表:FCT_LOGICAL_TABLE'."\n" .'- 业务限定:BIZ_CONDITION'."\n" .'- 原子指标:ATOM_INDEX'."\n" .'- 派生指标:DERIVED_INDEX'."\n" .'- 衍生指标:CALC_DERIVED_INDEX'."\n" .'- PAI任务:PAI_DESIGNER'."\n" .'- ARGODB_SQL任务:ARGODB_SQL'."\n" .'- HOLOGRES_SQL任务:HOLOGRES_SQL'."\n" .'- IMPALA_SQL任务:IMPALA_SQL'."\n" .'- STARROCKS_SQL任务:STARROCKS_SQL'."\n" .'- 数据库SQL任务:DATABASE_SQL'."\n" .'- SPARK_SQL任务:SPARK_SQL'."\n" .'- 计算模板:TASK_TEMPLATE'."\n" .'- 外部触发节点:EXTERNAL_TRIGGER'."\n" .'- GAUSS_SQL任务:GAUSS_SQL', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'ObjectName' => [ 'title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'example' => '对象A', ], 'ObjectId' => [ 'title' => '对象id', 'description' => '对象id', 'type' => 'string', 'example' => '1234567', ], 'NodeId' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'string', 'example' => 'n_123456', ], 'ObjectVersion' => [ 'title' => '对象版本', 'description' => '对象版本', 'type' => 'string', 'example' => '1', ], 'SubmitComment' => [ 'title' => '提交信息', 'description' => '提交信息', 'type' => 'string', 'example' => '提交信息', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ListResult\\": {\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 1241844456,\\n \\"ProjectId\\": \\"1241844456\\",\\n \\"Submitter\\": \\"307999999\\",\\n \\"SubmitterName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModify\\": \\"2024-10-10 10:00:00\\",\\n \\"ChangeType\\": 0,\\n \\"ObjectType\\": \\"2024-10-10 10:00:00\\",\\n \\"ObjectName\\": \\"对象A\\",\\n \\"ObjectId\\": \\"1234567\\",\\n \\"NodeId\\": \\"n_123456\\",\\n \\"ObjectVersion\\": \\"1\\",\\n \\"SubmitComment\\": \\"提交信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询待发布记录', ], 'GetLatestSubmitDetail' => [ 'summary' => '获取最新的待发布记录详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SubmitDetailQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '待发布查询请求', 'description' => '待发布查询请求', 'type' => 'object', 'properties' => [ 'ObjectId' => [ 'title' => '对象id', 'description' => '对象id', 'type' => 'string', 'required' => true, 'example' => '12345', ], 'ObjectType' => [ 'title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE_SQL', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'SubmitDetailResult' => [ 'title' => '待发布详情', 'description' => '待发布详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '提交记录id', 'description' => '提交记录id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'SubmitStatus' => [ 'title' => '待发布记录状态 待发布:TO_BE_PUBLISHED/已发布:PUBLISHED/发布中:PUBLISHING', 'description' => '待发布记录状态 '."\n" ."\n" .'- 待发布:TO_BE_PUBLISHED'."\n" ."\n" .'- 已发布:PUBLISHED'."\n" ."\n" .'- 发布中:PUBLISHING', 'type' => 'string', 'example' => 'TO_BE_PUBLISHED', ], 'PublishStatus' => [ 'title' => '发布记录状态 未校验:NOT_VERIFIED/审批中:APPROVING/审批失败:APPROVE_FAILED/审批成功:APPROVE_SUCCESS/审批撤回:APPROVE_REVOKED/发布校验中:CHECKING/发布校验失败:CHECK_FAILED/发布校验成功:CHECK_SUCCESS/发布中:PUBLISHING/发布失败:FAILED/发布成功:SUCCESS', 'description' => '发布记录状态 '."\n" .'- 未校验:NOT_VERIFIED'."\n" .'- 审批中:APPROVING'."\n" .'- 审批失败:APPROVE_FAILED'."\n" .'- 审批成功:APPROVE_SUCCESS'."\n" .'- 审批撤回:APPROVE_REVOKED'."\n" .'- 发布校验中:CHECKING'."\n" .'- 发布校验失败:CHECK_FAILED'."\n" .'- 发布校验成功:CHECK_SUCCESS'."\n" .'- 发布中:PUBLISHING'."\n" .'- 发布失败:FAILED'."\n" .'- 发布成功:SUCCESS', 'type' => 'string', 'example' => 'SUCCESS', ], 'Tag' => [ 'title' => '记录Tag', 'description' => '记录Tag', 'type' => 'string', 'example' => 'tag', ], 'ReleaseObject' => [ 'title' => '待发布记录对象', 'description' => '待发布记录对象', 'type' => 'object', 'properties' => [ 'ObjectVersion' => [ 'title' => '对象版本', 'description' => '对象版本', 'type' => 'string', 'example' => '1', ], 'ChangeType' => [ 'title' => '变更类型列表（新增:CREATE/更新:UPDATE/删除:DELETE', 'description' => '变更类型列表（新增:CREATE/更新:UPDATE/删除:DELETE', 'type' => 'string', 'example' => 'DELETE', ], 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'NodeId' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'string', 'example' => 'n_1234', ], 'SubmitComment' => [ 'title' => '提交说明', 'description' => '提交说明', 'type' => 'string', 'example' => '提交说明', ], 'SubmitObject' => [ 'title' => '发布对象', 'description' => '发布对象', 'type' => 'object', 'properties' => [ 'ObjectId' => [ 'title' => '对象id', 'description' => '对象id', 'type' => 'string', 'example' => '1234', ], 'ObjectType' => [ 'title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'example' => 'MAX_COMPUTE_SQL', ], 'ObjectName' => [ 'title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'example' => 'abc', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitDetailResult\\": {\\n \\"Id\\": 1234,\\n \\"SubmitStatus\\": \\"TO_BE_PUBLISHED\\",\\n \\"PublishStatus\\": \\"SUCCESS\\",\\n \\"Tag\\": \\"tag\\",\\n \\"ReleaseObject\\": {\\n \\"ObjectVersion\\": \\"1\\",\\n \\"ChangeType\\": \\"DELETE\\",\\n \\"ProjectId\\": 1234,\\n \\"NodeId\\": \\"n_1234\\",\\n \\"SubmitComment\\": \\"提交说明\\",\\n \\"SubmitObject\\": {\\n \\"ObjectId\\": \\"1234\\",\\n \\"ObjectType\\": \\"MAX_COMPUTE_SQL\\",\\n \\"ObjectName\\": \\"abc\\"\\n }\\n }\\n }\\n}","type":"json"}]', 'title' => '获取最近一条提交详情', ], 'PublishObjectList' => [ 'summary' => '批量发布对象。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PublishCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '发布指令', 'description' => '发布指令', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567', ], 'SubmitIdList' => [ 'title' => '要发布的待发布项，待发布记录ID列表（submitIds个数限制50)', 'description' => '要发布的待发布项，待发布记录ID列表（submitIds个数限制50)', 'type' => 'array', 'items' => [ 'title' => '待发布记录id', 'description' => '待发布记录id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', ], 'required' => true, ], 'Comment' => [ 'title' => '发布信息(字符串长度限制1024)', 'description' => '发布信息(字符串长度限制1024)', 'type' => 'string', 'required' => true, 'example' => '发布', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PublishResult' => [ 'title' => '发布结果', 'description' => '发布结果', 'type' => 'object', 'properties' => [ 'SubmitIdList' => [ 'title' => '待发布记录id列表', 'description' => '待发布记录id列表', 'type' => 'array', 'items' => [ 'title' => '待发布记录id', 'description' => '待发布记录id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PublishResult\\": {\\n \\"SubmitIdList\\": [\\n 12345\\n ]\\n }\\n}","type":"json"}]', 'title' => '批量发布对象', ], 'ListPublishRecords' => [ 'summary' => '分页获取发布记录列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询指令', 'description' => '查询指令', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'SearchFilter' => [ 'title' => '发布记录过滤器', 'description' => '发布记录过滤器', 'type' => 'object', 'properties' => [ 'ProjectIdList' => [ 'title' => '项目id列表', 'description' => '项目id列表', 'type' => 'array', 'items' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890', ], 'required' => true, ], 'SubmitterList' => [ 'title' => '提交人id列表', 'description' => '提交人id列表', 'type' => 'array', 'items' => [ 'title' => '提交人id', 'description' => '提交人id', 'type' => 'string', 'required' => true, 'example' => '30897000', ], 'required' => false, ], 'ChangeTypeList' => [ 'title' => '变更类型列表（0:新增/1:更新/2:删除', 'description' => '变更类型列表（0:新增/1:更新/2:删除', 'type' => 'array', 'items' => [ 'title' => '变更类型', 'description' => '变更类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'required' => false, ], 'PublishStatusList' => [ 'title' => '发布状态列表（0:失败/1:成功/2:发布中', 'description' => '发布状态列表（0:失败/1:成功/2:发布中', 'type' => 'array', 'items' => [ 'title' => '发布状态', 'description' => '发布状态', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'required' => false, ], 'PublishStartTime' => [ 'title' => '发布开始时间 yyyy-MM-dd HH:mm:ss', 'description' => '发布开始时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00', ], 'PublishEndTime' => [ 'title' => '发布结束时间 yyyy-MM-dd HH:mm:ss', 'description' => '发布结束时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页条数', 'description' => '分页条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ListResult' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Data' => [ 'title' => '发布记录列表查询结果', 'description' => '发布记录列表查询结果', 'type' => 'array', 'items' => [ 'title' => '发布记录', 'description' => '发布记录', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '发布记录id（非对象ID，在发布列表中全局唯一', 'description' => '发布记录id（非对象ID，在发布列表中全局唯一', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456', ], 'PublishName' => [ 'title' => '发布名称', 'description' => '发布名称', 'type' => 'string', 'example' => 'test_lc__20241118171502', ], 'ProjectId' => [ 'title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '1241844456', ], 'Publisher' => [ 'title' => '发布人id', 'description' => '发布人id', 'type' => 'string', 'example' => '307999999', ], 'PublisherName' => [ 'title' => '发布人名称', 'description' => '发布人名称', 'type' => 'string', 'example' => '张三', ], 'GmtCreate' => [ 'title' => '创建时间 yyyy-MM-dd HH:mm:ss', 'description' => '创建时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'GmtModify' => [ 'title' => '修改时间 yyyy-MM-dd HH:mm:ss', 'description' => '修改时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'ChangeType' => [ 'title' => '变更类型 0:新增/1:更新/2:删除', 'description' => '变更类型 0:新增/1:更新/2:删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ObjectType' => [ 'title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'example' => '2024-10-10 10:00:00', ], 'ObjectName' => [ 'title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'example' => '对象A', ], 'ObjectId' => [ 'title' => '对象id', 'description' => '对象id', 'type' => 'string', 'example' => '1234567', ], 'NodeId' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'string', 'example' => 'n_123456', ], 'ObjectVersion' => [ 'title' => '对象版本', 'description' => '对象版本', 'type' => 'string', 'example' => '1', ], 'FinishTime' => [ 'title' => '发布完成时间 yyyy-MM-dd HH:mm:ss', 'description' => '发布完成时间 yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-10 10:10:10', ], 'ErrorMessage' => [ 'title' => '发布错误信息', 'description' => '发布错误信息', 'type' => 'string', 'example' => 'error', ], 'PublishStatus' => [ 'title' => '发布状态 0：失败/1：成功/2：发布中', 'description' => '发布状态 0：失败/1：成功/2：发布中', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ListResult\\": {\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 1241844456,\\n \\"PublishName\\": \\"test_lc__20241118171502\\",\\n \\"ProjectId\\": \\"1241844456\\",\\n \\"Publisher\\": \\"307999999\\",\\n \\"PublisherName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2024-10-10 10:00:00\\",\\n \\"GmtModify\\": \\"2024-10-10 10:00:00\\",\\n \\"ChangeType\\": 0,\\n \\"ObjectType\\": \\"2024-10-10 10:00:00\\",\\n \\"ObjectName\\": \\"对象A\\",\\n \\"ObjectId\\": \\"1234567\\",\\n \\"NodeId\\": \\"n_123456\\",\\n \\"ObjectVersion\\": \\"1\\",\\n \\"FinishTime\\": \\"2024-10-10 10:10:10\\",\\n \\"ErrorMessage\\": \\"error\\",\\n \\"PublishStatus\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询发布记录', ], 'UpdateStandardWordRoot' => [ 'summary' => '更新数据标准词根。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'OldName' => [ 'title' => '更新前词根名称', 'description' => '更新前词根名称', 'type' => 'string', 'required' => true, 'example' => '平均值', ], 'Name' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'required' => true, 'example' => '平均值', ], 'FullName' => [ 'title' => '词根全称', 'description' => '词根全称', 'type' => 'string', 'required' => true, 'example' => 'average', ], 'Abbreviation' => [ 'title' => '词根缩写', 'description' => '词根缩写', 'type' => 'string', 'required' => true, 'example' => 'avg', ], 'Description' => [ 'title' => '词根描述', 'description' => '词根描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新数据标准词根', ], 'UpdateStandardTemplate' => [ 'summary' => '更新数据标准模板。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Version' => [ 'title' => '版本号, 空或-1表示最新版本', 'description' => '版本号, 空或-1表示最新版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '标准模板名称', 'description' => '标准模板名称', 'type' => 'string', 'required' => true, 'example' => '测试模板', ], 'Code' => [ 'title' => '标准模板编码, 全局唯一;有引用时不可修改', 'description' => '标准模板编码, 全局唯一;有引用时不可修改', 'type' => 'string', 'required' => true, 'example' => 'test01', ], 'Description' => [ 'title' => '标准模板描述', 'description' => '标准模板描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'MaintainerList' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'array', 'items' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'AttributesConfig' => [ 'title' => '属性配置', 'description' => '属性配置', 'type' => 'object', 'properties' => [ 'AttributeList' => [ 'title' => '属性列表', 'description' => '属性列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '属性名称', 'description' => '属性名称，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'attr1', ], 'Code' => [ 'title' => '属性编码', 'description' => '属性编码，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'test_attr', ], 'Type' => [ 'title' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'description' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'BIZ_ATTRIBUTE', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填，引用公共属性时非必填', 'type' => 'boolean', 'required' => false, ], 'ValueConfig' => [ 'title' => '取值配置', 'description' => '取值配置，引用公共属性时非必填', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'description' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'description' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'type' => 'string', 'required' => true, 'example' => 'STRING', ], 'Length' => [ 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'description' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ValueRange' => [ 'title' => '取值范围', 'description' => '取值范围', 'type' => 'object', 'properties' => [ 'ValueConstraint' => [ 'title' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'description' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'type' => 'string', 'required' => true, 'example' => 'NONE', ], 'ValueList' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'array', 'items' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, ], 'MinMaxValueConfig' => [ 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'description' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'type' => 'object', 'properties' => [ 'MinValue' => [ 'title' => '最小值', 'description' => '最小值', 'type' => 'string', 'required' => true, 'example' => '0', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', 'required' => true, ], 'MaxValue' => [ 'title' => '最大值', 'description' => '最大值', 'type' => 'string', 'required' => true, 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], 'LookupTableReference' => [ 'title' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'description' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'Column' => [ 'title' => '引用的码表字段', 'description' => '引用的码表字段', 'type' => 'string', 'required' => false, 'example' => 'col1', ], ], 'required' => false, ], 'DataphinAttributeType' => [ 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'description' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_ATTRIBUTE', ], ], 'required' => true, ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'RefAttribute' => [ 'title' => '引用的属性信息', 'description' => '引用的属性信息', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'AttributeFromInfo' => [ 'title' => '属性来源', 'description' => '属性来源', 'type' => 'object', 'properties' => [ 'AttributeFrom' => [ 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'description' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'type' => 'string', 'required' => true, 'example' => 'CUSTOM', ], 'StandardReference' => [ 'title' => '对应的标准,属性来源为 STANDARD 生效', 'description' => '对应的标准,属性来源为 STANDARD 生效', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => false, ], ], 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'PublishInfo' => [ 'title' => '标准模板发布信息', 'description' => '标准模板发布信息', 'type' => 'object', 'properties' => [ 'Comment' => [ 'title' => '发布备注', 'description' => '发布备注', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'CodeRuleConfig' => [ 'title' => '标准编码自动生成规则配置', 'description' => '标准编码自动生成规则配置', 'type' => 'object', 'properties' => [ 'GenerateType' => [ 'title' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'description' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'AutoConfig' => [ 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'description' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'type' => 'object', 'properties' => [ 'NeedStrongValidate' => [ 'title' => '是否强校验', 'description' => '是否强校验', 'type' => 'boolean', 'required' => true, ], 'CodeRuleList' => [ 'title' => '标准编码规则', 'description' => '标准编码规则', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => '编码规则位置索引', 'description' => '编码规则位置索引', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'Type' => [ 'title' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'description' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'type' => 'string', 'required' => true, 'example' => 'FIXED_STRING', ], 'Value' => [ 'title' => '编码规则格式/值', 'description' => '编码规则格式/值', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'AutoIncrementSequenceConfig' => [ 'title' => '自增序列配置', 'description' => '自增序列配置', 'type' => 'object', 'properties' => [ 'Digit' => [ 'title' => '位数', 'description' => '位数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', ], 'StartValue' => [ 'title' => '起始值', 'description' => '起始值', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'Step' => [ 'title' => '步长', 'description' => '步长', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'NeedPaddingZero' => [ 'title' => '是否补零', 'description' => '是否补零', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新数据标准模板', ], 'UpdateStandardSet' => [ 'summary' => '更新标准集。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'StandardSetId' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Name' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Code' => [ 'title' => '标准集编码', 'description' => '标准集编码', 'type' => 'string', 'required' => true, 'example' => 'CITY', ], 'Description' => [ 'title' => '标准集描述', 'description' => '标准集描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '所属目录', 'description' => '所属目录', 'type' => 'string', 'required' => true, 'example' => '/dir1', ], ], 'required' => false, ], 'MaintainerList' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'array', 'items' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'MemberList' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'array', 'items' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'MemberGroupList' => [ 'title' => '成员组列表', 'description' => '成员组列表', 'type' => 'array', 'items' => [ 'title' => '成员组列表', 'description' => '成员组列表', 'type' => 'string', 'required' => false, 'example' => '1121', ], 'required' => false, ], 'VisibilityConfig' => [ 'title' => '可见性配置', 'description' => '可见性配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'description' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'type' => 'string', 'required' => true, 'example' => 'PUBLIC', ], 'SpecifiedUserList' => [ 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'description' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'type' => 'array', 'items' => [ 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'description' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'type' => 'string', 'required' => false, 'example' => '1121', ], 'required' => false, ], ], 'required' => false, ], 'ApprovalConfig' => [ 'title' => '上线审批配置', 'description' => '上线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', 'required' => true, ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', 'required' => true, ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], ], 'required' => false, ], 'OfflineApprovalConfig' => [ 'title' => '下线审批配置', 'description' => '下线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', 'required' => true, ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', 'required' => true, ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], ], 'required' => false, ], 'DefaultStandardTemplateId' => [ 'title' => '默认标准模板ID', 'description' => '默认标准模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1001', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新标准集', ], 'UpdateStandardMappingToInvalid' => [ 'summary' => '将标准映射关系置为无效映射。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'GuidList' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1022', ], 'required' => false, ], 'BelongGuidList' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1023', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '将标准映射关系置为无效映射', ], 'UpdateStandardLookupTable' => [ 'summary' => '更新数据标准码表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Name' => [ 'title' => '码表名称', 'description' => '码表名称', 'type' => 'string', 'required' => true, 'example' => '城市码表', ], 'Code' => [ 'title' => '码表编码', 'description' => '码表编码', 'type' => 'string', 'required' => true, 'example' => 'CITY', ], 'Description' => [ 'title' => '码表描述', 'description' => '码表描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Owner' => [ 'title' => '码表负责人Id，默认为调用者用户Id', 'description' => '码表负责人Id，默认为调用者用户Id', 'type' => 'string', 'required' => false, 'example' => '30012021', ], 'LookupTableValueList' => [ 'title' => '码表值列表', 'description' => '码表值列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '代码值', 'description' => '代码值', 'type' => 'string', 'required' => true, 'example' => '杭州', ], 'Name' => [ 'title' => '代码名称', 'description' => '代码名称', 'type' => 'string', 'required' => true, 'example' => 'Hangzhou', ], 'EnglishName' => [ 'title' => '代码英文名', 'description' => '代码英文名', 'type' => 'string', 'required' => false, 'example' => 'HZ', ], 'Description' => [ 'title' => '代码描述', 'description' => '代码描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'string', 'required' => true, 'example' => '/dir1/dir2', ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新数据标准码表', ], 'UpdateStandard' => [ 'summary' => '更新标准。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '码表', 'description' => '码表', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'StandardStatus' => [ 'title' => '标准的状态', 'description' => '标准的状态', 'type' => 'string', 'required' => true, 'example' => 'draft', ], 'StandardTemplateReference' => [ 'title' => '标准所属的标准模板', 'description' => '标准所属的标准模板', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板ID', 'description' => '标准模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'Version' => [ 'title' => '标准模板版本号, 默认去最新版本', 'description' => '标准模板版本号, 默认去最新版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'AttributeValueList' => [ 'title' => '引用模板下属性列表相应属性值, 若为空则使用默认值', 'description' => '引用模板下属性列表相应属性值, 若为空则使用默认值', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], 'StandardSetReference' => [ 'title' => '标准集的引用, 表示当前标准所属的标准集', 'description' => '标准集的引用, 表示当前标准所属的标准集', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], ], 'required' => true, ], 'EffectiveTimeConfig' => [ 'title' => '生效时间配置', 'description' => '生效时间配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'description' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'type' => 'string', 'required' => true, 'example' => 'TIME_PERIOD', ], 'StartTime' => [ 'title' => '开始生效时间', 'description' => '开始生效时间', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '结束生效时间', 'description' => '结束生效时间', 'type' => 'string', 'required' => false, 'example' => '2025-12-30 00:00:00', ], ], 'required' => false, ], 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Owner' => [ 'title' => '负责人,不传为当前用户', 'description' => '负责人,不传为当前用户', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'StandardGeneralMonitorConfig' => [ 'title' => '标准监控配置', 'description' => '标准监控配置', 'type' => 'object', 'properties' => [ 'StandardMonitorConfigList' => [ 'title' => '标准监控配置列表', 'description' => '标准监控配置列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'description' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Description' => [ 'title' => '规则描述', 'description' => '规则描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Type' => [ 'title' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'required' => true, 'example' => 'METADATA', ], 'MonitorFrom' => [ 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'description' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'type' => 'string', 'required' => true, 'example' => 'BY_SYSTEM_ATTRIBUTE', ], 'AttributeId' => [ 'title' => '关联的属性Id', 'description' => '关联的属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '112', ], 'AttributeName' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'required' => false, 'example' => 'teset', ], 'AttributeMonitorConfig' => [ 'title' => '关联属性的监控配置', 'description' => '关联属性的监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'required' => true, 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], 'RuleSubType' => [ 'title' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'description' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED', ], 'QualityRuleTemplate' => [ 'title' => '规则模板, 当监控类型为 QUALITY 时必填', 'description' => '规则模板, 当监控类型为 QUALITY 时必填', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板Id', 'description' => '模板Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Type' => [ 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'description' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], ], 'required' => false, ], 'RuleConfigList' => [ 'title' => '规则配置, 当监控类型为 QUALITY 时必填', 'description' => '规则配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => false, ], 'required' => false, ], 'RuleValidateConfigList' => [ 'title' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'description' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '校验配置Id, 由业务随机生成且确保唯一', 'description' => '校验配置Id, 由业务随机生成且确保唯一', 'type' => 'string', 'required' => true, 'example' => 'abc', ], 'ParentId' => [ 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', 'description' => '父校验配置Id, 父规则校验类型只能是RELATION', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'Type' => [ 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'description' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'type' => 'string', 'required' => true, 'example' => 'RELATION', ], 'Operator' => [ 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'description' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'type' => 'string', 'required' => true, 'example' => 'AND', ], 'Metric' => [ 'title' => '指标, 校验类型为 EXPRESSION 时必填', 'description' => '指标, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'MetricName' => [ 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', 'description' => '指标名称, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Value' => [ 'title' => '比较的值', 'description' => '比较的值', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], 'NeedGenerateStandardCode' => [ 'title' => '是否需要基于规则生成标准编码，如果为true则属性值部分填入的标准编码无效将重新生成', 'description' => '是否需要基于规则生成标准编码，如果为true则属性值部分填入的标准编码无效将重新生成', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新标准', ], 'OfflineStandard' => [ 'summary' => '下线标准。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '下线指令', 'description' => '下线指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Comment' => [ 'title' => '审核备注,最多128字符', 'description' => '审核备注,最多128字符', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '下线标准', ], 'PublishStandard' => [ 'summary' => '发布标准。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PublishCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '发布指令', 'description' => '发布指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Version' => [ 'title' => '版本号, 默认取值-1（最新版本号）', 'description' => '版本号, 默认取值-1（最新版本号）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'StandardStage' => [ 'title' => '标准的阶段 :DEV、PROD，默认 DEV', 'description' => '标准的阶段 :DEV、PROD，默认 DEV', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'AutoPublishAfterApproval' => [ 'title' => '是否在审批成功后自动发布， 默认 true', 'description' => '是否在审批成功后自动发布， 默认 true', 'type' => 'boolean', 'required' => false, ], 'ReviewerIdList' => [ 'title' => '指定的审批人', 'description' => '指定的审批人', 'type' => 'array', 'items' => [ 'title' => '指定的审批人', 'description' => '指定的审批人', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, ], 'Comment' => [ 'title' => '审核备注,最多128字符', 'description' => '审核备注,最多128字符', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '发布标准', ], 'ListStandards' => [ 'summary' => '分页查询标准列表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字: 标准名称/英文名/编码 模糊搜索,大小写不敏感,按匹配度排序', 'description' => '搜索关键字: 标准名称/英文名/编码 模糊搜索,大小写不敏感,按匹配度排序', 'type' => 'string', 'required' => false, 'example' => 'Test', ], 'Directory' => [ 'title' => '标准的所属目录', 'description' => '标准的所属目录', 'type' => 'string', 'required' => false, 'example' => '/dir1/dir2', ], 'StandardTypeList' => [ 'title' => '标准类型: Basic、EMPTY 标准类型为空', 'description' => '标准类型: Basic、EMPTY 标准类型为空', 'type' => 'array', 'items' => [ 'title' => '标准类型: Basic、EMPTY 标准类型为空', 'description' => '标准类型: Basic、EMPTY 标准类型为空', 'type' => 'string', 'required' => false, 'example' => 'EMPTY', ], 'required' => false, ], 'StandardStage' => [ 'title' => '标准所属阶段：DEV、PROD', 'description' => '标准所属阶段：DEV、PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV', ], 'StandardTemplateIdList' => [ 'title' => '所属标准模板Id', 'description' => '所属标准模板Id', 'type' => 'array', 'items' => [ 'title' => '所属标准模板Id', 'description' => '所属标准模板Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], 'StandardSetIdList' => [ 'title' => '所属标准集Id', 'description' => '所属标准集Id', 'type' => 'array', 'items' => [ 'title' => '所属标准集Id', 'description' => '所属标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], 'StandardStatusList' => [ 'title' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', 'description' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', 'type' => 'array', 'items' => [ 'title' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', 'description' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', 'type' => 'string', 'required' => false, 'example' => 'DRAFT', ], 'required' => false, ], 'UserId' => [ 'title' => '用户Id: 只会查询该用户Id本身可见的标准,为空则查询当前用户可见的标准', 'description' => '用户Id: 只会查询该用户Id本身可见的标准,为空则查询当前用户可见的标准', 'type' => 'string', 'required' => false, 'example' => '30012011', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'StandardList' => [ 'title' => '表列表', 'description' => '表列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '码表', 'description' => '码表', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Status' => [ 'title' => '标准的状态', 'description' => '标准的状态', 'type' => 'string', 'example' => 'draft', ], 'Stage' => [ 'title' => '标准所属的阶段', 'description' => '标准所属的阶段', 'type' => 'string', 'example' => 'dev', ], 'StandardTemplate' => [ 'title' => '当前标准依赖的标准模板', 'description' => '当前标准依赖的标准模板', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '标准模板名称', 'description' => '标准模板名称', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准模板编码', 'description' => '标准模板编码', 'type' => 'string', 'example' => '1121', ], 'TemplateFrom' => [ 'title' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'description' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'type' => 'string', 'example' => 'SYSTEM', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'StandardSet' => [ 'title' => '当前标准依赖的标准集', 'description' => '当前标准依赖的标准集', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准集编码', 'description' => '标准集编码', 'type' => 'string', 'example' => 'cc', ], 'Directory' => [ 'title' => '标准集所属的目录', 'description' => '标准集所属的目录', 'type' => 'string', 'example' => '/dir1', ], ], ], 'EffectiveTimeConfig' => [ 'title' => '生效时间配置', 'description' => '生效时间配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'description' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'type' => 'string', 'example' => 'TIME_PERIOD', ], 'StartTime' => [ 'title' => '开始生效时间', 'description' => '开始生效时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '结束生效时间', 'description' => '结束生效时间', 'type' => 'string', 'example' => '2025-12-30 00:00:00', ], ], ], 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'Name' => [ 'title' => '标准名称', 'description' => '标准名称', 'type' => 'string', 'example' => 'test', ], 'EnglishName' => [ 'title' => '标准英文名', 'description' => '标准英文名', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准编码', 'description' => '标准编码', 'type' => 'string', 'example' => 'zz', ], 'Type' => [ 'title' => '标准类型', 'description' => '标准类型', 'type' => 'string', 'example' => 'zz', ], 'ModifyTime' => [ 'title' => '最近修改时间', 'description' => '最近修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'LastModifier' => [ 'title' => '最近更新人', 'description' => '最近更新人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'AttributeWithValueList' => [ 'title' => '属性值配置', 'description' => '属性值配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Attribute' => [ 'title' => '属性详情', 'description' => '属性详情', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'attr1', ], 'Code' => [ 'title' => '属性编码', 'description' => '属性编码', 'type' => 'string', 'example' => 'test_attr', ], 'Type' => [ 'title' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'description' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', ], 'ValueConfig' => [ 'title' => '取值配置', 'description' => '取值配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'description' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'description' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'type' => 'string', 'example' => 'STRING', ], 'Length' => [ 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'description' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ValueRange' => [ 'title' => '取值范围', 'description' => '取值范围', 'type' => 'object', 'properties' => [ 'ValueConstraint' => [ 'title' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'description' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'type' => 'string', 'example' => 'NONE', ], 'ValueList' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'array', 'items' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'string', 'example' => '1', ], ], 'MinMaxValueConfig' => [ 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'description' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'type' => 'object', 'properties' => [ 'MinValue' => [ 'title' => '最小值', 'description' => '最小值', 'type' => 'string', 'example' => '0', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值', 'description' => '最大值', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], 'LookupTableReference' => [ 'title' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'description' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Column' => [ 'title' => '引用的码表字段', 'description' => '引用的码表字段', 'type' => 'string', 'example' => 'col1', ], ], ], 'DataphinAttributeType' => [ 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'description' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE', ], ], ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'test', ], ], ], 'MonitorConfig' => [ 'title' => '监控配置', 'description' => '监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', ], ], ], 'EnableMonitorConfig' => [ 'title' => '是否开启监控配置', 'description' => '是否开启监控配置', 'type' => 'boolean', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'RefAttribute' => [ 'title' => '引用的属性信息', 'description' => '引用的属性信息', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'AttributeFromInfo' => [ 'title' => '属性来源', 'description' => '属性来源', 'type' => 'object', 'properties' => [ 'AttributeFrom' => [ 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'description' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'type' => 'string', 'example' => 'CUSTOM', ], 'StandardReference' => [ 'title' => '对应的标准,属性来源为 STANDARD 生效', 'description' => '对应的标准,属性来源为 STANDARD 生效', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], ], ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"StandardList\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Version\\": 1,\\n \\"Status\\": \\"draft\\",\\n \\"Stage\\": \\"dev\\",\\n \\"StandardTemplate\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Code\\": \\"1121\\",\\n \\"TemplateFrom\\": \\"SYSTEM\\",\\n \\"Version\\": 1\\n },\\n \\"StandardSet\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Code\\": \\"cc\\",\\n \\"Directory\\": \\"/dir1\\"\\n },\\n \\"EffectiveTimeConfig\\": {\\n \\"Type\\": \\"TIME_PERIOD\\",\\n \\"StartTime\\": \\"2025-06-30 00:00:00\\",\\n \\"EndTime\\": \\"2025-12-30 00:00:00\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"Owner\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"Name\\": \\"test\\",\\n \\"EnglishName\\": \\"test\\",\\n \\"Code\\": \\"zz\\",\\n \\"Type\\": \\"zz\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"LastModifier\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"Creator\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"AttributeWithValueList\\": [\\n {\\n \\"Attribute\\": {\\n \\"Name\\": \\"attr1\\",\\n \\"Code\\": \\"test_attr\\",\\n \\"Type\\": \\"BIZ_ATTRIBUTE\\",\\n \\"Required\\": true,\\n \\"ValueConfig\\": {\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"DataType\\": \\"STRING\\",\\n \\"Length\\": 1,\\n \\"ValueRange\\": {\\n \\"ValueConstraint\\": \\"NONE\\",\\n \\"ValueList\\": [\\n \\"1\\"\\n ],\\n \\"MinMaxValueConfig\\": {\\n \\"MinValue\\": \\"0\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n },\\n \\"LookupTableReference\\": {\\n \\"LookupTableId\\": 11,\\n \\"Column\\": \\"col1\\"\\n },\\n \\"DataphinAttributeType\\": \\"DATAPHIN_ATTRIBUTE\\"\\n },\\n \\"DefaultValue\\": \\"test\\"\\n },\\n \\"MonitorConfig\\": {\\n \\"Type\\": \\"METADATA\\",\\n \\"ColumnName\\": \\"column1\\",\\n \\"IsCaseSensitive\\": true\\n },\\n \\"EnableMonitorConfig\\": true,\\n \\"Description\\": \\"test\\",\\n \\"RefAttribute\\": {\\n \\"AttributeId\\": 123,\\n \\"AttributeFromInfo\\": {\\n \\"AttributeFrom\\": \\"CUSTOM\\",\\n \\"StandardReference\\": {\\n \\"StandardId\\": 22,\\n \\"Version\\": 1\\n }\\n }\\n },\\n \\"Id\\": 1011\\n },\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询标准列表', ], 'GetStandardWordRoot' => [ 'summary' => '获取数据标准词根详情。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'required' => true, 'example' => '平均值', ], ], [ 'name' => 'Nullable', 'in' => 'query', 'schema' => [ 'title' => '词根不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'description' => '词根不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'type' => 'boolean', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'WordRootInfo' => [ 'title' => '词根详情', 'description' => '词根详情', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'example' => '平均值', ], 'FullName' => [ 'title' => '词根全称', 'description' => '词根全称', 'type' => 'string', 'example' => 'average', ], 'Abbreviation' => [ 'title' => '词根缩写', 'description' => '词根缩写', 'type' => 'string', 'example' => 'avg', ], 'Description' => [ 'title' => '词根描述', 'description' => '词根描述', 'type' => 'string', 'example' => 'test', ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012021', ], 'CreatorName' => [ 'title' => '创建人用户名', 'description' => '创建人用户名', 'type' => 'string', 'example' => 'test', ], 'LastModifier' => [ 'title' => '最近更新人用户ID', 'description' => '最近更新人用户ID', 'type' => 'string', 'example' => '30012021', ], 'LastModifierName' => [ 'title' => '最近更新人用户名', 'description' => '最近更新人用户名', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"WordRootInfo\\": {\\n \\"Name\\": \\"平均值\\",\\n \\"FullName\\": \\"average\\",\\n \\"Abbreviation\\": \\"avg\\",\\n \\"Description\\": \\"test\\",\\n \\"Creator\\": \\"30012021\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"LastModifier\\": \\"30012021\\",\\n \\"LastModifierName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\"\\n }\\n}","type":"json"}]', 'title' => '获取数据标准词根详情', ], 'GetStandardTemplate' => [ 'summary' => '获取数据标准模板详情。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], ], [ 'name' => 'Nullable', 'in' => 'query', 'schema' => [ 'title' => '模板不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'description' => '模板不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'FilterQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '过滤条件', 'description' => '过滤条件', 'type' => 'object', 'properties' => [ 'Version' => [ 'title' => '版本号, 空或-1表示最新版本', 'description' => '版本号, 空或-1表示最新版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'TemplateInfo' => [ 'title' => '模板详情', 'description' => '模板详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'TemplateFrom' => [ 'title' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'description' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'type' => 'string', 'example' => 'SYSTEM', ], 'UniqueId' => [ 'title' => 'uniqueId', 'description' => 'uniqueId', 'type' => 'string', 'example' => '1101', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'title' => '标准模板名称', 'description' => '标准模板名称', 'type' => 'string', 'example' => '测试模板', ], 'Code' => [ 'title' => '标准模板编码, 全局唯一;有引用时不可修改', 'description' => '标准模板编码, 全局唯一;有引用时不可修改', 'type' => 'string', 'example' => 'test01', ], 'Description' => [ 'title' => '标准模板描述', 'description' => '标准模板描述', 'type' => 'string', 'example' => 'test', ], 'MaintainerList' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'LastModifier' => [ 'title' => '最近修改人', 'description' => '最近修改人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'AttributesConfig' => [ 'title' => '属性配置', 'description' => '属性配置', 'type' => 'object', 'properties' => [ 'AttributeList' => [ 'title' => '属性列表', 'description' => '属性列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'attr1', ], 'Code' => [ 'title' => '属性编码', 'description' => '属性编码', 'type' => 'string', 'example' => 'test_attr', ], 'Type' => [ 'title' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'description' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', ], 'ValueConfig' => [ 'title' => '取值配置', 'description' => '取值配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'description' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'description' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'type' => 'string', 'example' => 'STRING', ], 'Length' => [ 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'description' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ValueRange' => [ 'title' => '取值范围', 'description' => '取值范围', 'type' => 'object', 'properties' => [ 'ValueConstraint' => [ 'title' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'description' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'type' => 'string', 'example' => 'NONE', ], 'ValueList' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'array', 'items' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'string', 'example' => '1', ], ], 'MinMaxValueConfig' => [ 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'description' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'type' => 'object', 'properties' => [ 'MinValue' => [ 'title' => '最小值', 'description' => '最小值', 'type' => 'string', 'example' => '0', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值', 'description' => '最大值', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], 'LookupTableReference' => [ 'title' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'description' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Column' => [ 'title' => '引用的码表字段', 'description' => '引用的码表字段', 'type' => 'string', 'example' => 'col1', ], ], ], 'DataphinAttributeType' => [ 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'description' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE', ], ], ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'test', ], ], ], 'MonitorConfig' => [ 'title' => '监控配置', 'description' => '监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', ], ], ], 'EnableMonitorConfig' => [ 'title' => '是否开启监控配置', 'description' => '是否开启监控配置', 'type' => 'boolean', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'RefAttribute' => [ 'title' => '引用的属性信息', 'description' => '引用的属性信息', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'AttributeFromInfo' => [ 'title' => '属性来源', 'description' => '属性来源', 'type' => 'object', 'properties' => [ 'AttributeFrom' => [ 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'description' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'type' => 'string', 'example' => 'CUSTOM', ], 'StandardReference' => [ 'title' => '对应的标准,属性来源为 STANDARD 生效', 'description' => '对应的标准,属性来源为 STANDARD 生效', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], ], ], ], ], ], 'CodeRuleConfig' => [ 'title' => '标准编码自动生成规则配置', 'description' => '标准编码自动生成规则配置', 'type' => 'object', 'properties' => [ 'GenerateType' => [ 'title' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'description' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'AutoConfig' => [ 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'description' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'type' => 'object', 'properties' => [ 'NeedStrongValidate' => [ 'title' => '是否强校验', 'description' => '是否强校验', 'type' => 'boolean', ], 'CodeRuleList' => [ 'title' => '标准编码规则', 'description' => '标准编码规则', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => '编码规则位置索引', 'description' => '编码规则位置索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Type' => [ 'title' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'description' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'type' => 'string', 'example' => 'FIXED_STRING', ], 'Value' => [ 'title' => '编码规则格式/值', 'description' => '编码规则格式/值', 'type' => 'string', 'example' => 'test', ], 'AutoIncrementSequenceConfig' => [ 'title' => '自增序列配置', 'description' => '自增序列配置', 'type' => 'object', 'properties' => [ 'Digit' => [ 'title' => '位数', 'description' => '位数', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'StartValue' => [ 'title' => '起始值', 'description' => '起始值', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Step' => [ 'title' => '步长', 'description' => '步长', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NeedPaddingZero' => [ 'title' => '是否补零', 'description' => '是否补零', 'type' => 'boolean', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"TemplateInfo\\": {\\n \\"Id\\": 22,\\n \\"TemplateFrom\\": \\"SYSTEM\\",\\n \\"UniqueId\\": \\"1101\\",\\n \\"Version\\": 1,\\n \\"Name\\": \\"测试模板\\",\\n \\"Code\\": \\"test01\\",\\n \\"Description\\": \\"test\\",\\n \\"MaintainerList\\": [\\n {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n }\\n ],\\n \\"Creator\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"LastModifier\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"AttributesConfig\\": {\\n \\"AttributeList\\": [\\n {\\n \\"Name\\": \\"attr1\\",\\n \\"Code\\": \\"test_attr\\",\\n \\"Type\\": \\"BIZ_ATTRIBUTE\\",\\n \\"Required\\": true,\\n \\"ValueConfig\\": {\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"DataType\\": \\"STRING\\",\\n \\"Length\\": 1,\\n \\"ValueRange\\": {\\n \\"ValueConstraint\\": \\"NONE\\",\\n \\"ValueList\\": [\\n \\"1\\"\\n ],\\n \\"MinMaxValueConfig\\": {\\n \\"MinValue\\": \\"0\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n },\\n \\"LookupTableReference\\": {\\n \\"LookupTableId\\": 11,\\n \\"Column\\": \\"col1\\"\\n },\\n \\"DataphinAttributeType\\": \\"DATAPHIN_ATTRIBUTE\\"\\n },\\n \\"DefaultValue\\": \\"test\\"\\n },\\n \\"MonitorConfig\\": {\\n \\"Type\\": \\"METADATA\\",\\n \\"ColumnName\\": \\"column1\\",\\n \\"IsCaseSensitive\\": true\\n },\\n \\"EnableMonitorConfig\\": true,\\n \\"Description\\": \\"test\\",\\n \\"RefAttribute\\": {\\n \\"AttributeId\\": 123,\\n \\"AttributeFromInfo\\": {\\n \\"AttributeFrom\\": \\"CUSTOM\\",\\n \\"StandardReference\\": {\\n \\"StandardId\\": 22,\\n \\"Version\\": 1\\n }\\n }\\n },\\n \\"Id\\": 1011\\n }\\n ]\\n },\\n \\"CodeRuleConfig\\": {\\n \\"GenerateType\\": \\"CUSTOMIZED\\",\\n \\"AutoConfig\\": {\\n \\"NeedStrongValidate\\": true,\\n \\"CodeRuleList\\": [\\n {\\n \\"Index\\": 1,\\n \\"Type\\": \\"FIXED_STRING\\",\\n \\"Value\\": \\"test\\",\\n \\"AutoIncrementSequenceConfig\\": {\\n \\"Digit\\": 3,\\n \\"StartValue\\": 1,\\n \\"Step\\": 1,\\n \\"NeedPaddingZero\\": true\\n }\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', 'title' => '获取数据标准模板详情', ], 'GetStandardStatistics' => [ 'summary' => '查询目录下按照标准类型统计标准数目。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'StatisticsQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '统计查询指令', 'description' => '统计查询指令', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '所属目录,会搜索包括该目录的所有子目录下的标准', 'description' => '所属目录,会搜索包括该目录的所有子目录下的标准', 'type' => 'string', 'required' => true, 'example' => '/dir1', ], 'StandardStageList' => [ 'title' => '标准所属stage', 'description' => '标准所属stage', 'type' => 'array', 'items' => [ 'title' => '标准所属stage', 'description' => '标准所属stage', 'type' => 'string', 'required' => false, 'example' => 'dev', ], 'required' => false, ], 'CreateTimePeriod' => [ 'title' => '创建时间段', 'description' => '创建时间段', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'required' => false, 'example' => '2025-06-01 00:00:00', ], 'EndTime' => [ 'title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00', ], 'IncludeEndTime' => [ 'title' => '是否包含结束时间, 默认：false', 'description' => '是否包含结束时间, 默认：false', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '统计结果', 'description' => '统计结果', 'type' => 'object', 'properties' => [ 'StandardTypeCountList' => [ 'title' => '标准类型以及每个类型的标准数目的对应关系, 如果标准本身的类型为空则key为EMPTY', 'description' => '标准类型以及每个类型的标准数目的对应关系, 如果标准本身的类型为空则key为EMPTY', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'StandardType' => [ 'title' => '标准类型', 'description' => '标准类型', 'type' => 'string', 'example' => 'test', ], 'Count' => [ 'title' => '标准数', 'description' => '标准数', 'type' => 'integer', 'format' => 'int32', 'example' => '11', ], ], ], ], 'TotalCount' => [ 'title' => '总标准数', 'description' => '总标准数', 'type' => 'integer', 'format' => 'int32', 'example' => '101', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"StandardTypeCountList\\": [\\n {\\n \\"StandardType\\": \\"test\\",\\n \\"Count\\": 11\\n }\\n ],\\n \\"TotalCount\\": 101\\n }\\n}","type":"json"}]', 'title' => '查询目录下按照标准类型统计标准数目', ], 'GetStandardSet' => [ 'summary' => '获取标准集详情。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], ], [ 'name' => 'Nullable', 'in' => 'query', 'schema' => [ 'title' => '标准集不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'description' => '标准集不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'type' => 'boolean', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'StandardSetInfo' => [ 'title' => '标准集详情', 'description' => '标准集详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Name' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准集编码', 'description' => '标准集编码', 'type' => 'string', 'example' => 'CITY', ], 'Description' => [ 'title' => '标准集描述', 'description' => '标准集描述', 'type' => 'string', 'example' => 'test', ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '所属目录', 'description' => '所属目录', 'type' => 'string', 'example' => '/dir1', ], ], ], 'MaintainerList' => [ 'title' => '维护人员/责任人', 'description' => '维护人员/责任人', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], ], 'MemberList' => [ 'title' => '成员', 'description' => '成员', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], ], 'MemberGroupList' => [ 'title' => '成员组', 'description' => '成员组', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户组Id', 'description' => '用户组Id', 'type' => 'string', 'example' => '1121', ], 'Name' => [ 'title' => '用户组名', 'description' => '用户组名', 'type' => 'string', 'example' => 'testGroup', ], ], ], ], 'VisibilityConfig' => [ 'title' => '可见性配置', 'description' => '可见性配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'description' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'type' => 'string', 'example' => 'PUBLIC', ], 'SpecifiedUserList' => [ 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'description' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'LastModifier' => [ 'title' => '最近修改人', 'description' => '最近修改人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '最近修改时间', 'description' => '最近修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ApprovalConfig' => [ 'title' => '上线审批配置', 'description' => '上线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], ], ], 'OfflineApprovalConfig' => [ 'title' => '下线审批配置', 'description' => '下线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], ], ], 'DefaultStandardTemplateId' => [ 'title' => '默认标准模板ID', 'description' => '默认标准模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1001', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"StandardSetInfo\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"test\\",\\n \\"Code\\": \\"CITY\\",\\n \\"Description\\": \\"test\\",\\n \\"DirectoryReference\\": {\\n \\"Directory\\": \\"/dir1\\"\\n },\\n \\"MaintainerList\\": [\\n {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n }\\n ],\\n \\"MemberList\\": [\\n {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n }\\n ],\\n \\"MemberGroupList\\": [\\n {\\n \\"Id\\": \\"1121\\",\\n \\"Name\\": \\"testGroup\\"\\n }\\n ],\\n \\"VisibilityConfig\\": {\\n \\"Type\\": \\"PUBLIC\\",\\n \\"SpecifiedUserList\\": [\\n {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n }\\n ]\\n },\\n \\"Creator\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"LastModifier\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ApprovalConfig\\": {\\n \\"EnableApproval\\": true,\\n \\"IsSubmitInBatch\\": true,\\n \\"ApprovalType\\": \\"BY_DEFAULT\\",\\n \\"TemplateId\\": 1121\\n },\\n \\"OfflineApprovalConfig\\": {\\n \\"EnableApproval\\": true,\\n \\"IsSubmitInBatch\\": true,\\n \\"ApprovalType\\": \\"BY_DEFAULT\\",\\n \\"TemplateId\\": 1121\\n },\\n \\"DefaultStandardTemplateId\\": 1001\\n }\\n}","type":"json"}]', 'title' => '获取标准集详情', ], 'GetStandardLookupTable' => [ 'summary' => '获取数据标准码表详情。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], ], [ 'name' => 'Nullable', 'in' => 'query', 'schema' => [ 'title' => '码表不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'description' => '码表不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'type' => 'boolean', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'LookupTableInfo' => [ 'title' => '码表详情', 'description' => '码表详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Name' => [ 'title' => '码表名称', 'description' => '码表名称', 'type' => 'string', 'example' => '城市码表', ], 'Code' => [ 'title' => '码表编码', 'description' => '码表编码', 'type' => 'string', 'example' => 'CITY', ], 'Description' => [ 'title' => '码表描述', 'description' => '码表描述', 'type' => 'string', 'example' => 'test', ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012021', ], 'CreatorName' => [ 'title' => '创建人用户名', 'description' => '创建人用户名', 'type' => 'string', 'example' => 'test', ], 'LastModifier' => [ 'title' => '最近更新人用户ID', 'description' => '最近更新人用户ID', 'type' => 'string', 'example' => '30012021', ], 'LastModifierName' => [ 'title' => '最近更新人用户名', 'description' => '最近更新人用户名', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012021', ], 'OwnerName' => [ 'title' => '负责人用户名', 'description' => '负责人用户名', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'LookupTableValueList' => [ 'title' => '码表值列表', 'description' => '码表值列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '代码值', 'description' => '代码值', 'type' => 'string', 'example' => '杭州', ], 'Name' => [ 'title' => '代码名称', 'description' => '代码名称', 'type' => 'string', 'example' => 'Hangzhou', ], 'EnglishName' => [ 'title' => '代码英文名', 'description' => '代码英文名', 'type' => 'string', 'example' => 'HZ', ], 'Description' => [ 'title' => '代码描述', 'description' => '代码描述', 'type' => 'string', 'example' => 'test', ], ], ], ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'string', 'example' => '/dir1/dir2', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"LookupTableInfo\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"城市码表\\",\\n \\"Code\\": \\"CITY\\",\\n \\"Description\\": \\"test\\",\\n \\"Creator\\": \\"30012021\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"LastModifier\\": \\"30012021\\",\\n \\"LastModifierName\\": \\"test\\",\\n \\"Owner\\": \\"30012021\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"LookupTableValueList\\": [\\n {\\n \\"Value\\": \\"杭州\\",\\n \\"Name\\": \\"Hangzhou\\",\\n \\"EnglishName\\": \\"HZ\\",\\n \\"Description\\": \\"test\\"\\n }\\n ],\\n \\"DirectoryReference\\": {\\n \\"Directory\\": \\"/dir1/dir2\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '获取数据标准码表详情', ], 'GetStandard' => [ 'summary' => '获取标准详情。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'StandardGetQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询指令', 'description' => '查询指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], 'Nullable' => [ 'title' => '标准不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'description' => '标准不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', 'type' => 'boolean', 'required' => false, ], 'Version' => [ 'title' => '版本号, 为空表示最新版本', 'description' => '版本号, 为空表示最新版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'StandardStage' => [ 'title' => '所属阶段：dev、prod, 默认：prod', 'description' => '所属阶段：dev、prod, 默认：prod', 'type' => 'string', 'required' => false, 'example' => 'dev', ], 'NeedRelation' => [ 'title' => '是否需要返回关联标准和关联码表, 默认：false', 'description' => '是否需要返回关联标准和关联码表, 默认：false', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'StandardInfo' => [ 'title' => '标准详情', 'description' => '标准详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '码表', 'description' => '码表', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Status' => [ 'title' => '标准的状态', 'description' => '标准的状态', 'type' => 'string', 'example' => 'draft', ], 'Stage' => [ 'title' => '标准所属的阶段', 'description' => '标准所属的阶段', 'type' => 'string', 'example' => 'dev', ], 'StandardTemplate' => [ 'title' => '当前标准依赖的标准模板', 'description' => '当前标准依赖的标准模板', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '标准模板名称', 'description' => '标准模板名称', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准模板编码', 'description' => '标准模板编码', 'type' => 'string', 'example' => '1121', ], 'TemplateFrom' => [ 'title' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'description' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', 'type' => 'string', 'example' => 'SYSTEM', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'StandardSet' => [ 'title' => '当前标准依赖的标准集', 'description' => '当前标准依赖的标准集', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准集编码', 'description' => '标准集编码', 'type' => 'string', 'example' => 'cc', ], 'Directory' => [ 'title' => '标准集所属的目录', 'description' => '标准集所属的目录', 'type' => 'string', 'example' => '/dir1', ], ], ], 'EffectiveTimeConfig' => [ 'title' => '生效时间配置', 'description' => '生效时间配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'description' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'type' => 'string', 'example' => 'TIME_PERIOD', ], 'StartTime' => [ 'title' => '开始生效时间', 'description' => '开始生效时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '结束生效时间', 'description' => '结束生效时间', 'type' => 'string', 'example' => '2025-12-30 00:00:00', ], ], ], 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'Name' => [ 'title' => '标准名称', 'description' => '标准名称', 'type' => 'string', 'example' => 'test', ], 'EnglishName' => [ 'title' => '标准英文名', 'description' => '标准英文名', 'type' => 'string', 'example' => 'test', ], 'Code' => [ 'title' => '标准编码', 'description' => '标准编码', 'type' => 'string', 'example' => 'zz', ], 'Type' => [ 'title' => '标准类型', 'description' => '标准类型', 'type' => 'string', 'example' => 'zz', ], 'ModifyTime' => [ 'title' => '最近修改时间', 'description' => '最近修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'LastModifier' => [ 'title' => '最近更新人', 'description' => '最近更新人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '300000913', ], 'Name' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'susan', ], ], ], 'AttributeWithValueList' => [ 'title' => '属性值配置', 'description' => '属性值配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Attribute' => [ 'title' => '属性详情', 'description' => '属性详情', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'attr1', ], 'Code' => [ 'title' => '属性编码', 'description' => '属性编码', 'type' => 'string', 'example' => 'test_attr', ], 'Type' => [ 'title' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'description' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', ], 'ValueConfig' => [ 'title' => '取值配置', 'description' => '取值配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'description' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'description' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'type' => 'string', 'example' => 'STRING', ], 'Length' => [ 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'description' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ValueRange' => [ 'title' => '取值范围', 'description' => '取值范围', 'type' => 'object', 'properties' => [ 'ValueConstraint' => [ 'title' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'description' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'type' => 'string', 'example' => 'NONE', ], 'ValueList' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'array', 'items' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'string', 'example' => '1', ], ], 'MinMaxValueConfig' => [ 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'description' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'type' => 'object', 'properties' => [ 'MinValue' => [ 'title' => '最小值', 'description' => '最小值', 'type' => 'string', 'example' => '0', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值', 'description' => '最大值', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], 'LookupTableReference' => [ 'title' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'description' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Column' => [ 'title' => '引用的码表字段', 'description' => '引用的码表字段', 'type' => 'string', 'example' => 'col1', ], ], ], 'DataphinAttributeType' => [ 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'description' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE', ], ], ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'test', ], ], ], 'MonitorConfig' => [ 'title' => '监控配置', 'description' => '监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', ], ], ], 'EnableMonitorConfig' => [ 'title' => '是否开启监控配置', 'description' => '是否开启监控配置', 'type' => 'boolean', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'RefAttribute' => [ 'title' => '引用的属性信息', 'description' => '引用的属性信息', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'AttributeFromInfo' => [ 'title' => '属性来源', 'description' => '属性来源', 'type' => 'object', 'properties' => [ 'AttributeFrom' => [ 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'description' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'type' => 'string', 'example' => 'CUSTOM', ], 'StandardReference' => [ 'title' => '对应的标准,属性来源为 STANDARD 生效', 'description' => '对应的标准,属性来源为 STANDARD 生效', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], ], ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'test', ], ], ], ], 'StandardGeneralMonitorConfig' => [ 'title' => '标准监控配置', 'description' => '标准监控配置', 'type' => 'object', 'properties' => [ 'StandardMonitorConfigList' => [ 'title' => '标准监控配置列表', 'description' => '标准监控配置列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'description' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '规则描述', 'description' => '规则描述', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'example' => 'METADATA', ], 'MonitorFrom' => [ 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'description' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'type' => 'string', 'example' => 'BY_SYSTEM_ATTRIBUTE', ], 'AttributeId' => [ 'title' => '关联的属性Id', 'description' => '关联的属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '112', ], 'AttributeName' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'teset', ], 'AttributeMonitorConfig' => [ 'title' => '关联属性的监控配置', 'description' => '关联属性的监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', ], ], ], 'RuleSubType' => [ 'title' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'description' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'QualityRuleTemplate' => [ 'title' => '规则模板, 当监控类型为 QUALITY 时必填', 'description' => '规则模板, 当监控类型为 QUALITY 时必填', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板Id', 'description' => '模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Type' => [ 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'description' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => 'CUSTOMIZED', ], ], ], 'RuleConfigList' => [ 'title' => '规则配置, 当监控类型为 QUALITY 时必填', 'description' => '规则配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'v1', ], ], ], ], 'RuleValidateConfigList' => [ 'title' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'description' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '校验配置Id, 由业务随机生成且确保唯一', 'description' => '校验配置Id, 由业务随机生成且确保唯一', 'type' => 'string', 'example' => 'abc', ], 'ParentId' => [ 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', 'description' => '父校验配置Id, 父规则校验类型只能是RELATION', 'type' => 'string', 'example' => 'a', ], 'Type' => [ 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'description' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'type' => 'string', 'example' => 'RELATION', ], 'Operator' => [ 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'description' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'type' => 'string', 'example' => 'AND', ], 'Metric' => [ 'title' => '指标, 校验类型为 EXPRESSION 时必填', 'description' => '指标, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'example' => 'a', ], 'MetricName' => [ 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', 'description' => '指标名称, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'example' => 'test', ], 'Value' => [ 'title' => '比较的值', 'description' => '比较的值', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], ], ], 'StandardRelations' => [ 'title' => '关联标准列表', 'description' => '关联标准列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'Version' => [ 'title' => '标准版本号', 'description' => '标准版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StandardStage' => [ 'title' => '标准所处阶段', 'description' => '标准所处阶段', 'type' => 'string', 'example' => 'DEV', ], 'StandardStatus' => [ 'title' => '标准状态', 'description' => '标准状态', 'type' => 'string', 'example' => 'draft', ], 'RelationType' => [ 'title' => '关联关系类型: RELATIVE', 'description' => '关联关系类型: RELATIVE', 'type' => 'string', 'example' => 'RELATIVE', ], ], ], ], 'LookupTableRelations' => [ 'title' => '关联码表列表', 'description' => '关联码表列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'LookupTableCode' => [ 'title' => '码表编码', 'description' => '码表编码', 'type' => 'string', 'example' => 'test', ], 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1122', ], 'AttributeName' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'test', ], 'AttributeCode' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'zz', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"StandardInfo\\": {\\n \\"Id\\": 1234,\\n \\"Version\\": 1,\\n \\"Status\\": \\"draft\\",\\n \\"Stage\\": \\"dev\\",\\n \\"StandardTemplate\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Code\\": \\"1121\\",\\n \\"TemplateFrom\\": \\"SYSTEM\\",\\n \\"Version\\": 1\\n },\\n \\"StandardSet\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Code\\": \\"cc\\",\\n \\"Directory\\": \\"/dir1\\"\\n },\\n \\"EffectiveTimeConfig\\": {\\n \\"Type\\": \\"TIME_PERIOD\\",\\n \\"StartTime\\": \\"2025-06-30 00:00:00\\",\\n \\"EndTime\\": \\"2025-12-30 00:00:00\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"Owner\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"Name\\": \\"test\\",\\n \\"EnglishName\\": \\"test\\",\\n \\"Code\\": \\"zz\\",\\n \\"Type\\": \\"zz\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"LastModifier\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"Creator\\": {\\n \\"Id\\": \\"300000913\\",\\n \\"Name\\": \\"susan\\"\\n },\\n \\"AttributeWithValueList\\": [\\n {\\n \\"Attribute\\": {\\n \\"Name\\": \\"attr1\\",\\n \\"Code\\": \\"test_attr\\",\\n \\"Type\\": \\"BIZ_ATTRIBUTE\\",\\n \\"Required\\": true,\\n \\"ValueConfig\\": {\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"DataType\\": \\"STRING\\",\\n \\"Length\\": 1,\\n \\"ValueRange\\": {\\n \\"ValueConstraint\\": \\"NONE\\",\\n \\"ValueList\\": [\\n \\"1\\"\\n ],\\n \\"MinMaxValueConfig\\": {\\n \\"MinValue\\": \\"0\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n },\\n \\"LookupTableReference\\": {\\n \\"LookupTableId\\": 11,\\n \\"Column\\": \\"col1\\"\\n },\\n \\"DataphinAttributeType\\": \\"DATAPHIN_ATTRIBUTE\\"\\n },\\n \\"DefaultValue\\": \\"test\\"\\n },\\n \\"MonitorConfig\\": {\\n \\"Type\\": \\"METADATA\\",\\n \\"ColumnName\\": \\"column1\\",\\n \\"IsCaseSensitive\\": true\\n },\\n \\"EnableMonitorConfig\\": true,\\n \\"Description\\": \\"test\\",\\n \\"RefAttribute\\": {\\n \\"AttributeId\\": 123,\\n \\"AttributeFromInfo\\": {\\n \\"AttributeFrom\\": \\"CUSTOM\\",\\n \\"StandardReference\\": {\\n \\"StandardId\\": 22,\\n \\"Version\\": 1\\n }\\n }\\n },\\n \\"Id\\": 1011\\n },\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StandardGeneralMonitorConfig\\": {\\n \\"StandardMonitorConfigList\\": [\\n {\\n \\"Id\\": 1,\\n \\"RuleName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Type\\": \\"METADATA\\",\\n \\"MonitorFrom\\": \\"BY_SYSTEM_ATTRIBUTE\\",\\n \\"AttributeId\\": 112,\\n \\"AttributeName\\": \\"teset\\",\\n \\"AttributeMonitorConfig\\": {\\n \\"Type\\": \\"METADATA\\",\\n \\"ColumnName\\": \\"column1\\",\\n \\"IsCaseSensitive\\": true\\n },\\n \\"RuleSubType\\": \\"CUSTOMIZED\\",\\n \\"QualityRuleTemplate\\": {\\n \\"Id\\": 22,\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"Name\\": \\"CUSTOMIZED\\"\\n },\\n \\"RuleConfigList\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"RuleValidateConfigList\\": [\\n {\\n \\"Id\\": \\"abc\\",\\n \\"ParentId\\": \\"a\\",\\n \\"Type\\": \\"RELATION\\",\\n \\"Operator\\": \\"AND\\",\\n \\"Metric\\": \\"a\\",\\n \\"MetricName\\": \\"test\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"StandardRelations\\": [\\n {\\n \\"StandardId\\": 1121,\\n \\"Version\\": 1,\\n \\"StandardStage\\": \\"DEV\\",\\n \\"StandardStatus\\": \\"draft\\",\\n \\"RelationType\\": \\"RELATIVE\\"\\n }\\n ],\\n \\"LookupTableRelations\\": [\\n {\\n \\"LookupTableId\\": 1121,\\n \\"LookupTableCode\\": \\"test\\",\\n \\"AttributeId\\": 1122,\\n \\"AttributeName\\": \\"test\\",\\n \\"AttributeCode\\": \\"zz\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取标准详情', ], 'DeleteStandardWordRoot' => [ 'summary' => '删除数据标准词根。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'required' => true, 'example' => '平均值', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除数据标准词根', ], 'DeleteStandardValidMapping' => [ 'summary' => '删除有效映射关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'GuidList' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1022', ], 'required' => false, ], 'BelongGuidList' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1023', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除有效映射关系', ], 'DeleteStandardSet' => [ 'summary' => '删除标准集。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除标准集', ], 'DeleteStandardRelations' => [ 'summary' => '批量删除标准关联关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'StandardRefList' => [ 'title' => '被引用的标准列表', 'description' => '被引用的标准列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], 'required' => false, ], 'required' => true, ], 'RelationType' => [ 'title' => '标准关联关系：RELATIVE', 'description' => '标准关联关系：RELATIVE', 'type' => 'string', 'required' => true, 'example' => 'RELATIVE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'object', 'properties' => [ 'SuccessCount' => [ 'title' => '添加成功数目', 'description' => '添加成功数目', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'NotExistStandardIdList' => [ 'title' => '不存在标准Id列表', 'description' => '不存在标准Id列表', 'type' => 'array', 'items' => [ 'title' => '不存在标准Id列表', 'description' => '不存在标准Id列表', 'type' => 'integer', 'format' => 'int64', 'example' => '1021', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2,\\n \\"NotExistStandardIdList\\": [\\n 1021\\n ]\\n }\\n}","type":"json"}]', 'title' => '批量删除标准关联关系', ], 'DeleteStandardLookupTable' => [ 'summary' => '删除数据标准码表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除数据标准码表', ], 'DeleteStandardInValidMapping' => [ 'summary' => '删除无效映射关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'GuidList' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => 'guid列表,上限为1000', 'description' => 'guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1022', ], 'required' => false, ], 'BelongGuidList' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'array', 'items' => [ 'title' => '所属guid列表,上限为1000', 'description' => '所属guid列表,上限为1000', 'type' => 'string', 'required' => false, 'example' => '1023', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除无效映射关系', ], 'DeleteStandard' => [ 'summary' => '删除标准。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '删除标准', ], 'CreateStandardWordRoot' => [ 'summary' => '创建数据标准词根。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'required' => true, 'example' => '平均值', ], 'FullName' => [ 'title' => '词根全称', 'description' => '词根全称', 'type' => 'string', 'required' => true, 'example' => 'average', ], 'Abbreviation' => [ 'title' => '词根缩写', 'description' => '词根缩写', 'type' => 'string', 'required' => true, 'example' => 'avg', ], 'Description' => [ 'title' => '词根描述', 'description' => '词根描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '词根名称', 'description' => '词根名称', 'type' => 'string', 'example' => 'average', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"average\\"\\n}","type":"json"}]', 'title' => '创建数据标准词根', ], 'CreateStandardTemplate' => [ 'summary' => '创建数据标准模板。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '标准模板名称', 'description' => '标准模板名称', 'type' => 'string', 'required' => true, 'example' => '测试模板', ], 'Code' => [ 'title' => '标准模板编码, 全局唯一;有引用时不可修改', 'description' => '标准模板编码, 全局唯一;有引用时不可修改', 'type' => 'string', 'required' => true, 'example' => 'test01', ], 'Description' => [ 'title' => '标准模板描述', 'description' => '标准模板描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'MaintainerList' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'array', 'items' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'AttributesConfig' => [ 'title' => '属性配置', 'description' => '属性配置', 'type' => 'object', 'properties' => [ 'AttributeList' => [ 'title' => '属性列表', 'description' => '属性列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '属性名称', 'description' => '属性名称，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'attr1', ], 'Code' => [ 'title' => '属性编码', 'description' => '属性编码，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'test_attr', ], 'Type' => [ 'title' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性', 'description' => '属性类型：BIZ_ATTRIBUTE 业务属性、TECH_ATTRIBUTE 技术属性、MANAGEMENT_ATTRIBUTE 管理属性、QUALITY_ATTRIBUTE 质量属性、MASTER_DATA_ATTRIBUTE 主数据属性、LIFECYCLE_ATTRIBUTE 生命周期属性、SECURITY_ATTRIBUTE 安全属性，引用公共属性时非必填', 'type' => 'string', 'required' => false, 'example' => 'BIZ_ATTRIBUTE', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填，引用公共属性时非必填', 'type' => 'boolean', 'required' => false, ], 'ValueConfig' => [ 'title' => '取值配置', 'description' => '取值配置，引用公共属性时非必填', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'description' => '属性值类型：CUSTOMIZED 自定义输入、SINGLE_ENUM 枚举单值、MULTIPLE_ENUMS 枚举多值、RANGE 范围值', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'description' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', 'type' => 'string', 'required' => true, 'example' => 'STRING', ], 'Length' => [ 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'description' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ValueRange' => [ 'title' => '取值范围', 'description' => '取值范围', 'type' => 'object', 'properties' => [ 'ValueConstraint' => [ 'title' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'description' => '取值来源：NONE 无约束、LIST 从列表中获取、LOOKUP_TABLE 码表、MIN_MAX 在最大值和最小值之间取值、DATAPHIN_ATTRIBUTE Dataphin系统属性、BUILT_IN_DATA_TYPES 内置数据类型、BUILT_IN_DATA_CLASSIFICATION 内置数据分类、BUILT_IN_DATA_LEVEL 内置数据安全分级', 'type' => 'string', 'required' => true, 'example' => 'NONE', ], 'ValueList' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'array', 'items' => [ 'title' => '取值范围,当取值来源取值为 LIST 生效', 'description' => '取值范围,当取值来源取值为 LIST 生效', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, ], 'MinMaxValueConfig' => [ 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'description' => '取值范围,当取值来源取值为 MIN_MAX 生效', 'type' => 'object', 'properties' => [ 'MinValue' => [ 'title' => '最小值', 'description' => '最小值', 'type' => 'string', 'required' => true, 'example' => '0', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', 'required' => true, ], 'MaxValue' => [ 'title' => '最大值', 'description' => '最大值', 'type' => 'string', 'required' => true, 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], 'LookupTableReference' => [ 'title' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'description' => '取值范围,当取值来源取值为 LOOKUP_TABLE 生效', 'type' => 'object', 'properties' => [ 'LookupTableId' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'Column' => [ 'title' => '引用的码表字段', 'description' => '引用的码表字段', 'type' => 'string', 'required' => false, 'example' => 'col1', ], ], 'required' => false, ], 'DataphinAttributeType' => [ 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'description' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_ATTRIBUTE', ], ], 'required' => true, ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'RefAttribute' => [ 'title' => '引用的属性信息', 'description' => '引用的属性信息', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'AttributeFromInfo' => [ 'title' => '属性来源', 'description' => '属性来源', 'type' => 'object', 'properties' => [ 'AttributeFrom' => [ 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'description' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', 'type' => 'string', 'required' => true, 'example' => 'CUSTOM', ], 'StandardReference' => [ 'title' => '对应的标准,属性来源为 STANDARD 生效', 'description' => '对应的标准,属性来源为 STANDARD 生效', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Version' => [ 'title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => false, ], ], 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], 'PublishInfo' => [ 'title' => '标准模板发布信息', 'description' => '标准模板发布信息', 'type' => 'object', 'properties' => [ 'Comment' => [ 'title' => '发布备注', 'description' => '发布备注', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'CodeRuleConfig' => [ 'title' => '标准编码自动生成规则配置', 'description' => '标准编码自动生成规则配置', 'type' => 'object', 'properties' => [ 'GenerateType' => [ 'title' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'description' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'AutoConfig' => [ 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'description' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', 'type' => 'object', 'properties' => [ 'NeedStrongValidate' => [ 'title' => '是否强校验', 'description' => '是否强校验', 'type' => 'boolean', 'required' => true, ], 'CodeRuleList' => [ 'title' => '标准编码规则', 'description' => '标准编码规则', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => '编码规则位置索引', 'description' => '编码规则位置索引', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'Type' => [ 'title' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'description' => '编码规则类型：FIXED_STRING 固定字符串、AUTO_INCREMENT 自增序列、STANDARD_SET_CODE 标准集编码', 'type' => 'string', 'required' => true, 'example' => 'FIXED_STRING', ], 'Value' => [ 'title' => '编码规则格式/值', 'description' => '编码规则格式/值', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'AutoIncrementSequenceConfig' => [ 'title' => '自增序列配置', 'description' => '自增序列配置', 'type' => 'object', 'properties' => [ 'Digit' => [ 'title' => '位数', 'description' => '位数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', ], 'StartValue' => [ 'title' => '起始值', 'description' => '起始值', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'Step' => [ 'title' => '步长', 'description' => '步长', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'NeedPaddingZero' => [ 'title' => '是否补零', 'description' => '是否补零', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '标准模板Id', 'description' => '标准模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 22\\n}","type":"json"}]', 'title' => '创建数据标准模板', ], 'CreateStandardSet' => [ 'summary' => '创建标准集。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Code' => [ 'title' => '标准集编码', 'description' => '标准集编码', 'type' => 'string', 'required' => true, 'example' => 'CITY', ], 'Description' => [ 'title' => '标准集描述', 'description' => '标准集描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '所属目录', 'description' => '所属目录', 'type' => 'string', 'required' => true, 'example' => '/dir1', ], ], 'required' => false, ], 'MaintainerList' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'array', 'items' => [ 'title' => '维护人员', 'description' => '维护人员', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'MemberList' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'array', 'items' => [ 'title' => '成员列表', 'description' => '成员列表', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'required' => false, ], 'MemberGroupList' => [ 'title' => '成员组列表', 'description' => '成员组列表', 'type' => 'array', 'items' => [ 'title' => '成员组列表', 'description' => '成员组列表', 'type' => 'string', 'required' => false, 'example' => '1121', ], 'required' => false, ], 'VisibilityConfig' => [ 'title' => '可见性配置', 'description' => '可见性配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'description' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', 'type' => 'string', 'required' => true, 'example' => 'PUBLIC', ], 'SpecifiedUserList' => [ 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'description' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'type' => 'array', 'items' => [ 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'description' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', 'type' => 'string', 'required' => false, 'example' => '1121', ], 'required' => false, ], ], 'required' => false, ], 'ApprovalConfig' => [ 'title' => '上线审批配置', 'description' => '上线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', 'required' => true, ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', 'required' => true, ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], ], 'required' => false, ], 'OfflineApprovalConfig' => [ 'title' => '下线审批配置', 'description' => '下线审批配置', 'type' => 'object', 'properties' => [ 'EnableApproval' => [ 'title' => '是否开启审批', 'description' => '是否开启审批', 'type' => 'boolean', 'required' => true, ], 'IsSubmitInBatch' => [ 'title' => '是否批量提交审批', 'description' => '是否批量提交审批', 'type' => 'boolean', 'required' => true, ], 'ApprovalType' => [ 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'description' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT', ], 'TemplateId' => [ 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'description' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], ], 'required' => false, ], 'DefaultStandardTemplateId' => [ 'title' => '默认标准模板ID', 'description' => '默认标准模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1001', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1201', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1201\\n}","type":"json"}]', 'title' => '创建标准集', ], 'CreateStandardRelations' => [ 'summary' => '创建标准关联关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'StandardRefList' => [ 'title' => '被引用的标准列表', 'description' => '被引用的标准列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], 'required' => false, ], 'required' => true, ], 'RelationType' => [ 'title' => '标准关联关系：RELATIVE', 'description' => '标准关联关系：RELATIVE', 'type' => 'string', 'required' => true, 'example' => 'RELATIVE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '创建结果', 'description' => '创建结果', 'type' => 'object', 'properties' => [ 'SuccessCount' => [ 'title' => '添加成功数目', 'description' => '添加成功数目', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'NotExistStandardIdList' => [ 'title' => '不存在标准Id列表', 'description' => '不存在标准Id列表', 'type' => 'array', 'items' => [ 'title' => '不存在标准Id列表', 'description' => '不存在标准Id列表', 'type' => 'integer', 'format' => 'int64', 'example' => '1021', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2,\\n \\"NotExistStandardIdList\\": [\\n 1021\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建标准关联关系', ], 'CreateStandardMapping' => [ 'summary' => '创建标准映射关系, 包括有效映射和无效映射。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'AssetGuidList' => [ 'title' => '资产guid列表', 'description' => '资产guid列表', 'type' => 'array', 'items' => [ 'title' => '资产guid列表', 'description' => '资产guid列表', 'type' => 'string', 'required' => true, 'example' => '1121', ], 'required' => true, ], 'StandardId' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'RelationType' => [ 'title' => '映射关系类型: VALID 有效映射、INVALID 无效映射, 默认: VALID', 'description' => '映射关系类型: VALID 有效映射、INVALID 无效映射, 默认: VALID', 'type' => 'string', 'required' => false, 'example' => 'VALID', ], 'InvalidMappingRelationOperationType' => [ 'title' => '引入映射关系时针对无效映射的处理策略: SET_INVALID_TO_VALID 将无效映射置为有效映射、KEEP_INVALID_AND_SKIP 保留无效映射然后跳过, 默认：SET_INVALID_TO_VALID', 'description' => '引入映射关系时针对无效映射的处理策略: SET_INVALID_TO_VALID 将无效映射置为有效映射、KEEP_INVALID_AND_SKIP 保留无效映射然后跳过, 默认：SET_INVALID_TO_VALID', 'type' => 'string', 'required' => false, 'example' => 'SET_INVALID_TO_VALID', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '创建结果', 'description' => '创建结果', 'type' => 'object', 'properties' => [ 'SuccessCount' => [ 'title' => '添加成功数目', 'description' => '添加成功数目', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'FailedGuidList' => [ 'title' => '创建失败资产guid列表', 'description' => '创建失败资产guid列表', 'type' => 'array', 'items' => [ 'title' => '创建失败资产guid列表', 'description' => '创建失败资产guid列表', 'type' => 'string', 'example' => '1021', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2,\\n \\"FailedGuidList\\": [\\n \\"1021\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建标准映射关系', ], 'CreateStandardLookupTable' => [ 'summary' => '创建数据标准码表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '码表名称', 'description' => '码表名称', 'type' => 'string', 'required' => true, 'example' => '城市码表', ], 'Code' => [ 'title' => '码表编码', 'description' => '码表编码', 'type' => 'string', 'required' => true, 'example' => 'CITY', ], 'Description' => [ 'title' => '码表描述', 'description' => '码表描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Owner' => [ 'title' => '码表负责人Id，默认为调用者用户Id', 'description' => '码表负责人Id，默认为调用者用户Id', 'type' => 'string', 'required' => false, 'example' => '30012021', ], 'LookupTableValueList' => [ 'title' => '码表值列表', 'description' => '码表值列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '代码值', 'description' => '代码值', 'type' => 'string', 'required' => true, 'example' => '杭州', ], 'Name' => [ 'title' => '代码名称', 'description' => '代码名称', 'type' => 'string', 'required' => true, 'example' => 'Hangzhou', ], 'EnglishName' => [ 'title' => '代码英文名', 'description' => '代码英文名', 'type' => 'string', 'required' => false, 'example' => 'HZ', ], 'Description' => [ 'title' => '代码描述', 'description' => '代码描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'DirectoryReference' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'object', 'properties' => [ 'Directory' => [ 'title' => '归属目录', 'description' => '归属目录', 'type' => 'string', 'required' => true, 'example' => '/dir1/dir2', ], ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '码表Id', 'description' => '码表Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1234\\n}","type":"json"}]', 'title' => '创建数据标准码表', ], 'CreateStandard' => [ 'summary' => '创建标准。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'EffectiveTimeConfig' => [ 'title' => '生效时间配置', 'description' => '生效时间配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'description' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', 'type' => 'string', 'required' => true, 'example' => 'TIME_PERIOD', ], 'StartTime' => [ 'title' => '开始生效时间', 'description' => '开始生效时间', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '结束生效时间', 'description' => '结束生效时间', 'type' => 'string', 'required' => false, 'example' => '2025-12-30 00:00:00', ], ], 'required' => false, ], 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Owner' => [ 'title' => '负责人,不传为当前用户', 'description' => '负责人,不传为当前用户', 'type' => 'string', 'required' => false, 'example' => '300000913', ], 'StandardTemplateReference' => [ 'title' => '标准所属的标准模板', 'description' => '标准所属的标准模板', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准模板ID', 'description' => '标准模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'Version' => [ 'title' => '标准模板版本号, 默认去最新版本', 'description' => '标准模板版本号, 默认去最新版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'AttributeValueList' => [ 'title' => '引用模板下属性列表相应属性值, 若为空则使用默认值', 'description' => '引用模板下属性列表相应属性值, 若为空则使用默认值', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'AttributeId' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], 'StandardSetReference' => [ 'title' => '标准集的引用', 'description' => '标准集的引用', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '标准集Id', 'description' => '标准集Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], ], 'required' => true, ], 'StandardGeneralMonitorConfig' => [ 'title' => '标准监控配置', 'description' => '标准监控配置', 'type' => 'object', 'properties' => [ 'StandardMonitorConfigList' => [ 'title' => '标准监控配置列表', 'description' => '标准监控配置列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'description' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'RuleName' => [ 'title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Description' => [ 'title' => '规则描述', 'description' => '规则描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Type' => [ 'title' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控类型：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'required' => true, 'example' => 'METADATA', ], 'MonitorFrom' => [ 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'description' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', 'type' => 'string', 'required' => true, 'example' => 'BY_SYSTEM_ATTRIBUTE', ], 'AttributeId' => [ 'title' => '关联的属性Id', 'description' => '关联的属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '112', ], 'AttributeName' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'required' => false, 'example' => 'teset', ], 'AttributeMonitorConfig' => [ 'title' => '关联属性的监控配置', 'description' => '关联属性的监控配置', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'description' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', 'type' => 'string', 'required' => true, 'example' => 'METADATA', ], 'ColumnName' => [ 'title' => '检查的字段', 'description' => '检查的字段', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'IsCaseSensitive' => [ 'title' => '大小写是否敏感', 'description' => '大小写是否敏感', 'type' => 'boolean', 'required' => true, ], ], 'required' => false, ], 'RuleSubType' => [ 'title' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'description' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED', ], 'QualityRuleTemplate' => [ 'title' => '规则模板, 当监控类型为 QUALITY 时必填', 'description' => '规则模板, 当监控类型为 QUALITY 时必填', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板Id', 'description' => '模板Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Type' => [ 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'description' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED', ], ], 'required' => false, ], 'RuleConfigList' => [ 'title' => '规则配置, 当监控类型为 QUALITY 时必填', 'description' => '规则配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => false, ], 'required' => false, ], 'RuleValidateConfigList' => [ 'title' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'description' => '规则校验配置, 当监控类型为 QUALITY 时必填', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '校验配置Id, 由业务随机生成且确保唯一', 'description' => '校验配置Id, 由业务随机生成且确保唯一', 'type' => 'string', 'required' => true, 'example' => 'abc', ], 'ParentId' => [ 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', 'description' => '父校验配置Id, 父规则校验类型只能是RELATION', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'Type' => [ 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'description' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', 'type' => 'string', 'required' => true, 'example' => 'RELATION', ], 'Operator' => [ 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'description' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', 'type' => 'string', 'required' => true, 'example' => 'AND', ], 'Metric' => [ 'title' => '指标, 校验类型为 EXPRESSION 时必填', 'description' => '指标, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'MetricName' => [ 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', 'description' => '指标名称, 校验类型为 EXPRESSION 时必填', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Value' => [ 'title' => '比较的值', 'description' => '比较的值', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], 'NeedGenerateStandardCode' => [ 'title' => '是否需要基于规则生成标准编码，如果为true则属性值部分填入的标准编码无效将重新生成', 'description' => '是否需要基于规则生成标准编码，如果为true则属性值部分填入的标准编码无效将重新生成', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '标准Id', 'description' => '标准Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1234\\n}","type":"json"}]', 'title' => '创建标准', ], 'UpsertQualityWatchAlert' => [ 'summary' => '新建或者修改监控对象告警设置。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更改指令', 'description' => '更改指令', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'QualityAlertInfo' => [ 'title' => '告警设置详情', 'description' => '告警设置详情', 'type' => 'object', 'properties' => [ 'AlertUserChannelList' => [ 'title' => '用户告警渠道', 'description' => '用户告警渠道', 'type' => 'array', 'items' => [ 'title' => '用户告警渠道', 'description' => '用户告警渠道', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'AlertUserList' => [ 'title' => '用户告警列表', 'description' => '用户告警列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户id', 'description' => '用户id', 'type' => 'string', 'required' => false, 'example' => '30012011', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'AlertDutyList' => [ 'title' => '值班表告警列表', 'description' => '值班表告警列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '报警值班表ID', 'description' => '报警值班表ID', 'type' => 'string', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '报警值班表名称', 'description' => '报警值班表名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'AlertDutyChannelList' => [ 'title' => '值班表告警渠道', 'description' => '值班表告警渠道', 'type' => 'array', 'items' => [ 'title' => '值班表告警渠道', 'description' => '值班表告警渠道', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'EnableAlertQualityOwner' => [ 'title' => '开启质量负责人告警', 'description' => '开启质量负责人告警', 'type' => 'boolean', 'required' => false, ], 'AlertQualityOwnerChannelList' => [ 'title' => '质量负责人告警渠道', 'description' => '质量负责人告警渠道', 'type' => 'array', 'items' => [ 'title' => '质量负责人告警渠道', 'description' => '质量负责人告警渠道', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '新建或者修改监控对象告警设置', ], 'UpsertQualityWatch' => [ 'summary' => '新建或更改质量监控对象, 支持添加多种类型的质量监控对象，包括：Dataphin表，全域表，数据源，指标，实时元表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更改指令', 'description' => '更改指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控对象ID: 传递了代表更新,不传递代表新建', 'description' => '监控对象ID: 传递了代表更新,不传递代表新建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Type' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表、DATASOURCE 数据源、INDEX 指标、REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表、DATASOURCE 数据源、INDEX 指标、REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'DataSourceInfo' => [ 'title' => '数据源详情', 'description' => '数据源详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'TableInfo' => [ 'title' => '监控表对象', 'description' => '监控表对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '表Id', 'description' => '表Id', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'IndexInfo' => [ 'title' => '监控指标对象', 'description' => '监控指标对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '指标Id：', 'description' => '指标Id：', 'type' => 'string', 'required' => false, 'example' => '11', ], 'Name' => [ 'title' => '指标名：', 'description' => '指标名：', 'type' => 'string', 'required' => false, 'example' => 'test_idx_', ], 'DisplayName' => [ 'title' => '指标展示名：', 'description' => '指标展示名：', 'type' => 'string', 'required' => false, 'example' => 'logic', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'GranularityId' => [ 'title' => '统计粒度id', 'description' => '统计粒度id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '18755764', ], 'GranularityDisplayName' => [ 'title' => '统计粒度名称', 'description' => '统计粒度名称', 'type' => 'string', 'required' => false, 'example' => '全站汇总表', ], 'ComputeType' => [ 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'description' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'type' => 'string', 'required' => false, 'example' => 'AUTO', ], 'CellSumLogicTableName' => [ 'title' => '单元汇总表名', 'description' => '单元汇总表名', 'type' => 'string', 'required' => false, 'example' => 'dws_all', ], 'Type' => [ 'title' => '指标类型：INDEX', 'description' => '指标类型：INDEX', 'type' => 'string', 'required' => false, 'example' => 'INDEX', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121', ], 'DateType' => [ 'title' => '指标数据类型', 'description' => '指标数据类型', 'type' => 'string', 'required' => false, 'example' => 'bigint', ], ], 'required' => false, ], 'QualityOwner' => [ 'title' => '质量负责人', 'description' => '质量负责人', 'type' => 'string', 'required' => true, 'example' => '30001011', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建或更改质量监控对象', ], 'UpsertQualityTemplate' => [ 'summary' => '新建或者修改质量模板。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更改指令', 'description' => '更改指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板ID: 传递了代表更新,不传递代表新建', 'description' => '模板ID: 传递了代表更新,不传递代表新建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Type' => [ 'title' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'description' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'type' => 'string', 'required' => true, 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'Description' => [ 'title' => '模板描述', 'description' => '模板描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Owner' => [ 'title' => '模板负责人ID', 'description' => '模板负责人ID', 'type' => 'string', 'required' => true, 'example' => '30012011', ], 'Catalog' => [ 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'required' => true, 'example' => 'CONSISTENT', ], 'SupportDataSourceTypeList' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'array', 'items' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], 'required' => false, ], 'FormPropertyList' => [ 'title' => '规则配置键值对', 'description' => '规则配置键值对', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'required' => false, 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'required' => false, 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'required' => false, 'example' => 'abc', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建或者修改质量模板', ], 'UpsertQualitySchedule' => [ 'summary' => '新建或者修改调度设置。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更改指令', 'description' => '更改指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '调度对象ID: 传递代表更新,不传递代表新建', 'description' => '调度对象ID: 传递代表更新,不传递代表新建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'WatchId' => [ 'title' => '监控对象Id', 'description' => '监控对象Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'Name' => [ 'title' => '调度对象名称', 'description' => '调度对象名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Type' => [ 'title' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'description' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'type' => 'string', 'required' => true, 'example' => 'PERIOD_SCHEDULE', ], 'PartitionType' => [ 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'description' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM', ], 'PartitionExpression' => [ 'title' => '分区表达式-自定义表达式', 'description' => '分区表达式-自定义表达式', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}', ], 'TriggerNodeList' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'array', 'items' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'string', 'required' => false, 'example' => 'n_1121', ], 'required' => false, ], 'StaticTaskTriggerType' => [ 'title' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'description' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'type' => 'string', 'required' => false, 'example' => 'ONE_TASKS_FINISHED', ], 'TriggerType' => [ 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'description' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'type' => 'string', 'required' => false, 'example' => 'STATIC_TASK_TRIGGER', ], 'PeriodScheduleIntervalType' => [ 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'description' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'PeriodScheduleParamList' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'array', 'items' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'required' => false, ], 'CronExpression' => [ 'title' => '定时调度-cron表达式', 'description' => '定时调度-cron表达式', 'type' => 'string', 'required' => false, 'example' => '* * 1/* * * *', ], 'ValidatePartitionType' => [ 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'description' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'type' => 'string', 'required' => false, 'example' => 'TASK_REFERRED_PARTITION', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '调度对象ID', 'description' => '调度对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建或者修改调度设置', ], 'UpsertQualityRule' => [ 'summary' => '新建或者修改质量规则。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更改指令', 'description' => '更改指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '规则ID，非空时代表修改，为空时代表新建', 'description' => '规则ID，非空时代表修改，为空时代表新建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', ], 'Name' => [ 'title' => '质量规则名称', 'description' => '质量规则名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Strength' => [ 'title' => '规则强弱: STRONG、WEAK', 'description' => '规则强弱: STRONG、WEAK', 'type' => 'string', 'required' => true, 'example' => 'STRONG', ], 'CatalogList' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'required' => true, 'example' => 'CONSISTENT', ], 'required' => true, ], 'TemplateType' => [ 'title' => '模板类型：FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比 等', 'description' => '模板类型：'."\n" .' - FIELD_NULL_VALUE_VALIDATE 字段空值校验'."\n" .' - FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验'."\n" .' - FIELD_UNIQUE_VALIDATE 字段唯一性校验'."\n" .' - FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验'."\n" .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验'."\n" .' - FUNCTION_TIME_COMPARE 时间函数比较'."\n" .' - SINGLE_TABLE_TIME_COMPARE 单表时间字段比较'."\n" .' - DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较'."\n" .' - FIELD_FORMAT_VALIDATE 字段格式校验'."\n" .' - FIELD_LENGTH_VALIDATE 字段长度校验'."\n" .' - FIELD_VALUE_RANGE_VALIDATE 字段值域校验'."\n" .' - CODE_TABLE_COMPARE 码表参照对比'."\n" .' - STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比'."\n" .' - SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较'."\n" .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较'."\n" .' - TABLE_STABILITY_VALIDATE 表稳定性校验'."\n" .' - TABLE_FLUCTUATION_VALIDATE 表波动性校验'."\n" .' - FIELD_STABILITY_VALIDATE 字段稳定性校验'."\n" .' - FIELD_FLUCTUATION_VALIDATE 字段波动性校验'."\n" .' - CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验'."\n" .' - CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验'."\n" .' - DATASOURCE_AVAILABLE_CHECK 数据源连通性监测'."\n" .' - TABLE_SCHEMA_CHECK 表结构异动监测'."\n" .' - REAL_TIME_OFFLINE_COMPARE 实时离线对比'."\n" .' - REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测'."\n" .' - REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比 等', 'type' => 'string', 'required' => true, 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'TemplateId' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'WatchId' => [ 'title' => '所属监控ID', 'description' => '所属监控ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'EnableErrorArchive' => [ 'title' => '是否启动异常归档', 'description' => '是否启动异常归档', 'type' => 'boolean', 'required' => false, ], 'ValidateConditionList' => [ 'title' => '校验条件', 'description' => '校验条件', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '条件节点id', 'description' => '条件节点id', 'type' => 'string', 'required' => false, 'example' => '268', ], 'Type' => [ 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'description' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'type' => 'string', 'required' => false, 'example' => 'RELATION', ], 'Operator' => [ 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'description' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'type' => 'string', 'required' => false, 'example' => 'AND', ], 'Metric' => [ 'title' => '指标', 'description' => '指标', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Value' => [ 'title' => '值', 'description' => '值', 'type' => 'string', 'required' => false, 'example' => '1', ], 'ParentId' => [ 'title' => '条件父节点Id', 'description' => '条件父节点Id', 'type' => 'string', 'required' => false, 'example' => '123', ], ], 'required' => false, ], 'required' => false, ], 'FormPropertyList' => [ 'title' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'description' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'required' => false, 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'required' => false, 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'required' => false, 'example' => 'abc', ], ], 'required' => false, ], 'required' => false, ], 'AttributeWithValueList' => [ 'title' => '规则业务属性配置', 'description' => '规则业务属性配置', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'AttributeInfo' => [ 'title' => '属性详情', 'description' => '属性详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '711484689131', ], 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'required' => false, 'example' => 'attr01', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Enabled' => [ 'title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'required' => false, ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', 'required' => false, ], 'Searchable' => [ 'title' => '是否可搜索', 'description' => '是否可搜索', 'type' => 'boolean', 'required' => false, ], 'ValueConfig' => [ 'title' => '属性值配置详情', 'description' => '属性值配置详情', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'description' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'description' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'type' => 'string', 'required' => false, 'example' => 'STRING', ], 'Length' => [ 'title' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'description' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '986992', ], 'ValueEnumList' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'DefaultValue' => [ 'title' => '属性默认值', 'description' => '属性默认值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'required' => false, 'example' => '123', ], 'required' => false, ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'required' => false, 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', 'required' => false, ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'required' => false, 'example' => '11', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], 'AttributeValue' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'required' => false, 'example' => '123', ], 'required' => false, ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'required' => false, 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', 'required' => false, ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'required' => false, 'example' => '11', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '任务规则ID', 'description' => '任务规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建或者修改质量规则', ], 'UpdateQualityWatchSwitch' => [ 'summary' => '批量开启或关闭质量监控对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Open' => [ 'title' => '是否开启', 'description' => '是否开启', 'type' => 'boolean', 'required' => true, ], 'WatchIdList' => [ 'title' => '监控Id列表', 'description' => '监控Id列表', 'type' => 'array', 'items' => [ 'title' => '监控Id列表', 'description' => '监控Id列表', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '生效记录数', 'description' => '生效记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量开启或关闭质量监控对象', ], 'UpdateQualityRuleSwitch' => [ 'summary' => '批量开启或关闭质量规则。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Open' => [ 'title' => '是否开启', 'description' => '是否开启', 'type' => 'boolean', 'required' => true, ], 'RuleIdList' => [ 'title' => '规则Id列表', 'description' => '规则Id列表', 'type' => 'array', 'items' => [ 'title' => '规则Id列表', 'description' => '规则Id列表', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '生效记录数', 'description' => '生效记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量开启或关闭质量规则', ], 'SubmitQualityWatchTasks' => [ 'summary' => '批量提交监控对象校验任务。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '提交指令', 'description' => '提交指令', 'type' => 'object', 'properties' => [ 'WatchIdList' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'array', 'items' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'required' => true, ], 'PartitionExpression' => [ 'title' => '分区表达式-自定义表达式', 'description' => '分区表达式-自定义表达式', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}', ], 'BizDate' => [ 'title' => '业务日期，格式：yyyy-MM-dd', 'description' => '业务日期，格式：yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-06-30', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SubmitResult' => [ 'title' => '执行结果', 'description' => '执行结果', 'type' => 'object', 'properties' => [ 'WatchTaskIdList' => [ 'title' => '监控对象校验任务ID列表', 'description' => '监控对象校验任务ID列表', 'type' => 'array', 'items' => [ 'title' => '监控对象校验任务ID列表', 'description' => '监控对象校验任务ID列表', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SubmitResult\\": {\\n \\"WatchTaskIdList\\": [\\n 1\\n ]\\n }\\n}","type":"json"}]', 'title' => '批量提交监控对象校验任务', ], 'SubmitQualityRuleTasks' => [ 'summary' => '批量提交规则任务,支持试跑。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '提交指令', 'description' => '提交指令', 'type' => 'object', 'properties' => [ 'IsTestRun' => [ 'title' => '是否为试跑: true 试跑、false 正式运行, 默认 true', 'description' => '是否为试跑: true 试跑、false 正式运行', 'type' => 'boolean', 'required' => true, ], 'WatchRuleIdList' => [ 'title' => '监控及规则ID', 'description' => '监控及规则ID', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], 'required' => false, ], 'required' => true, ], 'PartitionExpressionFrom' => [ 'title' => '试跑分区表达式来源: SCHEDULE 已有调度、CUSTOM 自定义', 'description' => '试跑分区表达式来源: SCHEDULE 已有调度、CUSTOM 自定义', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM', ], 'ScheduleId' => [ 'title' => '已有调度ID', 'description' => '已有调度ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'PartitionExpression' => [ 'title' => '分区表达式-自定义表达式', 'description' => '分区表达式-自定义表达式', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}', ], 'BizDate' => [ 'title' => '业务日期，格式：yyyy-MM-dd', 'description' => '业务日期，格式：yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-06-30', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SubmitResult' => [ 'title' => '执行结果', 'description' => '执行结果', 'type' => 'object', 'properties' => [ 'RuleTaskIdList' => [ 'title' => '规则任务Id,试跑场景返回', 'description' => '规则任务Id,试跑场景返回', 'type' => 'array', 'items' => [ 'title' => '规则任务Id,试跑场景返回', 'description' => '规则任务Id,试跑场景返回', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'WatchTaskIdList' => [ 'title' => '监控对象任务ID,非试跑场景返回', 'description' => '监控对象任务ID,非试跑场景返回', 'type' => 'array', 'items' => [ 'title' => '监控对象任务ID,非试跑场景返回', 'description' => '监控对象任务ID,非试跑场景返回', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SubmitResult\\": {\\n \\"RuleTaskIdList\\": [\\n 1\\n ],\\n \\"WatchTaskIdList\\": [\\n 1\\n ]\\n }\\n}","type":"json"}]', 'title' => '批量提交规则任务', ], 'RemoveQualityRuleSchedules' => [ 'summary' => '批量删除质量规则和调度的绑定关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '解绑指令', 'description' => '解绑指令', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '平均值', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'ScheduleIdList' => [ 'title' => '调度ID', 'description' => '调度ID', 'type' => 'array', 'items' => [ 'title' => '调度ID', 'description' => '调度ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 0\\n}","type":"json"}]', 'title' => '批量删除质量规则和调度的绑定关系', ], 'ListQualityWatches' => [ 'summary' => '分页查询质量监控对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'WatchTypeList' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'array', 'items' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => false, 'example' => 'TABLE', ], 'required' => false, ], 'StatusList' => [ 'title' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'array', 'items' => [ 'title' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'required' => false, 'example' => 'ENABLE', ], 'required' => false, ], 'LatestWatchTaskStatusList' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'array', 'items' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'CurrentUserOwned' => [ 'title' => '是否当前用户负责的监控对象', 'description' => '是否当前用户负责的监控对象', 'type' => 'boolean', 'required' => false, ], 'QualityOwnerList' => [ 'title' => '质量负责人', 'description' => '质量负责人', 'type' => 'array', 'items' => [ 'title' => '质量负责人', 'description' => '质量负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'TableOwnerList' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'array', 'items' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'TableTypeList' => [ 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'array', 'items' => [ 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => false, 'example' => 'LOGIC_DIM_TABLE', ], 'required' => false, ], 'DataSourceIdList' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'array', 'items' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], 'DataSourceTypeList' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'description' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'type' => 'array', 'items' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'description' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE', ], 'required' => false, ], 'BizUnitNameList' => [ 'title' => '所属板块名称', 'description' => '所属板块名称', 'type' => 'array', 'items' => [ 'title' => '所属板块名称', 'description' => '所属板块名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'ProjectNameList' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'array', 'items' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'DataSourceScopeList' => [ 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'description' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'type' => 'array', 'items' => [ 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'description' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'required' => false, ], 'DataSourceOwnerList' => [ 'title' => '数据源负责人', 'description' => '数据源负责人', 'type' => 'array', 'items' => [ 'title' => '数据源负责人', 'description' => '数据源负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'IndexOwnerList' => [ 'title' => '指标负责人', 'description' => '指标负责人', 'type' => 'array', 'items' => [ 'title' => '指标负责人', 'description' => '指标负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'IndexComputeTypeList' => [ 'title' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', 'description' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', 'type' => 'array', 'items' => [ 'title' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', 'description' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', 'type' => 'string', 'required' => false, 'example' => 'AUTO', ], 'required' => false, ], 'Keyword' => [ 'title' => '搜索关键词: 监控表名称', 'description' => '搜索关键词: 监控表名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'QualityWatchList' => [ 'title' => '分页质量告警列表', 'description' => '分页质量告警列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'TABLE', ], 'Id' => [ 'title' => '监控Id', 'description' => '监控Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Name' => [ 'title' => '监控名称', 'description' => '监控名称', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => '状态：ENABLE，DISABLE', 'description' => '状态：ENABLE，DISABLE', 'type' => 'string', 'example' => 'ENABLE', ], 'DataSourceInfo' => [ 'title' => '数据源详情', 'description' => '数据源详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => '1', ], 'Type' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP', 'description' => '数据源类型: MAX_COMPUTE、HADOOP', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Env' => [ 'title' => '环境标识：PROD、DEV', 'description' => '环境标识：PROD、DEV', 'type' => 'string', 'example' => 'DEV', ], ], ], 'TableInfo' => [ 'title' => '监控表对象', 'description' => '监控表对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE', ], 'Catalog' => [ 'title' => '表catalog', 'description' => '表catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '表Id', 'description' => '表Id', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '表名称', 'description' => '表名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Env' => [ 'title' => '环境标识：DEV、PROD', 'description' => '环境标识：DEV、PROD', 'type' => 'string', 'example' => 'DEV', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'DataSourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => '22', ], 'IsPartitionTable' => [ 'title' => '是否分区表', 'description' => '是否分区表', 'type' => 'boolean', ], ], ], 'IndexInfo' => [ 'title' => '指标详情', 'description' => '指标详情', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'Catalog' => [ 'title' => '指标catalog', 'description' => '指标catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '指标Id：', 'description' => '指标Id：', 'type' => 'string', 'example' => '11', ], 'Guid' => [ 'title' => '指标guid：', 'description' => '指标guid：', 'type' => 'string', 'example' => '1121', ], 'Name' => [ 'title' => '指标名：', 'description' => '指标名：', 'type' => 'string', 'example' => 'logic', ], 'DisplayName' => [ 'title' => '指标展示名：', 'description' => '指标展示名：', 'type' => 'string', 'example' => 'logic', ], 'GranularityId' => [ 'title' => '统计粒度id', 'description' => '统计粒度id', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764', ], 'GranularityDisplayName' => [ 'title' => '统计粒度名称', 'description' => '统计粒度名称', 'type' => 'string', 'example' => '全站汇总表', ], 'ComputeType' => [ 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'description' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'type' => 'string', 'example' => 'AUTO', ], 'CellSumLogicTableName' => [ 'title' => '单元汇总表名', 'description' => '单元汇总表名', 'type' => 'string', 'example' => 'dws_all', ], 'Type' => [ 'title' => '指标类型：INDEX', 'description' => '指标类型：INDEX', 'type' => 'string', 'example' => 'INDEX', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'DateType' => [ 'title' => '指标数据类型', 'description' => '指标数据类型', 'type' => 'string', 'example' => 'bigint', ], ], ], 'QualityOwner' => [ 'title' => '质量负责人用户ID', 'description' => '质量负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'QualityOwnerName' => [ 'title' => '质量负责人显示名称', 'description' => '质量负责人显示名称', 'type' => 'string', 'example' => 'test', ], 'LatestWatchTaskId' => [ 'title' => '最近一次监控对象校验记录ID', 'description' => '最近一次监控对象校验记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LatestWatchTaskStatus' => [ 'title' => '最近一次监控对象校验记录状态', 'description' => '最近一次监控对象校验记录状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'RuleCount' => [ 'title' => '规则数', 'description' => '规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'EnabledRuleCount' => [ 'title' => '生效规则数', 'description' => '生效规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"QualityWatchList\\": [\\n {\\n \\"Type\\": \\"TABLE\\",\\n \\"Id\\": 11,\\n \\"Name\\": \\"test\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"DataSourceInfo\\": {\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"1\\",\\n \\"Type\\": \\"MAX_COMPUTE\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Env\\": \\"DEV\\"\\n },\\n \\"TableInfo\\": {\\n \\"Type\\": \\"LOGIC_DIM_TABLE\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"test\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Env\\": \\"DEV\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"DataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"DataSourceId\\": \\"22\\",\\n \\"IsPartitionTable\\": true\\n },\\n \\"IndexInfo\\": {\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"11\\",\\n \\"Guid\\": \\"1121\\",\\n \\"Name\\": \\"logic\\",\\n \\"DisplayName\\": \\"logic\\",\\n \\"GranularityId\\": 18755764,\\n \\"GranularityDisplayName\\": \\"全站汇总表\\",\\n \\"ComputeType\\": \\"AUTO\\",\\n \\"CellSumLogicTableName\\": \\"dws_all\\",\\n \\"Type\\": \\"INDEX\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"DateType\\": \\"bigint\\"\\n },\\n \\"QualityOwner\\": \\"30012011\\",\\n \\"QualityOwnerName\\": \\"test\\",\\n \\"LatestWatchTaskId\\": 1,\\n \\"LatestWatchTaskStatus\\": \\"SUCCESS\\",\\n \\"RuleCount\\": 11,\\n \\"EnabledRuleCount\\": 1,\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询质量监控对象', ], 'ListQualityWatchTasks' => [ 'summary' => '分页查询质量监控任务。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'WatchTypeList' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'array', 'items' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => false, 'example' => 'TABLE', ], 'required' => false, ], 'DataSourceIdList' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'array', 'items' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, ], 'DataSourceScopeList' => [ 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'description' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'type' => 'array', 'items' => [ 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'description' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', 'type' => 'string', 'required' => false, 'example' => 'ALL', ], 'required' => false, ], 'DataSourceTypeList' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'description' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'type' => 'array', 'items' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'description' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE', ], 'required' => false, ], 'ErrorRuleStrengthList' => [ 'title' => '规则异常类型：STRONG 强、WEAK 弱', 'description' => '规则异常类型：STRONG 强、WEAK 弱', 'type' => 'array', 'items' => [ 'title' => '规则异常类型：STRONG 强、WEAK 弱', 'description' => '规则异常类型：STRONG 强、WEAK 弱', 'type' => 'string', 'required' => false, 'example' => 'STRONG', ], 'required' => false, ], 'TableTypeList' => [ 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'array', 'items' => [ 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => false, 'example' => 'LOGIC_DIM_TABLE', ], 'required' => false, ], 'ProjectNameList' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'array', 'items' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'BizUnitNameList' => [ 'title' => '所属板块名称', 'description' => '所属板块名称', 'type' => 'array', 'items' => [ 'title' => '所属板块名称', 'description' => '所属板块名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'CurrentUserOwned' => [ 'title' => '我负责的监控任务对象', 'description' => '我负责的监控任务对象', 'type' => 'boolean', 'required' => false, ], 'QualityOwnerList' => [ 'title' => '质量负责人', 'description' => '质量负责人', 'type' => 'array', 'items' => [ 'title' => '质量负责人', 'description' => '质量负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'StatusList' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'array', 'items' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'BizDate' => [ 'title' => '业务日期过滤', 'description' => '业务日期过滤', 'type' => 'string', 'required' => false, 'example' => '2025-06-30', ], 'Keyword' => [ 'title' => '搜索关键词: 监控表名称', 'description' => '搜索关键词: 监控表名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DataSourceOwnerList' => [ 'title' => '数据源负责人', 'description' => '数据源负责人', 'type' => 'array', 'items' => [ 'title' => '数据源负责人', 'description' => '数据源负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'TableOwnerList' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'array', 'items' => [ 'title' => '表负责人', 'description' => '表负责人', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'QualityWatchTaskList' => [ 'title' => '分页质量模板列表', 'description' => '分页质量模板列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控任务ID', 'description' => '监控任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StartTime' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'EndTime' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 20:00:00', ], 'QualityOwner' => [ 'title' => '质量负责人用户ID', 'description' => '质量负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'QualityOwnerName' => [ 'title' => '质量负责人名称', 'description' => '质量负责人名称', 'type' => 'string', 'example' => 'test', ], 'RuleCountInfo' => [ 'title' => '质量规则计数', 'description' => '质量规则计数', 'type' => 'object', 'properties' => [ 'ValidateRuleCount' => [ 'title' => '校验规则技术', 'description' => '校验规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'StrongRuleCount' => [ 'title' => '强规则技术', 'description' => '强规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'WeakRuleCount' => [ 'title' => '弱规则技术', 'description' => '弱规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'RuleIdList' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'array', 'items' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], 'Status' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'example' => 'RUNNING', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'BizDateFormat' => [ 'title' => '业务日期格式', 'description' => '业务日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"QualityWatchTaskList\\": [\\n {\\n \\"Id\\": 1,\\n \\"WatchId\\": 1,\\n \\"StartTime\\": \\"2025-06-30 08:00:00\\",\\n \\"EndTime\\": \\"2025-06-30 20:00:00\\",\\n \\"QualityOwner\\": \\"30012011\\",\\n \\"QualityOwnerName\\": \\"test\\",\\n \\"RuleCountInfo\\": {\\n \\"ValidateRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n },\\n \\"StrongRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n },\\n \\"WeakRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n }\\n },\\n \\"RuleIdList\\": [\\n 2\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"BizDateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询质量监控任务', ], 'ListQualityTemplates' => [ 'summary' => '分页查询质量模板。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'CatalogList' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT', ], 'required' => false, ], 'SupportDataSourceTypeList' => [ 'title' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', 'description' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', 'type' => 'array', 'items' => [ 'title' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', 'description' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE', ], 'required' => false, ], 'TemplateTypeList' => [ 'title' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'description' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'type' => 'array', 'items' => [ 'title' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'description' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'type' => 'string', 'required' => false, 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'required' => false, ], 'WatchTypeList' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'array', 'items' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => false, 'example' => 'TABLE', ], 'required' => false, ], 'TemplateSourceList' => [ 'title' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', 'description' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', 'type' => 'array', 'items' => [ 'title' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', 'description' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM', ], 'required' => false, ], 'CurrentUserOwned' => [ 'title' => '是否当前用户负责的模板', 'description' => '是否当前用户负责的模板', 'type' => 'boolean', 'required' => false, ], 'TemplateOwnerList' => [ 'title' => '模板负责人', 'description' => '模板负责人', 'type' => 'array', 'items' => [ 'title' => '模板负责人', 'description' => '模板负责人', 'type' => 'string', 'required' => false, 'example' => '30012011', ], 'required' => false, ], 'Keyword' => [ 'title' => '搜索词筛选，支持模板名称', 'description' => '搜索词筛选，支持模板名称', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'QualityTemplateList' => [ 'title' => '分页质量模板列表', 'description' => '分页质量模板列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板Id', 'description' => '模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'description' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'TypeName' => [ 'title' => '模板类型展示名', 'description' => '模板类型展示名', 'type' => 'string', 'example' => '字段空值校验', ], 'Description' => [ 'title' => '模板描述', 'description' => '模板描述', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '归属人用户ID', 'description' => '归属人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '归属人名称', 'description' => '归属人名称', 'type' => 'string', 'example' => 'test', ], 'Catalog' => [ 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'example' => 'CONSISTENT', ], 'CatalogName' => [ 'title' => '模板分类展示名', 'description' => '模板分类展示名', 'type' => 'string', 'example' => '一致性', ], 'SupportAllDataSourceType' => [ 'title' => '支持所有数据源类型', 'description' => '支持所有数据源类型', 'type' => 'boolean', ], 'SupportDataSourceTypeList' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'array', 'items' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'string', 'example' => 'MySQL', ], ], 'IsSystemTemplate' => [ 'title' => '是否系统模板', 'description' => '是否系统模板', 'type' => 'boolean', ], 'FormPropertyList' => [ 'title' => '规则配置键值对', 'description' => '规则配置键值对', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'abc', ], ], ], ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建人名称', 'description' => '创建人名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改人ID', 'description' => '最近修改人ID', 'type' => 'string', 'example' => '30012011', ], 'ModifierName' => [ 'title' => '最近修改人名称', 'description' => '最近修改人名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"QualityTemplateList\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"FIELD_NULL_VALUE_VALIDATE\\",\\n \\"TypeName\\": \\"字段空值校验\\",\\n \\"Description\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"Catalog\\": \\"CONSISTENT\\",\\n \\"CatalogName\\": \\"一致性\\",\\n \\"SupportAllDataSourceType\\": true,\\n \\"SupportDataSourceTypeList\\": [\\n \\"MySQL\\"\\n ],\\n \\"IsSystemTemplate\\": true,\\n \\"FormPropertyList\\": [\\n {\\n \\"ComponentType\\": \\"expression\\",\\n \\"Name\\": \\"col\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifierName\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询质量模板', ], 'ListQualityRules' => [ 'summary' => '分页查询质量规则。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控ID', 'description' => '监控ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'StatusList' => [ 'title' => '规则生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '规则生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'array', 'items' => [ 'title' => '规则生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '规则生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'required' => false, 'example' => 'ENABLE', ], 'required' => false, ], 'CatalogList' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT', ], 'required' => false, ], 'TemplateIdList' => [ 'title' => '规则模板', 'description' => '规则模板', 'type' => 'array', 'items' => [ 'title' => '规则模板', 'description' => '规则模板', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], 'required' => false, ], 'RuleStrengthList' => [ 'title' => '规则强度: STRONG 强、WEAK 弱', 'description' => '规则强度: STRONG 强、WEAK 弱', 'type' => 'array', 'items' => [ 'title' => '规则强度: STRONG 强、WEAK 弱', 'description' => '规则强度: STRONG 强、WEAK 弱', 'type' => 'string', 'required' => false, 'example' => 'STRONG', ], 'required' => false, ], 'TestRunTaskValidateResultList' => [ 'title' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'description' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'type' => 'array', 'items' => [ 'title' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'description' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'TestRunTaskStatusList' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'array', 'items' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'Keyword' => [ 'title' => '搜索词筛选，支持规则名称和校验对象搜索', 'description' => '搜索词筛选，支持规则名称和校验对象搜索', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'QualityRuleList' => [ 'title' => '分页质量规则任务列表', 'description' => '分页质量规则任务列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '质量规则名称', 'description' => '质量规则名称', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => '质量规则状态: ENABLE，DISABLE', 'description' => '质量规则状态: ENABLE，DISABLE', 'type' => 'string', 'example' => 'ENABLE', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Strength' => [ 'title' => '规则强弱: STRONG、WEAK', 'description' => '规则强弱: STRONG、WEAK', 'type' => 'string', 'example' => 'STRONG', ], 'CatalogList' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'example' => 'CONSISTENT', ], ], 'TemplateType' => [ 'title' => '模板类型', 'description' => '模板类型：'."\n" .' - FIELD_NULL_VALUE_VALIDATE 字段空值校验'."\n" .' - FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验'."\n" .' - FIELD_UNIQUE_VALIDATE 字段唯一性校验'."\n" .' - FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验'."\n" .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验'."\n" .' - FUNCTION_TIME_COMPARE 时间函数比较'."\n" .' - SINGLE_TABLE_TIME_COMPARE 单表时间字段比较'."\n" .' - DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较'."\n" .' - FIELD_FORMAT_VALIDATE 字段格式校验'."\n" .' - FIELD_LENGTH_VALIDATE 字段长度校验'."\n" .' - FIELD_VALUE_RANGE_VALIDATE 字段值域校验'."\n" .' - CODE_TABLE_COMPARE 码表参照对比'."\n" .' - STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比'."\n" .' - SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较'."\n" .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较'."\n" .' - TABLE_STABILITY_VALIDATE 表稳定性校验'."\n" .' - TABLE_FLUCTUATION_VALIDATE 表波动性校验'."\n" .' - FIELD_STABILITY_VALIDATE 字段稳定性校验'."\n" .' - FIELD_FLUCTUATION_VALIDATE 字段波动性校验'."\n" .' - CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验'."\n" .' - CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验'."\n" .' - DATASOURCE_AVAILABLE_CHECK 数据源连通性监测'."\n" .' - TABLE_SCHEMA_CHECK 表结构异动监测'."\n" .' - REAL_TIME_OFFLINE_COMPARE 实时离线对比'."\n" .' - REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测'."\n" .' - REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比 等', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'TemplateId' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TemplateName' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => '1', ], 'TemplateScope' => [ 'title' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', 'description' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', 'type' => 'string', 'example' => 'CUSTOM', ], 'WatchId' => [ 'title' => '所属监控ID', 'description' => '所属监控ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'EnableErrorArchive' => [ 'title' => '是否启动异常归档', 'description' => '是否启动异常归档', 'type' => 'boolean', ], 'ValidateConditionList' => [ 'title' => '校验条件列表', 'description' => '校验条件列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '条件节点id', 'description' => '条件节点id', 'type' => 'string', 'example' => '268', ], 'Type' => [ 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'description' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'type' => 'string', 'example' => 'RELATION', ], 'Operator' => [ 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'description' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'type' => 'string', 'example' => 'AND', ], 'OperatorName' => [ 'title' => '操作符名称', 'description' => '操作符名称', 'type' => 'string', 'example' => '且', ], 'Metric' => [ 'title' => '指标', 'description' => '指标', 'type' => 'string', 'example' => 'test', ], 'MetricName' => [ 'title' => '指标名称', 'description' => '指标名称', 'type' => 'string', 'example' => 'test', ], 'Value' => [ 'title' => '值', 'description' => '值', 'type' => 'string', 'example' => '1', ], 'ParentId' => [ 'title' => '条件父节点Id', 'description' => '条件父节点Id', 'type' => 'string', 'example' => '123', ], ], ], ], 'TestRunRuleTaskId' => [ 'title' => '最近一次试跑任务ID', 'description' => '最近一次试跑任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'TestRunRuleTaskStatus' => [ 'title' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', 'description' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', 'type' => 'string', 'example' => 'SUCCESS', ], 'TestRunRuleValidateResult' => [ 'title' => '试跑校验是否通过', 'description' => '试跑校验是否通过', 'type' => 'boolean', ], 'ScheduleBindList' => [ 'title' => '规则绑定的调度列表', 'description' => '规则绑定的调度列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ScheduleId' => [ 'title' => '调度Id', 'description' => '调度Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ScheduleName' => [ 'title' => '调度名称', 'description' => '调度名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'FormPropertyList' => [ 'title' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'description' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'abc', ], ], ], ], 'ValidateObject' => [ 'title' => '校验对象', 'description' => '校验对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '校验对象类型: UNKNOWN，TABLE，COLUMN，DATASOURCE，DATASOURCE_TABLE，REALTIME，INDEX，CHAIN', 'description' => '校验对象类型: UNKNOWN，TABLE，COLUMN，DATASOURCE，DATASOURCE_TABLE，REALTIME，INDEX，CHAIN', 'type' => 'string', 'example' => 'TABLE', ], 'Name' => [ 'title' => '校验对象名称', 'description' => '校验对象名称', 'type' => 'string', 'example' => 'test', ], ], ], 'AttributeWithValueList' => [ 'title' => '规则业务属性配置', 'description' => '规则业务属性配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AttributeInfo' => [ 'title' => '属性详情', 'description' => '属性详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '-168890138815', ], 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'attr01', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Enabled' => [ 'title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', ], 'Searchable' => [ 'title' => '是否可搜索', 'description' => '是否可搜索', 'type' => 'boolean', ], 'ValueConfig' => [ 'title' => '属性值配置详情', 'description' => '属性值配置详情', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'description' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'description' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'type' => 'string', 'example' => 'STRING', ], 'Length' => [ 'title' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'description' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'type' => 'integer', 'format' => 'int32', 'example' => '6997283', ], 'ValueEnumList' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'string', 'example' => 'test', ], ], 'DefaultValue' => [ 'title' => '属性默认值', 'description' => '属性默认值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'example' => '123', ], ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], ], ], ], ], 'AttributeValue' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'example' => '123', ], ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], 'ModifierName' => [ 'title' => '最近修改用户名称', 'description' => '最近修改用户名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"QualityRuleList\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"Description\\": \\"test\\",\\n \\"Strength\\": \\"STRONG\\",\\n \\"CatalogList\\": [\\n \\"CONSISTENT\\"\\n ],\\n \\"TemplateType\\": \\"FIELD_NULL_VALUE_VALIDATE\\",\\n \\"TemplateId\\": 1,\\n \\"TemplateName\\": \\"1\\",\\n \\"TemplateScope\\": \\"CUSTOM\\",\\n \\"WatchId\\": 1,\\n \\"EnableErrorArchive\\": true,\\n \\"ValidateConditionList\\": [\\n {\\n \\"Id\\": \\"268\\",\\n \\"Type\\": \\"RELATION\\",\\n \\"Operator\\": \\"AND\\",\\n \\"OperatorName\\": \\"且\\",\\n \\"Metric\\": \\"test\\",\\n \\"MetricName\\": \\"test\\",\\n \\"Value\\": \\"1\\",\\n \\"ParentId\\": \\"123\\"\\n }\\n ],\\n \\"TestRunRuleTaskId\\": 22,\\n \\"TestRunRuleTaskStatus\\": \\"SUCCESS\\",\\n \\"TestRunRuleValidateResult\\": true,\\n \\"ScheduleBindList\\": [\\n {\\n \\"ScheduleId\\": 1,\\n \\"ScheduleName\\": \\"test\\"\\n }\\n ],\\n \\"FormPropertyList\\": [\\n {\\n \\"ComponentType\\": \\"expression\\",\\n \\"Name\\": \\"col\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"ValidateObject\\": {\\n \\"Type\\": \\"TABLE\\",\\n \\"Name\\": \\"test\\"\\n },\\n \\"AttributeWithValueList\\": [\\n {\\n \\"AttributeInfo\\": {\\n \\"Id\\": -168890138815,\\n \\"Name\\": \\"attr01\\",\\n \\"Description\\": \\"test\\",\\n \\"Enabled\\": true,\\n \\"Required\\": true,\\n \\"Searchable\\": true,\\n \\"ValueConfig\\": {\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"DataType\\": \\"STRING\\",\\n \\"Length\\": 6997283,\\n \\"ValueEnumList\\": [\\n \\"test\\"\\n ],\\n \\"DefaultValue\\": {\\n \\"ValueList\\": [\\n \\"123\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n }\\n }\\n },\\n \\"AttributeValue\\": {\\n \\"ValueList\\": [\\n \\"123\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n }\\n }\\n ],\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifierName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询质量规则', ], 'ListQualityRuleTasks' => [ 'summary' => '分页查询质量规则任务。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'WatchTaskId' => [ 'title' => '监控表任务ID', 'description' => '监控表任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'CatalogList' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT', ], 'required' => false, ], 'RuleStrengthList' => [ 'title' => '规则强度: STRONG 强、WEAK 弱', 'description' => '规则强度: STRONG 强、WEAK 弱', 'type' => 'array', 'items' => [ 'title' => '规则强度: STRONG 强、WEAK 弱', 'description' => '规则强度: STRONG 强、WEAK 弱', 'type' => 'string', 'required' => false, 'example' => 'STRONG', ], 'required' => false, ], 'StatusList' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'array', 'items' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'ValidateResultList' => [ 'title' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'description' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'type' => 'array', 'items' => [ 'title' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'description' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'RuleTagList' => [ 'title' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', 'description' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', 'type' => 'array', 'items' => [ 'title' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', 'description' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', ], 'required' => false, ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'required' => false, 'example' => '2025-06-30', ], 'Keyword' => [ 'title' => '搜索词，字段名或者规则名搜索', 'description' => '搜索词，字段名或者规则名搜索', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'QualityRuleTaskList' => [ 'title' => '分页质量规则任务列表', 'description' => '分页质量规则任务列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '所属监控ID', 'description' => '所属监控ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'WatchTaskId' => [ 'title' => '监控任务ID，试跑的规则任务这个ID为空', 'description' => '监控任务ID，试跑的规则任务这个ID为空', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Id' => [ 'title' => '规则任务ID', 'description' => '规则任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'TemplateId' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Status' => [ 'title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'running', ], 'StartTime' => [ 'title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '截止时间', 'description' => '截止时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ValidatePartition' => [ 'title' => '校验分区', 'description' => '校验分区', 'type' => 'string', 'example' => '20251011', ], 'ValidateObjectType' => [ 'title' => '校验对象类型', 'description' => '校验对象类型', 'type' => 'string', 'example' => 'column', ], 'ValidateObjectName' => [ 'title' => '校验对象名称', 'description' => '校验对象名称', 'type' => 'string', 'example' => 'test', ], 'ValidateSuccess' => [ 'title' => '是否校验通过', 'description' => '是否校验通过', 'type' => 'boolean', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'BizDateFormat' => [ 'title' => '业务日期格式', 'description' => '业务日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"QualityRuleTaskList\\": [\\n {\\n \\"WatchId\\": 1,\\n \\"WatchTaskId\\": 1,\\n \\"Id\\": 1,\\n \\"RuleId\\": 11,\\n \\"TemplateId\\": 11,\\n \\"Status\\": \\"running\\",\\n \\"StartTime\\": \\"2025-06-30 00:00:00\\",\\n \\"EndTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ValidatePartition\\": \\"20251011\\",\\n \\"ValidateObjectType\\": \\"column\\",\\n \\"ValidateObjectName\\": \\"test\\",\\n \\"ValidateSuccess\\": true,\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"BizDateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询质量规则任务', ], 'GetQualityWatchTaskLog' => [ 'summary' => '获取监控任务对象的日志内容。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'WatchTaskId', 'in' => 'query', 'schema' => [ 'title' => '监控任务ID', 'description' => '监控任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '日志内容', 'description' => '日志内容', 'type' => 'string', 'example' => 'test', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"test\\"\\n}","type":"json"}]', 'title' => '获取监控任务对象的日志内容', ], 'GetQualityWatchTask' => [ 'summary' => '获取监控任务对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'WatchTaskId', 'in' => 'query', 'schema' => [ 'title' => '监控任务ID', 'description' => '监控任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'WatchTaskInfo' => [ 'title' => '监控任务对象详情', 'description' => '监控任务对象详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '监控任务ID', 'description' => '监控任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StartTime' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'EndTime' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 20:00:00', ], 'QualityOwner' => [ 'title' => '质量负责人用户ID', 'description' => '质量负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'QualityOwnerName' => [ 'title' => '质量负责人名称', 'description' => '质量负责人名称', 'type' => 'string', 'example' => 'test', ], 'RuleCountInfo' => [ 'title' => '质量规则计数', 'description' => '质量规则计数', 'type' => 'object', 'properties' => [ 'ValidateRuleCount' => [ 'title' => '校验规则技术', 'description' => '校验规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'StrongRuleCount' => [ 'title' => '强规则技术', 'description' => '强规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'WeakRuleCount' => [ 'title' => '弱规则技术', 'description' => '弱规则技术', 'type' => 'object', 'properties' => [ 'TotalRuleCount' => [ 'title' => '总规则数', 'description' => '总规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FinishedRuleCount' => [ 'title' => '执行完成规则数', 'description' => '执行完成规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ErrorRuleCount' => [ 'title' => '执行失败规则数', 'description' => '执行失败规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SuccessRuleCount' => [ 'title' => '执行成功规则数', 'description' => '执行成功规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'RuleIdList' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'array', 'items' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], 'Status' => [ 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'description' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', 'type' => 'string', 'example' => 'RUNNING', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'BizDateFormat' => [ 'title' => '业务日期格式', 'description' => '业务日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"WatchTaskInfo\\": {\\n \\"Id\\": 1,\\n \\"WatchId\\": 1,\\n \\"StartTime\\": \\"2025-06-30 08:00:00\\",\\n \\"EndTime\\": \\"2025-06-30 20:00:00\\",\\n \\"QualityOwner\\": \\"30012011\\",\\n \\"QualityOwnerName\\": \\"test\\",\\n \\"RuleCountInfo\\": {\\n \\"ValidateRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n },\\n \\"StrongRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n },\\n \\"WeakRuleCount\\": {\\n \\"TotalRuleCount\\": 1,\\n \\"FinishedRuleCount\\": 1,\\n \\"ErrorRuleCount\\": 0,\\n \\"SuccessRuleCount\\": 1\\n }\\n },\\n \\"RuleIdList\\": [\\n 2\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"BizDateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n}","type":"json"}]', 'title' => '获取监控任务对象', ], 'GetQualityWatchByObjectId' => [ 'summary' => '通过监控对象原始ID获取监控对象记录，例如：数据源、表、指标等的ID。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'WatchType', 'in' => 'query', 'schema' => [ 'title' => '监控对象类型：TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型：TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], ], [ 'name' => 'WatchObjectId', 'in' => 'query', 'schema' => [ 'title' => '对象ID，例如表ID，数据源ID，指标ID等', 'description' => '对象ID，例如表ID，数据源ID，指标ID等', 'type' => 'string', 'required' => true, 'example' => 'cc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityWatchInfo' => [ 'title' => '监控对象详情', 'description' => '监控对象详情', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'TABLE', ], 'Id' => [ 'title' => '监控Id', 'description' => '监控Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Name' => [ 'title' => '监控名称', 'description' => '监控名称', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => '状态：ENABLE，DISABLE', 'description' => '状态：ENABLE，DISABLE', 'type' => 'string', 'example' => 'ENABLE', ], 'DataSourceInfo' => [ 'title' => '数据源详情', 'description' => '数据源详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => '1', ], 'Type' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP', 'description' => '数据源类型: MAX_COMPUTE、HADOOP', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Env' => [ 'title' => '环境标识：PROD、DEV', 'description' => '环境标识：PROD、DEV', 'type' => 'string', 'example' => 'DEV', ], ], ], 'TableInfo' => [ 'title' => '监控表对象', 'description' => '监控表对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE', ], 'Catalog' => [ 'title' => '表catalog', 'description' => '表catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '表Id', 'description' => '表Id', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '表名称', 'description' => '表名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Env' => [ 'title' => '环境标识：DEV、PROD', 'description' => '环境标识：DEV、PROD', 'type' => 'string', 'example' => 'DEV', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'DataSourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => '22', ], 'IsPartitionTable' => [ 'title' => '是否分区表', 'description' => '是否分区表', 'type' => 'boolean', ], ], ], 'IndexInfo' => [ 'title' => '指标详情', 'description' => '指标详情', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'Catalog' => [ 'title' => '指标catalog', 'description' => '指标catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '指标Id：', 'description' => '指标Id：', 'type' => 'string', 'example' => '11', ], 'Guid' => [ 'title' => '指标guid：', 'description' => '指标guid：', 'type' => 'string', 'example' => '1121', ], 'Name' => [ 'title' => '指标名：', 'description' => '指标名：', 'type' => 'string', 'example' => 'logic', ], 'DisplayName' => [ 'title' => '指标展示名：', 'description' => '指标展示名：', 'type' => 'string', 'example' => 'logic', ], 'GranularityId' => [ 'title' => '统计粒度id', 'description' => '统计粒度id', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764', ], 'GranularityDisplayName' => [ 'title' => '统计粒度名称', 'description' => '统计粒度名称', 'type' => 'string', 'example' => '全站汇总表', ], 'ComputeType' => [ 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'description' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'type' => 'string', 'example' => 'AUTO', ], 'CellSumLogicTableName' => [ 'title' => '单元汇总表名', 'description' => '单元汇总表名', 'type' => 'string', 'example' => 'dws_all', ], 'Type' => [ 'title' => '指标类型：INDEX', 'description' => '指标类型：INDEX', 'type' => 'string', 'example' => 'INDEX', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'DateType' => [ 'title' => '指标数据类型', 'description' => '指标数据类型', 'type' => 'string', 'example' => 'bigint', ], ], ], 'QualityOwner' => [ 'title' => '质量负责人用户ID', 'description' => '质量负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'QualityOwnerName' => [ 'title' => '质量负责人显示名称', 'description' => '质量负责人显示名称', 'type' => 'string', 'example' => 'test', ], 'LatestWatchTaskId' => [ 'title' => '最近一次监控对象校验记录ID', 'description' => '最近一次监控对象校验记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LatestWatchTaskStatus' => [ 'title' => '最近一次监控对象校验记录状态', 'description' => '最近一次监控对象校验记录状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'RuleCount' => [ 'title' => '规则数', 'description' => '规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'EnabledRuleCount' => [ 'title' => '生效规则数', 'description' => '生效规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityWatchInfo\\": {\\n \\"Type\\": \\"TABLE\\",\\n \\"Id\\": 11,\\n \\"Name\\": \\"test\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"DataSourceInfo\\": {\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"1\\",\\n \\"Type\\": \\"MAX_COMPUTE\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Env\\": \\"DEV\\"\\n },\\n \\"TableInfo\\": {\\n \\"Type\\": \\"LOGIC_DIM_TABLE\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"test\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Env\\": \\"DEV\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"DataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"DataSourceId\\": \\"22\\",\\n \\"IsPartitionTable\\": true\\n },\\n \\"IndexInfo\\": {\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"11\\",\\n \\"Guid\\": \\"1121\\",\\n \\"Name\\": \\"logic\\",\\n \\"DisplayName\\": \\"logic\\",\\n \\"GranularityId\\": 18755764,\\n \\"GranularityDisplayName\\": \\"全站汇总表\\",\\n \\"ComputeType\\": \\"AUTO\\",\\n \\"CellSumLogicTableName\\": \\"dws_all\\",\\n \\"Type\\": \\"INDEX\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"DateType\\": \\"bigint\\"\\n },\\n \\"QualityOwner\\": \\"30012011\\",\\n \\"QualityOwnerName\\": \\"test\\",\\n \\"LatestWatchTaskId\\": 1,\\n \\"LatestWatchTaskStatus\\": \\"SUCCESS\\",\\n \\"RuleCount\\": 11,\\n \\"EnabledRuleCount\\": 1,\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n}","type":"json"}]', 'title' => '通过监控对象原始ID获取监控对象记录', ], 'GetQualityWatch' => [ 'summary' => '获取质量监控对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '监控Id', 'description' => '监控Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityWatchInfo' => [ 'title' => '监控对象详情', 'description' => '监控对象详情', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'TABLE', ], 'Id' => [ 'title' => '监控Id', 'description' => '监控Id', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Name' => [ 'title' => '监控名称', 'description' => '监控名称', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => '状态：ENABLE，DISABLE', 'description' => '状态：ENABLE，DISABLE', 'type' => 'string', 'example' => 'ENABLE', ], 'DataSourceInfo' => [ 'title' => '数据源详情', 'description' => '数据源详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据源Id', 'description' => '数据源Id', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => '1', ], 'Type' => [ 'title' => '数据源类型: MAX_COMPUTE、HADOOP', 'description' => '数据源类型: MAX_COMPUTE、HADOOP', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Env' => [ 'title' => '环境标识：PROD、DEV', 'description' => '环境标识：PROD、DEV', 'type' => 'string', 'example' => 'DEV', ], ], ], 'TableInfo' => [ 'title' => '监控表对象', 'description' => '监控表对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'description' => '类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE', ], 'Catalog' => [ 'title' => '表catalog', 'description' => '表catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '表Id', 'description' => '表Id', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '表名称', 'description' => '表名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Env' => [ 'title' => '环境标识：DEV、PROD', 'description' => '环境标识：DEV、PROD', 'type' => 'string', 'example' => 'DEV', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'DataSourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => '22', ], 'IsPartitionTable' => [ 'title' => '是否分区表', 'description' => '是否分区表', 'type' => 'boolean', ], ], ], 'IndexInfo' => [ 'title' => '指标详情', 'description' => '指标详情', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'Catalog' => [ 'title' => '指标catalog', 'description' => '指标catalog', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '指标Id：', 'description' => '指标Id：', 'type' => 'string', 'example' => '11', ], 'Guid' => [ 'title' => '指标guid：', 'description' => '指标guid：', 'type' => 'string', 'example' => '1121', ], 'Name' => [ 'title' => '指标名：', 'description' => '指标名：', 'type' => 'string', 'example' => 'logic', ], 'DisplayName' => [ 'title' => '指标展示名：', 'description' => '指标展示名：', 'type' => 'string', 'example' => 'logic', ], 'GranularityId' => [ 'title' => '统计粒度id', 'description' => '统计粒度id', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764', ], 'GranularityDisplayName' => [ 'title' => '统计粒度名称', 'description' => '统计粒度名称', 'type' => 'string', 'example' => '全站汇总表', ], 'ComputeType' => [ 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'description' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', 'type' => 'string', 'example' => 'AUTO', ], 'CellSumLogicTableName' => [ 'title' => '单元汇总表名', 'description' => '单元汇总表名', 'type' => 'string', 'example' => 'dws_all', ], 'Type' => [ 'title' => '指标类型：INDEX', 'description' => '指标类型：INDEX', 'type' => 'string', 'example' => 'INDEX', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1121', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人用户名称', 'description' => '负责人用户名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'DateType' => [ 'title' => '指标数据类型', 'description' => '指标数据类型', 'type' => 'string', 'example' => 'bigint', ], ], ], 'QualityOwner' => [ 'title' => '质量负责人用户ID', 'description' => '质量负责人用户ID', 'type' => 'string', 'example' => '30012011', ], 'QualityOwnerName' => [ 'title' => '质量负责人显示名称', 'description' => '质量负责人显示名称', 'type' => 'string', 'example' => 'test', ], 'LatestWatchTaskId' => [ 'title' => '最近一次监控对象校验记录ID', 'description' => '最近一次监控对象校验记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LatestWatchTaskStatus' => [ 'title' => '最近一次监控对象校验记录状态', 'description' => '最近一次监控对象校验记录状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'RuleCount' => [ 'title' => '规则数', 'description' => '规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'EnabledRuleCount' => [ 'title' => '生效规则数', 'description' => '生效规则数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityWatchInfo\\": {\\n \\"Type\\": \\"TABLE\\",\\n \\"Id\\": 11,\\n \\"Name\\": \\"test\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"DataSourceInfo\\": {\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"1\\",\\n \\"Type\\": \\"MAX_COMPUTE\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Env\\": \\"DEV\\"\\n },\\n \\"TableInfo\\": {\\n \\"Type\\": \\"LOGIC_DIM_TABLE\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"test\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Env\\": \\"DEV\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"DataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"DataSourceId\\": \\"22\\",\\n \\"IsPartitionTable\\": true\\n },\\n \\"IndexInfo\\": {\\n \\"ProjectId\\": 1121,\\n \\"ProjectName\\": \\"test\\",\\n \\"Catalog\\": \\"test\\",\\n \\"Id\\": \\"11\\",\\n \\"Guid\\": \\"1121\\",\\n \\"Name\\": \\"logic\\",\\n \\"DisplayName\\": \\"logic\\",\\n \\"GranularityId\\": 18755764,\\n \\"GranularityDisplayName\\": \\"全站汇总表\\",\\n \\"ComputeType\\": \\"AUTO\\",\\n \\"CellSumLogicTableName\\": \\"dws_all\\",\\n \\"Type\\": \\"INDEX\\",\\n \\"BizUnitId\\": 1121,\\n \\"BizUnitName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"DateType\\": \\"bigint\\"\\n },\\n \\"QualityOwner\\": \\"30012011\\",\\n \\"QualityOwnerName\\": \\"test\\",\\n \\"LatestWatchTaskId\\": 1,\\n \\"LatestWatchTaskStatus\\": \\"SUCCESS\\",\\n \\"RuleCount\\": 11,\\n \\"EnabledRuleCount\\": 1,\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n}","type":"json"}]', 'title' => '获取质量监控对象', ], 'GetQualityTemplate' => [ 'summary' => '获取质量模板对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityTemplateInfo' => [ 'title' => '模板对象详情', 'description' => '模板对象详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '模板Id', 'description' => '模板Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'description' => '模板类型: FIELD_NULL_VALUE_VALIDATE 字段空值校验,FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验,FIELD_UNIQUE_VALIDATE 字段唯一性校验,FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验,FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验,FUNCTION_TIME_COMPARE 时间函数比较,SINGLE_TABLE_TIME_COMPARE 单表时间字段比较,DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较,FIELD_FORMAT_VALIDATE 字段格式校验,FIELD_LENGTH_VALIDATE 字段长度校验,FIELD_VALUE_RANGE_VALIDATE 字段值域校验,CODE_TABLE_COMPARE 码表参照对比,STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比,SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较,SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较,SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较,DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较,DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较,CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较,DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较,TABLE_STABILITY_VALIDATE 表稳定性校验,TABLE_FLUCTUATION_VALIDATE 表波动性校验,FIELD_STABILITY_VALIDATE 字段稳定性校验,FIELD_FLUCTUATION_VALIDATE 字段波动性校验,CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验,CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验,DATASOURCE_AVAILABLE_CHECK 数据源连通性监测,TABLE_SCHEMA_CHECK 表结构异动监测,REAL_TIME_OFFLINE_COMPARE 实时离线对比,REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测,REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'TypeName' => [ 'title' => '模板类型展示名', 'description' => '模板类型展示名', 'type' => 'string', 'example' => '字段空值校验', ], 'Description' => [ 'title' => '模板描述', 'description' => '模板描述', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '归属人用户ID', 'description' => '归属人用户ID', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '归属人名称', 'description' => '归属人名称', 'type' => 'string', 'example' => 'test', ], 'Catalog' => [ 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'example' => 'CONSISTENT', ], 'CatalogName' => [ 'title' => '模板分类展示名', 'description' => '模板分类展示名', 'type' => 'string', 'example' => '一致性', ], 'SupportAllDataSourceType' => [ 'title' => '支持所有数据源类型', 'description' => '支持所有数据源类型', 'type' => 'boolean', ], 'SupportDataSourceTypeList' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'array', 'items' => [ 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'description' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', 'type' => 'string', 'example' => 'MySQL', ], ], 'IsSystemTemplate' => [ 'title' => '是否系统模板', 'description' => '是否系统模板', 'type' => 'boolean', ], 'FormPropertyList' => [ 'title' => '规则配置键值对', 'description' => '规则配置键值对', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'abc', ], ], ], ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建人名称', 'description' => '创建人名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改人ID', 'description' => '最近修改人ID', 'type' => 'string', 'example' => '30012011', ], 'ModifierName' => [ 'title' => '最近修改人名称', 'description' => '最近修改人名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityTemplateInfo\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"FIELD_NULL_VALUE_VALIDATE\\",\\n \\"TypeName\\": \\"字段空值校验\\",\\n \\"Description\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"test\\",\\n \\"Catalog\\": \\"CONSISTENT\\",\\n \\"CatalogName\\": \\"一致性\\",\\n \\"SupportAllDataSourceType\\": true,\\n \\"SupportDataSourceTypeList\\": [\\n \\"MySQL\\"\\n ],\\n \\"IsSystemTemplate\\": true,\\n \\"FormPropertyList\\": [\\n {\\n \\"ComponentType\\": \\"expression\\",\\n \\"Name\\": \\"col\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifierName\\": \\"test\\"\\n }\\n}","type":"json"}]', 'title' => '获取质量模板对象', ], 'GetQualitySchedulesByWatchId' => [ 'summary' => '通过监控对象ID获取调度设置列表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'WatchId', 'in' => 'query', 'schema' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityScheduleList' => [ 'title' => '调度对象列表', 'description' => '调度对象列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象Id', 'description' => '监控对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Id' => [ 'title' => '调度对象Id', 'description' => '调度对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '调度对象名称', 'description' => '调度对象名称', 'type' => 'string', 'example' => 'test', ], 'IsRefByRule' => [ 'title' => '是否被规则引用', 'description' => '是否被规则引用', 'type' => 'boolean', ], 'Type' => [ 'title' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'description' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'type' => 'string', 'example' => 'PERIOD_SCHEDULE', ], 'PartitionType' => [ 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'description' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'type' => 'string', 'example' => 'CUSTOM', ], 'PartitionExpression' => [ 'title' => '分区表达式-自定义表达式', 'description' => '分区表达式-自定义表达式', 'type' => 'string', 'example' => 'ds=${yyyyMMdd}', ], 'TriggerType' => [ 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'description' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'type' => 'string', 'example' => 'STATIC_TASK_TRIGGER', ], 'TriggerNodeList' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'array', 'items' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'string', 'example' => 'n_1121', ], ], 'StaticTaskTriggerType' => [ 'title' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'description' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'type' => 'string', 'example' => 'ONE_TASKS_FINISHED', ], 'PeriodScheduleIntervalType' => [ 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'description' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'type' => 'string', 'example' => 'DAILY', ], 'PeriodScheduleParamList' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'array', 'items' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'string', 'example' => 'DAILY', ], ], 'CronExpression' => [ 'title' => '定时调度-cron表达式', 'description' => '定时调度-cron表达式', 'type' => 'string', 'example' => '* * 1/* * * *', ], 'ValidatePartitionType' => [ 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'description' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'type' => 'string', 'example' => 'TASK_REFERRED_PARTITION', ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012011', ], 'Modifier' => [ 'title' => '最近修改人ID', 'description' => '最近修改人ID', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityScheduleList\\": [\\n {\\n \\"WatchId\\": 22,\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"IsRefByRule\\": true,\\n \\"Type\\": \\"PERIOD_SCHEDULE\\",\\n \\"PartitionType\\": \\"CUSTOM\\",\\n \\"PartitionExpression\\": \\"ds=${yyyyMMdd}\\",\\n \\"TriggerType\\": \\"STATIC_TASK_TRIGGER\\",\\n \\"TriggerNodeList\\": [\\n \\"n_1121\\"\\n ],\\n \\"StaticTaskTriggerType\\": \\"ONE_TASKS_FINISHED\\",\\n \\"PeriodScheduleIntervalType\\": \\"DAILY\\",\\n \\"PeriodScheduleParamList\\": [\\n \\"DAILY\\"\\n ],\\n \\"CronExpression\\": \\"* * 1/* * * *\\",\\n \\"ValidatePartitionType\\": \\"TASK_REFERRED_PARTITION\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '通过监控对象ID获取调度设置列表', ], 'GetQualitySchedule' => [ 'summary' => '获取质量调度对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '调度对象Id', 'description' => '调度对象Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityScheduleInfo' => [ 'title' => '调度对象详情', 'description' => '调度对象详情', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象Id', 'description' => '监控对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Id' => [ 'title' => '调度对象Id', 'description' => '调度对象Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '调度对象名称', 'description' => '调度对象名称', 'type' => 'string', 'example' => 'test', ], 'IsRefByRule' => [ 'title' => '是否被规则引用', 'description' => '是否被规则引用', 'type' => 'boolean', ], 'Type' => [ 'title' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'description' => '调度类型: PERIOD_SCHEDULE 定时调度、MANUAL_SCHEDULE 手动触发、CODE_CHECK_TRIGGER 代码检查触发、STATIC_TASK_TRIGGER 固定任务触发、DEPENDENCY_SCHEDULE 依赖调度', 'type' => 'string', 'example' => 'PERIOD_SCHEDULE', ], 'PartitionType' => [ 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'description' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', 'type' => 'string', 'example' => 'CUSTOM', ], 'PartitionExpression' => [ 'title' => '分区表达式-自定义表达式', 'description' => '分区表达式-自定义表达式', 'type' => 'string', 'example' => 'ds=${yyyyMMdd}', ], 'TriggerType' => [ 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'description' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', 'type' => 'string', 'example' => 'STATIC_TASK_TRIGGER', ], 'TriggerNodeList' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'array', 'items' => [ 'title' => '触发调度-触发任务清单', 'description' => '触发调度-触发任务清单', 'type' => 'string', 'example' => 'n_1121', ], ], 'StaticTaskTriggerType' => [ 'title' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'description' => '固定任务触发-触发方式: ALL_TASKS_FINISHED、ONE_TASKS_FINISHED、PRE_ONE_TASKS_START', 'type' => 'string', 'example' => 'ONE_TASKS_FINISHED', ], 'PeriodScheduleIntervalType' => [ 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'description' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', 'type' => 'string', 'example' => 'DAILY', ], 'PeriodScheduleParamList' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'array', 'items' => [ 'title' => '定时调度-调度周期值', 'description' => '定时调度-调度周期值', 'type' => 'string', 'example' => 'DAILY', ], ], 'CronExpression' => [ 'title' => '定时调度-cron表达式', 'description' => '定时调度-cron表达式', 'type' => 'string', 'example' => '* * 1/* * * *', ], 'ValidatePartitionType' => [ 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'description' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', 'type' => 'string', 'example' => 'TASK_REFERRED_PARTITION', ], 'Creator' => [ 'title' => '创建人用户ID', 'description' => '创建人用户ID', 'type' => 'string', 'example' => '30012011', ], 'Modifier' => [ 'title' => '最近修改人ID', 'description' => '最近修改人ID', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityScheduleInfo\\": {\\n \\"WatchId\\": 22,\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"IsRefByRule\\": true,\\n \\"Type\\": \\"PERIOD_SCHEDULE\\",\\n \\"PartitionType\\": \\"CUSTOM\\",\\n \\"PartitionExpression\\": \\"ds=${yyyyMMdd}\\",\\n \\"TriggerType\\": \\"STATIC_TASK_TRIGGER\\",\\n \\"TriggerNodeList\\": [\\n \\"n_1121\\"\\n ],\\n \\"StaticTaskTriggerType\\": \\"ONE_TASKS_FINISHED\\",\\n \\"PeriodScheduleIntervalType\\": \\"DAILY\\",\\n \\"PeriodScheduleParamList\\": [\\n \\"DAILY\\"\\n ],\\n \\"CronExpression\\": \\"* * 1/* * * *\\",\\n \\"ValidatePartitionType\\": \\"TASK_REFERRED_PARTITION\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\"\\n }\\n}","type":"json"}]', 'title' => '获取质量调度对象', ], 'GetQualityRuleTaskLog' => [ 'summary' => '获取质量任务对象日志内容。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RuleTaskId', 'in' => 'query', 'schema' => [ 'title' => '规则任务ID', 'description' => '规则任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '日志内容', 'description' => '日志内容', 'type' => 'string', 'example' => 'test', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"test\\"\\n}","type":"json"}]', 'title' => '获取质量任务对象日志内容', ], 'GetQualityRuleTask' => [ 'summary' => '获取质量任务对象详情。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'RuleTaskId', 'in' => 'query', 'schema' => [ 'title' => '规则任务ID', 'description' => '规则任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'RuleTaskInfo' => [ 'title' => '规则任务详情', 'description' => '规则任务详情', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '所属监控ID', 'description' => '所属监控ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'WatchTaskId' => [ 'title' => '监控任务ID，试跑的规则任务这个ID为空', 'description' => '监控任务ID，试跑的规则任务这个ID为空', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Id' => [ 'title' => '规则任务ID', 'description' => '规则任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'TemplateId' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'Status' => [ 'title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'running', ], 'StartTime' => [ 'title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'EndTime' => [ 'title' => '截止时间', 'description' => '截止时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ValidatePartition' => [ 'title' => '校验分区', 'description' => '校验分区', 'type' => 'string', 'example' => '20251011', ], 'ValidateObjectType' => [ 'title' => '校验对象类型', 'description' => '校验对象类型', 'type' => 'string', 'example' => 'column', ], 'ValidateObjectName' => [ 'title' => '校验对象名称', 'description' => '校验对象名称', 'type' => 'string', 'example' => 'test', ], 'ValidateSuccess' => [ 'title' => '是否校验通过', 'description' => '是否校验通过', 'type' => 'boolean', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'BizDateFormat' => [ 'title' => '业务日期格式', 'description' => '业务日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"RuleTaskInfo\\": {\\n \\"WatchId\\": 1,\\n \\"WatchTaskId\\": 1,\\n \\"Id\\": 1,\\n \\"RuleId\\": 11,\\n \\"TemplateId\\": 11,\\n \\"Status\\": \\"running\\",\\n \\"StartTime\\": \\"2025-06-30 00:00:00\\",\\n \\"EndTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ValidatePartition\\": \\"20251011\\",\\n \\"ValidateObjectType\\": \\"column\\",\\n \\"ValidateObjectName\\": \\"test\\",\\n \\"ValidateSuccess\\": true,\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"BizDateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Modifier\\": \\"30012011\\"\\n }\\n}","type":"json"}]', 'title' => '获取质量任务对象详情', ], 'GetQualityRule' => [ 'summary' => '获取质量规则对象。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityRuleInfo' => [ 'title' => '质量规则详情', 'description' => '质量规则详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '质量规则Id', 'description' => '质量规则Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '质量规则名称', 'description' => '质量规则名称', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => '质量规则状态: ENABLE，DISABLE', 'description' => '质量规则状态: ENABLE，DISABLE', 'type' => 'string', 'example' => 'ENABLE', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Strength' => [ 'title' => '规则强弱: STRONG、WEAK', 'description' => '规则强弱: STRONG、WEAK', 'type' => 'string', 'example' => 'STRONG', ], 'CatalogList' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'array', 'items' => [ 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'description' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', 'type' => 'string', 'example' => 'CONSISTENT', ], ], 'TemplateType' => [ 'title' => '模板类型', 'description' => '模板类型：'."\n" .' - FIELD_NULL_VALUE_VALIDATE 字段空值校验'."\n" .' - FIELD_EMPTY_STRING_VALIDATE 字段空字符串校验'."\n" .' - FIELD_UNIQUE_VALIDATE 字段唯一性校验'."\n" .' - FIELD_GROUP_COUNT_VALIDATE 字段唯一值个数校验'."\n" .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE 字段重复值个数校验'."\n" .' - FUNCTION_TIME_COMPARE 时间函数比较'."\n" .' - SINGLE_TABLE_TIME_COMPARE 单表时间字段比较'."\n" .' - DOUBLE_TABLE_TIME_COMPARE 两表时间字段比较'."\n" .' - FIELD_FORMAT_VALIDATE 字段格式校验'."\n" .' - FIELD_LENGTH_VALIDATE 字段长度校验'."\n" .' - FIELD_VALUE_RANGE_VALIDATE 字段值域校验'."\n" .' - CODE_TABLE_COMPARE 码表参照对比'."\n" .' - STANDARD_CODE_TABLE_COMPARE 数据标准码表参照对比'."\n" .' - SINGLE_TABLE_FIELD_VALUE_COMPARE 单表字段值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE 单表字段统计值一致性比较'."\n" .' - SINGLE_TABLE_FIELD_EXP_COMPARE 单表字段业务逻辑一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE 两表字段值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 两表字段统计值一致性比较'."\n" .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE 跨源两表字段统计值一致性比较'."\n" .' - DOUBLE_TABLE_FIELD_EXP_COMPARE 两表字段业务逻辑一致性比较'."\n" .' - TABLE_STABILITY_VALIDATE 表稳定性校验'."\n" .' - TABLE_FLUCTUATION_VALIDATE 表波动性校验'."\n" .' - FIELD_STABILITY_VALIDATE 字段稳定性校验'."\n" .' - FIELD_FLUCTUATION_VALIDATE 字段波动性校验'."\n" .' - CUSTOM_STATISTICAL_VALIDATE 自定义统计指标校验'."\n" .' - CUSTOM_DATA_DETAILS_VALIDATE 自定义数据详情校验'."\n" .' - DATASOURCE_AVAILABLE_CHECK 数据源连通性监测'."\n" .' - TABLE_SCHEMA_CHECK 表结构异动监测'."\n" .' - REAL_TIME_OFFLINE_COMPARE 实时离线对比'."\n" .' - REAL_TIME_STATISTICAL_VALIDATE 实时统计值监测'."\n" .' - REAL_TIME_MULTI_CHAIN_COMPARE 实时多链路对比 等', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE', ], 'TemplateId' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TemplateName' => [ 'title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => '1', ], 'TemplateScope' => [ 'title' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', 'description' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', 'type' => 'string', 'example' => 'CUSTOM', ], 'WatchId' => [ 'title' => '所属监控ID', 'description' => '所属监控ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'EnableErrorArchive' => [ 'title' => '是否启动异常归档', 'description' => '是否启动异常归档', 'type' => 'boolean', ], 'ValidateConditionList' => [ 'title' => '校验条件列表', 'description' => '校验条件列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '条件节点id', 'description' => '条件节点id', 'type' => 'string', 'example' => '268', ], 'Type' => [ 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'description' => '条件类型: RELATION 关系，EXPRESSION：表达式', 'type' => 'string', 'example' => 'RELATION', ], 'Operator' => [ 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'description' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', 'type' => 'string', 'example' => 'AND', ], 'OperatorName' => [ 'title' => '操作符名称', 'description' => '操作符名称', 'type' => 'string', 'example' => '且', ], 'Metric' => [ 'title' => '指标', 'description' => '指标', 'type' => 'string', 'example' => 'test', ], 'MetricName' => [ 'title' => '指标名称', 'description' => '指标名称', 'type' => 'string', 'example' => 'test', ], 'Value' => [ 'title' => '值', 'description' => '值', 'type' => 'string', 'example' => '1', ], 'ParentId' => [ 'title' => '条件父节点Id', 'description' => '条件父节点Id', 'type' => 'string', 'example' => '123', ], ], ], ], 'TestRunRuleTaskId' => [ 'title' => '最近一次试跑任务ID', 'description' => '最近一次试跑任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'TestRunRuleTaskStatus' => [ 'title' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', 'description' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', 'type' => 'string', 'example' => 'SUCCESS', ], 'TestRunRuleValidateResult' => [ 'title' => '试跑校验是否通过', 'description' => '试跑校验是否通过', 'type' => 'boolean', ], 'ScheduleBindList' => [ 'title' => '规则绑定的调度列表', 'description' => '规则绑定的调度列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ScheduleId' => [ 'title' => '调度Id', 'description' => '调度Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ScheduleName' => [ 'title' => '调度名称', 'description' => '调度名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'FormPropertyList' => [ 'title' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'description' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '控件类型', 'description' => '控件类型', 'type' => 'string', 'example' => 'expression', ], 'Name' => [ 'title' => '属性名', 'description' => '属性名', 'type' => 'string', 'example' => 'col', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => 'abc', ], ], ], ], 'ValidateObject' => [ 'title' => '校验对象', 'description' => '校验对象', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '校验对象类型: UNKNOWN，TABLE，COLUMN，DATASOURCE，DATASOURCE_TABLE，REALTIME，INDEX，CHAIN', 'description' => '校验对象类型: UNKNOWN，TABLE，COLUMN，DATASOURCE，DATASOURCE_TABLE，REALTIME，INDEX，CHAIN', 'type' => 'string', 'example' => 'TABLE', ], 'Name' => [ 'title' => '校验对象名称', 'description' => '校验对象名称', 'type' => 'string', 'example' => 'test', ], ], ], 'AttributeWithValueList' => [ 'title' => '规则业务属性配置', 'description' => '规则业务属性配置', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AttributeInfo' => [ 'title' => '属性详情', 'description' => '属性详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '属性Id', 'description' => '属性Id', 'type' => 'integer', 'format' => 'int64', 'example' => '612415804007', ], 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'attr01', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Enabled' => [ 'title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', ], 'Required' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', ], 'Searchable' => [ 'title' => '是否可搜索', 'description' => '是否可搜索', 'type' => 'boolean', ], 'ValueConfig' => [ 'title' => '属性值配置详情', 'description' => '属性值配置详情', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'description' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', 'type' => 'string', 'example' => 'CUSTOMIZED', ], 'DataType' => [ 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'description' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', 'type' => 'string', 'example' => 'STRING', ], 'Length' => [ 'title' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'description' => '属性字段长度, 可对文本型的属性值最大长度进行约束', 'type' => 'integer', 'format' => 'int32', 'example' => '6921666', ], 'ValueEnumList' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'description' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', 'type' => 'string', 'example' => 'test', ], ], 'DefaultValue' => [ 'title' => '属性默认值', 'description' => '属性默认值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'example' => 'abc', ], ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], ], ], ], ], 'AttributeValue' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'object', 'properties' => [ 'ValueList' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'array', 'items' => [ 'title' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'description' => '属性值清单,适用于填写方式为自定义输入、下拉单选框、下拉多选框的属性', 'type' => 'string', 'example' => 'abc', ], ], 'MinValue' => [ 'title' => '最小值,适用于范围区间属性', 'description' => '最小值,适用于范围区间属性', 'type' => 'string', 'example' => '1', ], 'IncludeMinValue' => [ 'title' => '是否包含最小值', 'description' => '是否包含最小值', 'type' => 'boolean', ], 'MaxValue' => [ 'title' => '最大值,适用于范围区间属性', 'description' => '最大值,适用于范围区间属性', 'type' => 'string', 'example' => '100', ], 'IncludeMaxValue' => [ 'title' => '是否包含最大值', 'description' => '是否包含最大值', 'type' => 'boolean', ], ], ], ], ], ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'CreatorName' => [ 'title' => '创建者名称', 'description' => '创建者名称', 'type' => 'string', 'example' => 'test', ], 'Modifier' => [ 'title' => '最近修改用户ID', 'description' => '最近修改用户ID', 'type' => 'string', 'example' => '30012011', ], 'ModifierName' => [ 'title' => '最近修改用户名称', 'description' => '最近修改用户名称', 'type' => 'string', 'example' => 'test', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityRuleInfo\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"Description\\": \\"test\\",\\n \\"Strength\\": \\"STRONG\\",\\n \\"CatalogList\\": [\\n \\"CONSISTENT\\"\\n ],\\n \\"TemplateType\\": \\"FIELD_NULL_VALUE_VALIDATE\\",\\n \\"TemplateId\\": 1,\\n \\"TemplateName\\": \\"1\\",\\n \\"TemplateScope\\": \\"CUSTOM\\",\\n \\"WatchId\\": 1,\\n \\"EnableErrorArchive\\": true,\\n \\"ValidateConditionList\\": [\\n {\\n \\"Id\\": \\"268\\",\\n \\"Type\\": \\"RELATION\\",\\n \\"Operator\\": \\"AND\\",\\n \\"OperatorName\\": \\"且\\",\\n \\"Metric\\": \\"test\\",\\n \\"MetricName\\": \\"test\\",\\n \\"Value\\": \\"1\\",\\n \\"ParentId\\": \\"123\\"\\n }\\n ],\\n \\"TestRunRuleTaskId\\": 22,\\n \\"TestRunRuleTaskStatus\\": \\"SUCCESS\\",\\n \\"TestRunRuleValidateResult\\": true,\\n \\"ScheduleBindList\\": [\\n {\\n \\"ScheduleId\\": 1,\\n \\"ScheduleName\\": \\"test\\"\\n }\\n ],\\n \\"FormPropertyList\\": [\\n {\\n \\"ComponentType\\": \\"expression\\",\\n \\"Name\\": \\"col\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"ValidateObject\\": {\\n \\"Type\\": \\"TABLE\\",\\n \\"Name\\": \\"test\\"\\n },\\n \\"AttributeWithValueList\\": [\\n {\\n \\"AttributeInfo\\": {\\n \\"Id\\": 612415804007,\\n \\"Name\\": \\"attr01\\",\\n \\"Description\\": \\"test\\",\\n \\"Enabled\\": true,\\n \\"Required\\": true,\\n \\"Searchable\\": true,\\n \\"ValueConfig\\": {\\n \\"Type\\": \\"CUSTOMIZED\\",\\n \\"DataType\\": \\"STRING\\",\\n \\"Length\\": 6921666,\\n \\"ValueEnumList\\": [\\n \\"test\\"\\n ],\\n \\"DefaultValue\\": {\\n \\"ValueList\\": [\\n \\"abc\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n }\\n }\\n },\\n \\"AttributeValue\\": {\\n \\"ValueList\\": [\\n \\"abc\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": true,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": true\\n }\\n }\\n ],\\n \\"Creator\\": \\"30012011\\",\\n \\"CreatorName\\": \\"test\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifierName\\": \\"test\\",\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\"\\n }\\n}","type":"json"}]', 'title' => '获取质量规则对象', ], 'GetQualityAlertOfAllRuleScopeByWatchId' => [ 'summary' => '通过监控对象ID获取告警设置。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'WatchId', 'in' => 'query', 'schema' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'QualityAlertInfo' => [ 'title' => '告警设置详情', 'description' => '告警设置详情', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'AlertUserChannelList' => [ 'title' => '用户告警渠道', 'description' => '用户告警渠道', 'type' => 'array', 'items' => [ 'title' => '用户告警渠道', 'description' => '用户告警渠道', 'type' => 'string', 'example' => 'test', ], ], 'AlertUserList' => [ 'title' => '用户告警列表', 'description' => '用户告警列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '30012011', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'test', ], ], ], ], 'AlertDutyList' => [ 'title' => '值班表告警列表', 'description' => '值班表告警列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '报警值班表ID', 'description' => '报警值班表ID', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'title' => '报警值班表名称', 'description' => '报警值班表名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'AlertDutyChannelList' => [ 'title' => '值班表告警渠道', 'description' => '值班表告警渠道', 'type' => 'array', 'items' => [ 'title' => '值班表告警渠道', 'description' => '值班表告警渠道', 'type' => 'string', 'example' => 'test', ], ], 'EnableAlertQualityOwner' => [ 'title' => '开启质量负责人告警', 'description' => '开启质量负责人告警', 'type' => 'boolean', ], 'AlertQualityOwnerChannelList' => [ 'title' => '质量负责人告警渠道', 'description' => '质量负责人告警渠道', 'type' => 'array', 'items' => [ 'title' => '质量负责人告警渠道', 'description' => '质量负责人告警渠道', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityAlertInfo\\": {\\n \\"WatchId\\": 1,\\n \\"AlertUserChannelList\\": [\\n \\"test\\"\\n ],\\n \\"AlertUserList\\": [\\n {\\n \\"Id\\": \\"30012011\\",\\n \\"Name\\": \\"test\\"\\n }\\n ],\\n \\"AlertDutyList\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"test\\"\\n }\\n ],\\n \\"AlertDutyChannelList\\": [\\n \\"test\\"\\n ],\\n \\"EnableAlertQualityOwner\\": true,\\n \\"AlertQualityOwnerChannelList\\": [\\n \\"test\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '通过监控对象ID获取告警设置', ], 'DeleteQualityWatches' => [ 'summary' => '批量删除质量监控对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'WatchIdList' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'array', 'items' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除监控对象个数', 'description' => '删除监控对象个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量删除质量监控对象', ], 'DeleteQualityTemplates' => [ 'summary' => '批量删除质量模板对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'TemplateIdList' => [ 'title' => '模板对象ID', 'description' => '模板对象ID', 'type' => 'array', 'items' => [ 'title' => '模板对象ID', 'description' => '模板对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除模板个数', 'description' => '删除模板个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量删除质量模板对象', ], 'DeleteQualitySchedules' => [ 'summary' => '批量删除质量调度对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'ScheduleIdList' => [ 'title' => '调度对象ID', 'description' => '调度对象ID', 'type' => 'array', 'items' => [ 'title' => '调度对象ID', 'description' => '调度对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除调度个数', 'description' => '删除调度个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量删除质量调度对象', ], 'DeleteQualityRules' => [ 'summary' => '批量删除质量规则对象。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'RuleIdList' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'array', 'items' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除规则个数', 'description' => '删除规则个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '批量删除质量规则对象', ], 'AssignQualityRuleOfAllRuleScopeSchedules' => [ 'summary' => '指定质量规则和调度设置进行绑定。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AssignCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分派绑定指令', 'description' => '分派绑定指令', 'type' => 'object', 'properties' => [ 'WatchId' => [ 'title' => '监控对象ID', 'description' => '监控对象ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '平均值', ], 'RuleIdList' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'array', 'items' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', ], 'required' => true, ], 'ScheduleIdList' => [ 'title' => '调度ID', 'description' => '调度ID', 'type' => 'array', 'items' => [ 'title' => '调度ID', 'description' => '调度ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '指定质量规则和调度设置进行绑定', ], 'UpdateSecurityLevel' => [ 'summary' => '更新数据分级。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Index' => [ 'title' => '分级顺序, 不传递时将按照分级名称匹配', 'description' => '分级顺序, 不传递时将按照分级名称匹配', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Description' => [ 'title' => '分级描述', 'description' => '分级描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '更新数据分级', ], 'UpdateSecurityIdentifyResultStatus' => [ 'summary' => '更新安全识别结果的生效状态。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Enable' => [ 'title' => '是否生效', 'description' => '是否生效', 'type' => 'boolean', 'required' => true, ], 'IdentifyResultIdList' => [ 'title' => '识别结果ID列表', 'description' => '识别结果ID列表', 'type' => 'array', 'items' => [ 'title' => '识别结果ID列表', 'description' => '识别结果ID列表', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '更新结果', 'description' => '更新结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '更新安全识别结果的生效状态', ], 'UpdateSecurityClassifyCatalog' => [ 'summary' => '更新数据分类目录。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Path' => [ 'title' => '目录的原始完整路径', 'description' => '目录的原始完整路径', 'type' => 'string', 'required' => true, 'example' => '/d1/d2/', ], 'Name' => [ 'title' => '分类目录名称', 'description' => '分类目录名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'ParentPath' => [ 'title' => '分类父目录完整路径,默认/', 'description' => '分类父目录完整路径,默认/', 'type' => 'string', 'required' => false, 'example' => '/d1/', ], 'OwnerList' => [ 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'description' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'type' => 'array', 'items' => [ 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'description' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'VisibleType' => [ 'title' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', 'description' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '更新后的目录的完整路径', 'description' => '更新后的目录的完整路径', 'type' => 'string', 'example' => '/d1/d3/', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"/d1/d3/\\"\\n}","type":"json"}]', 'title' => '更新数据分类目录', ], 'UpdateSecurityClassify' => [ 'summary' => '更新数据分类。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '分类ID，不传递时按照分类名称+分类父路径匹配分类进行更新', 'description' => '分类ID，不传递时按照分类名称+分类父路径匹配分类进行更新', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ParentPath' => [ 'title' => '分类父路径', 'description' => '分类父路径', 'type' => 'string', 'required' => false, 'example' => '/a/b/', ], 'Abbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Description' => [ 'title' => '分类描述', 'description' => '分类描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'LevelName' => [ 'title' => '数据分级名称', 'description' => '数据分级名称', 'type' => 'string', 'required' => true, 'example' => 'L2', ], 'FeatureNameList' => [ 'title' => '特征名称', 'description' => '特征名称', 'type' => 'array', 'items' => [ 'title' => '特征名称', 'description' => '特征名称', 'type' => 'string', 'required' => false, 'example' => '行业', ], 'required' => false, ], 'Priority' => [ 'title' => '优先级,默认: 5', 'description' => '优先级,默认: 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'AdvancedConditionList' => [ 'title' => '高级配置', 'description' => '高级配置', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ParentId' => [ 'title' => '特征条件父节点', 'description' => '特征条件父节点', 'type' => 'string', 'required' => false, 'example' => '123', ], 'Id' => [ 'title' => '特征条件节点id，由业务随机生成且确保唯一', 'description' => '特征条件节点id，由业务随机生成且确保唯一', 'type' => 'string', 'required' => true, 'example' => '234', ], 'Relation' => [ 'title' => '条件关系: EXPRESSION 表达式、RELATION 关系', 'description' => '条件关系: EXPRESSION 表达式、RELATION 关系', 'type' => 'string', 'required' => true, 'example' => 'EXPRESSION', ], 'Property' => [ 'title' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', 'description' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', 'type' => 'string', 'required' => false, 'example' => 'TABLE_NAME', ], 'Operate' => [ 'title' => '条件操作: AND、OR、BUILT_IN_EXPRESSION 内置表达式、IGNORE_CASE_EXPRESSION 正则 - 大小写兼容、EXPRESSION 正则表达式、NOT_BELONG 不属于、CONTAINS 包含、NOT_CONTAINS 不包含、EQUAL、NOT_EQUAL', 'description' => '条件操作: AND、OR、BUILT_IN_EXPRESSION 内置表达式、IGNORE_CASE_EXPRESSION 正则 - 大小写兼容、EXPRESSION 正则表达式、NOT_BELONG 不属于、CONTAINS 包含、NOT_CONTAINS 不包含、EQUAL、NOT_EQUAL', 'type' => 'string', 'required' => true, 'example' => 'AND', ], 'ValueList' => [ 'title' => '条件取值', 'description' => '条件取值', 'type' => 'array', 'items' => [ 'title' => '条件取值', 'description' => '条件取值', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'required' => false, ], 'OptionList' => [ 'title' => '额外属性,如字段内容', 'description' => '额外属性,如字段内容', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'Status' => [ 'title' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'required' => false, 'example' => 'ENABLE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '数据分类ID', 'description' => '数据分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '更新数据分类', ], 'ListSecurityIdentifyResults' => [ 'summary' => '分页查询安全识别结果。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'ClassifyId' => [ 'title' => '数据分类Id', 'description' => '数据分类Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Env' => [ 'title' => '所属数据源/项目/板块环境标识', 'description' => '所属数据源/项目/板块环境标识', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'BizUnitNameList' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'array', 'items' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'ProjectNameList' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'array', 'items' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'DatasourceNameList' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'array', 'items' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'required' => false, ], 'Status' => [ 'title' => '生效状态筛选: ENABLE 开启、DISABLE 关闭', 'description' => '生效状态筛选: ENABLE 开启、DISABLE 关闭', 'type' => 'string', 'required' => false, 'example' => 'ENABLE', ], 'IsLocked' => [ 'title' => '是否已锁定', 'description' => '是否已锁定', 'type' => 'boolean', 'required' => false, ], 'Keyword' => [ 'title' => '搜索词筛选: 支持按表catalog、表名、表中文名、字段名匹配', 'description' => '搜索词筛选: 支持按表catalog、表名、表中文名、字段名匹配', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'SecurityIdentifyResultList' => [ 'title' => '分页识别结果列表', 'description' => '分页识别结果列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '识别结果ID', 'description' => '识别结果ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ScanTaskId' => [ 'title' => '扫描任务ID', 'description' => '扫描任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'TableTaskId' => [ 'title' => '识别表任务ID', 'description' => '识别表任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'ClassifyId' => [ 'title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '33', ], 'ClassifyName' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => 'test', ], 'ClassifyAbbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'example' => 'test', ], 'LevelIndex' => [ 'title' => '分级等级', 'description' => '分级等级', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LevelName' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'example' => 'test', ], 'LevelAbbreviation' => [ 'title' => '分级简短名称', 'description' => '分级简短名称', 'type' => 'string', 'example' => 'test', ], 'LevelColor' => [ 'title' => '分级颜色', 'description' => '分级颜色', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BizUnitId' => [ 'title' => '业务板块ID', 'description' => '业务板块ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'LD_test', ], 'BizUnitDisplayName' => [ 'title' => '业务板块中文名称', 'description' => '业务板块中文名称', 'type' => 'string', 'example' => 'LD_test', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '101121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ProjectDisplayName' => [ 'title' => '项目中文名称', 'description' => '项目中文名称', 'type' => 'string', 'example' => 'test', ], 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '101121', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'ds1', ], 'TableEnv' => [ 'title' => '表环境', 'description' => '表环境', 'type' => 'string', 'example' => 'DEV', ], 'TableType' => [ 'title' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'description' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'type' => 'string', 'example' => 'LOGIC_TABLE', ], 'TableCatalog' => [ 'title' => '表Catalog', 'description' => '表Catalog', 'type' => 'string', 'example' => 'testdb', ], 'TableId' => [ 'title' => '表ID', 'description' => '表ID', 'type' => 'string', 'example' => '1', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_test', ], 'TableDescription' => [ 'title' => '表描述', 'description' => '表描述', 'type' => 'string', 'example' => 'test', ], 'FieldId' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => 't_test.col1', ], 'FieldName' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'example' => 'col1', ], 'FieldDescription' => [ 'title' => '字段描述', 'description' => '字段描述', 'type' => 'string', 'example' => 'test', ], 'IsCustomIdentify' => [ 'title' => '是否是自定义打标规则', 'description' => '是否是自定义打标规则', 'type' => 'boolean', ], 'IsLocked' => [ 'title' => '是否已锁定', 'description' => '是否已锁定', 'type' => 'boolean', ], 'HasBetterRule' => [ 'title' => '是否存在更匹配的结果', 'description' => '是否存在更匹配的结果', 'type' => 'boolean', ], 'IdentifyRecordId' => [ 'title' => '识别记录ID', 'description' => '识别记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '99', ], 'Status' => [ 'title' => '状态: ENABLE 启用、DISABLE 禁用', 'description' => '状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'example' => 'ENABLE', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'Creator' => [ 'title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 10:30:30', ], 'Modifier' => [ 'title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => '30012011', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 10:30:30', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"SecurityIdentifyResultList\\": [\\n {\\n \\"Id\\": 1,\\n \\"ScanTaskId\\": 11,\\n \\"TableTaskId\\": 22,\\n \\"ClassifyId\\": 33,\\n \\"ClassifyName\\": \\"test\\",\\n \\"ClassifyAbbreviation\\": \\"test\\",\\n \\"LevelIndex\\": 1,\\n \\"LevelName\\": \\"test\\",\\n \\"LevelAbbreviation\\": \\"test\\",\\n \\"LevelColor\\": 1,\\n \\"BizUnitId\\": 1,\\n \\"BizUnitName\\": \\"LD_test\\",\\n \\"BizUnitDisplayName\\": \\"LD_test\\",\\n \\"ProjectId\\": 101121,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectDisplayName\\": \\"test\\",\\n \\"DatasourceId\\": 101121,\\n \\"DatasourceName\\": \\"ds1\\",\\n \\"TableEnv\\": \\"DEV\\",\\n \\"TableType\\": \\"LOGIC_TABLE\\",\\n \\"TableCatalog\\": \\"testdb\\",\\n \\"TableId\\": \\"1\\",\\n \\"TableName\\": \\"t_test\\",\\n \\"TableDescription\\": \\"test\\",\\n \\"FieldId\\": \\"t_test.col1\\",\\n \\"FieldName\\": \\"col1\\",\\n \\"FieldDescription\\": \\"test\\",\\n \\"IsCustomIdentify\\": true,\\n \\"IsLocked\\": true,\\n \\"HasBetterRule\\": true,\\n \\"IdentifyRecordId\\": 99,\\n \\"Status\\": \\"ENABLE\\",\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 10:30:30\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifyTime\\": \\"2025-06-30 10:30:30\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询安全识别结果', ], 'ListSecurityIdentifyRecords' => [ 'summary' => '分页查询安全识别结果的识别记录。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'IsDatasourceTable' => [ 'title' => '是否数据源表, 默认否(视为Dataphin表)', 'description' => '是否数据源表, 默认否(视为Dataphin表)', 'type' => 'boolean', 'required' => false, ], 'DatasourceName' => [ 'title' => '数据源名称,仅数据源表需要填写', 'description' => '数据源名称,仅数据源表需要填写', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DatasourceEnv' => [ 'title' => '数据源环境标识,仅数据源表需要填写', 'description' => '数据源环境标识,仅数据源表需要填写', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'TableCatalog' => [ 'title' => '表Catalog,数据源表请填写所属db或schema名称；Dataphin物理表请填写项目英文名；Dataphin逻辑表请填写板块英文名', 'description' => '表Catalog,数据源表请填写所属db或schema名称；Dataphin物理表请填写项目英文名；Dataphin逻辑表请填写板块英文名', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'required' => true, 'example' => 't_test', ], 'FieldName' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'col1', ], 'Keyword' => [ 'title' => '搜索词范围: 字段名称', 'description' => '搜索词范围: 字段名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'IdentifyRecordList' => [ 'title' => '识别记录列表', 'description' => '识别记录列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '识别记录ID', 'description' => '识别记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'BizUnitId' => [ 'title' => '业务板块ID', 'description' => '业务板块ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'test', ], 'BizUnitDisplayName' => [ 'title' => '业务板块展示名', 'description' => '业务板块展示名', 'type' => 'string', 'example' => 'test_abc', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1001', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ProjectDisplayName' => [ 'title' => '项目展示名', 'description' => '项目展示名', 'type' => 'string', 'example' => 'test_abc', ], 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'test', ], 'TableEnv' => [ 'title' => '表环境', 'description' => '表环境', 'type' => 'string', 'example' => 'DEV', ], 'TableId' => [ 'title' => '表ID', 'description' => '表ID', 'type' => 'string', 'example' => '1', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_test', ], 'TableDescription' => [ 'title' => '表描述', 'description' => '表描述', 'type' => 'string', 'example' => 'test', ], 'TableType' => [ 'title' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'description' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'type' => 'string', 'example' => 'LOGIC_TABLE', ], 'FieldId' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => 't_test.col1', ], 'FieldName' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'example' => 'col1', ], 'FieldDescription' => [ 'title' => '字段描述', 'description' => '字段描述', 'type' => 'string', 'example' => 'test', ], 'ActualIdentifyRate' => [ 'title' => '实际匹配度', 'description' => '实际匹配度', 'type' => 'number', 'format' => 'double', 'example' => '0.1', ], 'ClassifyId' => [ 'title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ClassifyName' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => 'test', ], 'ClassifyAbbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'example' => 'test', ], 'ClassifyStatus' => [ 'title' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'example' => 'ENABLE', ], 'LevelIndex' => [ 'title' => '分级等级', 'description' => '分级等级', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LevelName' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'example' => 'test', ], 'LevelAbbreviation' => [ 'title' => '分级简短名称', 'description' => '分级简短名称', 'type' => 'string', 'example' => 'test', ], 'IsCustomIdentify' => [ 'title' => '是否是自定义打标规则', 'description' => '是否是自定义打标规则', 'type' => 'boolean', ], 'IsLocked' => [ 'title' => '是否已锁定', 'description' => '是否已锁定', 'type' => 'boolean', ], 'IsBetterMatch' => [ 'title' => '是否更匹配', 'description' => '是否更匹配', 'type' => 'boolean', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"IdentifyRecordList\\": [\\n {\\n \\"Id\\": 22,\\n \\"BizUnitId\\": 11,\\n \\"BizUnitName\\": \\"test\\",\\n \\"BizUnitDisplayName\\": \\"test_abc\\",\\n \\"ProjectId\\": 1001,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectDisplayName\\": \\"test_abc\\",\\n \\"DatasourceId\\": 1,\\n \\"DatasourceName\\": \\"test\\",\\n \\"TableEnv\\": \\"DEV\\",\\n \\"TableId\\": \\"1\\",\\n \\"TableName\\": \\"t_test\\",\\n \\"TableDescription\\": \\"test\\",\\n \\"TableType\\": \\"LOGIC_TABLE\\",\\n \\"FieldId\\": \\"t_test.col1\\",\\n \\"FieldName\\": \\"col1\\",\\n \\"FieldDescription\\": \\"test\\",\\n \\"ActualIdentifyRate\\": 0.1,\\n \\"ClassifyId\\": 1,\\n \\"ClassifyName\\": \\"test\\",\\n \\"ClassifyAbbreviation\\": \\"test\\",\\n \\"ClassifyStatus\\": \\"ENABLE\\",\\n \\"LevelIndex\\": 1,\\n \\"LevelName\\": \\"test\\",\\n \\"LevelAbbreviation\\": \\"test\\",\\n \\"IsCustomIdentify\\": true,\\n \\"IsLocked\\": true,\\n \\"IsBetterMatch\\": true,\\n \\"BizDate\\": \\"2025-06-30\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询安全识别结果的识别记录', ], 'GetSecuritySecretKey' => [ 'summary' => '通过密钥名称获取密钥值。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '密钥名称', 'description' => '密钥名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SecuritySecretKeyInfo' => [ 'title' => '安全密钥详情', 'description' => '安全密钥详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '密钥Id', 'description' => '密钥Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '密钥名称', 'description' => '密钥名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '密钥类型: HASH 哈希脱敏、ENCRYPT 加解密', 'description' => '密钥类型: HASH 哈希脱敏、ENCRYPT 加解密', 'type' => 'string', 'example' => 'HASH', ], 'AlgorithmType' => [ 'title' => '算法类型: AES、DES、DESEDE、SM2、SM4、RSA、FF1', 'description' => '算法类型: AES、DES、DESEDE、SM2、SM4、RSA、FF1', 'type' => 'string', 'example' => 'AES', ], 'GenerationType' => [ 'title' => '生成方式: SYSTEM_GENERATION 系统生成、USER_GENERATION 用户生成', 'description' => '生成方式: SYSTEM_GENERATION 系统生成、USER_GENERATION 用户生成', 'type' => 'string', 'example' => 'SYSTEM_GENERATION', ], 'SubKeyCount' => [ 'title' => '子密钥个数', 'description' => '子密钥个数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'SecretKeyList' => [ 'title' => '密钥值', 'description' => '密钥值', 'type' => 'array', 'items' => [ 'title' => '密钥值', 'description' => '密钥值', 'type' => 'string', 'example' => 'abc123456', ], ], 'IsOwnerManageOnly' => [ 'title' => '是否仅负责人可管理', 'description' => '是否仅负责人可管理', 'type' => 'boolean', ], 'EnableOpenapiQuery' => [ 'title' => '是否支持OpenApi查询', 'description' => '是否支持OpenApi查询', 'type' => 'boolean', ], 'AlgorithmTypeAlias' => [ 'title' => '算法类型alias', 'description' => '算法类型alias', 'type' => 'string', 'example' => 'AES', ], 'Owner' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => '30012011', ], 'OwnerName' => [ 'title' => '负责人名称', 'description' => '负责人名称', 'type' => 'string', 'example' => '张三', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SecuritySecretKeyInfo\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Type\\": \\"HASH\\",\\n \\"AlgorithmType\\": \\"AES\\",\\n \\"GenerationType\\": \\"SYSTEM_GENERATION\\",\\n \\"SubKeyCount\\": 2,\\n \\"SecretKeyList\\": [\\n \\"abc123456\\"\\n ],\\n \\"IsOwnerManageOnly\\": true,\\n \\"EnableOpenapiQuery\\": true,\\n \\"AlgorithmTypeAlias\\": \\"AES\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"张三\\"\\n }\\n}","type":"json"}]', 'title' => '通过密钥名称获取密钥值', ], 'GetSecurityLevel' => [ 'summary' => '获取数据分级详情。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Index', 'in' => 'query', 'schema' => [ 'title' => '数据分级敏感程度', 'description' => '数据分级敏感程度', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SecurityLevelInfo' => [ 'title' => '数据分级详情', 'description' => '数据分级详情', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '数据分级名称', 'description' => '数据分级名称', 'type' => 'string', 'example' => 'test', ], 'Abbreviation' => [ 'title' => '数据分级缩写名称', 'description' => '数据分级缩写名称', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'title' => '数据分级描述', 'description' => '数据分级描述', 'type' => 'string', 'example' => 'test', ], 'Index' => [ 'title' => '数据分级敏感程度', 'description' => '数据分级敏感程度', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RelatedClassifyIdList' => [ 'title' => '绑定当前数据分级的数据分类Id列表', 'description' => '绑定当前数据分级的数据分类Id列表', 'type' => 'array', 'items' => [ 'title' => '绑定当前数据分级的数据分类Id列表', 'description' => '绑定当前数据分级的数据分类Id列表', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SecurityLevelInfo\\": {\\n \\"Name\\": \\"test\\",\\n \\"Abbreviation\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"Index\\": 1,\\n \\"RelatedClassifyIdList\\": [\\n 2\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取数据分级详情', ], 'GetSecurityIdentifyResult' => [ 'summary' => '获取识别结果详情。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '识别结果ID', 'description' => '识别结果ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SecurityIdentifyResultInfo' => [ 'title' => '识别结果详情', 'description' => '识别结果详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '识别结果ID', 'description' => '识别结果ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ScanTaskId' => [ 'title' => '扫描任务ID', 'description' => '扫描任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'TableTaskId' => [ 'title' => '识别表任务ID', 'description' => '识别表任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'ClassifyId' => [ 'title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '33', ], 'ClassifyName' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => 'test', ], 'ClassifyAbbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'example' => 'test', ], 'LevelIndex' => [ 'title' => '分级等级', 'description' => '分级等级', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LevelName' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'example' => 'test', ], 'LevelAbbreviation' => [ 'title' => '分级简短名称', 'description' => '分级简短名称', 'type' => 'string', 'example' => 'test', ], 'LevelColor' => [ 'title' => '分级颜色', 'description' => '分级颜色', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BizUnitId' => [ 'title' => '业务板块ID', 'description' => '业务板块ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'LD_test', ], 'BizUnitDisplayName' => [ 'title' => '业务板块中文名称', 'description' => '业务板块中文名称', 'type' => 'string', 'example' => 'LD_test', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '101121', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ProjectDisplayName' => [ 'title' => '项目中文名称', 'description' => '项目中文名称', 'type' => 'string', 'example' => 'test', ], 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '101121', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'ds1', ], 'TableEnv' => [ 'title' => '表环境', 'description' => '表环境', 'type' => 'string', 'example' => 'DEV', ], 'TableType' => [ 'title' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'description' => '表类型: LOGIC_TABLE 逻辑表，LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_ODM_SOURCE 源表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REAL_TIME_LOGIC_TABLE 实时配置的逻辑表', 'type' => 'string', 'example' => 'LOGIC_TABLE', ], 'TableCatalog' => [ 'title' => '表Catalog', 'description' => '表Catalog', 'type' => 'string', 'example' => 'testdb', ], 'TableId' => [ 'title' => '表ID', 'description' => '表ID', 'type' => 'string', 'example' => '1', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_test', ], 'TableDescription' => [ 'title' => '表描述', 'description' => '表描述', 'type' => 'string', 'example' => 'test', ], 'FieldId' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => 't_test.col1', ], 'FieldName' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'example' => 'col1', ], 'FieldDescription' => [ 'title' => '字段描述', 'description' => '字段描述', 'type' => 'string', 'example' => 'test', ], 'IsCustomIdentify' => [ 'title' => '是否是自定义打标规则', 'description' => '是否是自定义打标规则', 'type' => 'boolean', ], 'IsLocked' => [ 'title' => '是否已锁定', 'description' => '是否已锁定', 'type' => 'boolean', ], 'HasBetterRule' => [ 'title' => '是否存在更匹配的结果', 'description' => '是否存在更匹配的结果', 'type' => 'boolean', ], 'IdentifyRecordId' => [ 'title' => '识别记录ID', 'description' => '识别记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '99', ], 'Status' => [ 'title' => '状态: ENABLE 启用、DISABLE 禁用', 'description' => '状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'example' => 'ENABLE', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2025-06-30', ], 'Creator' => [ 'title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '30012011', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 10:30:30', ], 'Modifier' => [ 'title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => '30012011', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 10:30:30', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SecurityIdentifyResultInfo\\": {\\n \\"Id\\": 1,\\n \\"ScanTaskId\\": 11,\\n \\"TableTaskId\\": 22,\\n \\"ClassifyId\\": 33,\\n \\"ClassifyName\\": \\"test\\",\\n \\"ClassifyAbbreviation\\": \\"test\\",\\n \\"LevelIndex\\": 1,\\n \\"LevelName\\": \\"test\\",\\n \\"LevelAbbreviation\\": \\"test\\",\\n \\"LevelColor\\": 1,\\n \\"BizUnitId\\": 1,\\n \\"BizUnitName\\": \\"LD_test\\",\\n \\"BizUnitDisplayName\\": \\"LD_test\\",\\n \\"ProjectId\\": 101121,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectDisplayName\\": \\"test\\",\\n \\"DatasourceId\\": 101121,\\n \\"DatasourceName\\": \\"ds1\\",\\n \\"TableEnv\\": \\"DEV\\",\\n \\"TableType\\": \\"LOGIC_TABLE\\",\\n \\"TableCatalog\\": \\"testdb\\",\\n \\"TableId\\": \\"1\\",\\n \\"TableName\\": \\"t_test\\",\\n \\"TableDescription\\": \\"test\\",\\n \\"FieldId\\": \\"t_test.col1\\",\\n \\"FieldName\\": \\"col1\\",\\n \\"FieldDescription\\": \\"test\\",\\n \\"IsCustomIdentify\\": true,\\n \\"IsLocked\\": true,\\n \\"HasBetterRule\\": true,\\n \\"IdentifyRecordId\\": 99,\\n \\"Status\\": \\"ENABLE\\",\\n \\"BizDate\\": \\"2025-06-30\\",\\n \\"Creator\\": \\"30012011\\",\\n \\"CreateTime\\": \\"2025-06-30 10:30:30\\",\\n \\"Modifier\\": \\"30012011\\",\\n \\"ModifyTime\\": \\"2025-06-30 10:30:30\\"\\n }\\n}","type":"json"}]', 'title' => '获取识别结果详情', ], 'GetSecurityClassify' => [ 'summary' => '获取数据分类详情。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'SecurityClassifyInfo' => [ 'title' => '数据分类详情', 'description' => '数据分类详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据分类ID', 'description' => '数据分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => 'test', ], 'Abbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'example' => 'test', ], 'Path' => [ 'title' => '分类路径', 'description' => '分类路径', 'type' => 'string', 'example' => '/a/b/c', ], 'LevelIndex' => [ 'title' => '分级Index', 'description' => '分级Index', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LevelName' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'example' => 'lv_teat', ], 'LevelAbbreviation' => [ 'title' => '分级缩写名', 'description' => '分级缩写名', 'type' => 'string', 'example' => 'lv_test', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SecurityClassifyInfo\\": {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Abbreviation\\": \\"test\\",\\n \\"Path\\": \\"/a/b/c\\",\\n \\"LevelIndex\\": 1,\\n \\"LevelName\\": \\"lv_teat\\",\\n \\"LevelAbbreviation\\": \\"lv_test\\"\\n }\\n}","type":"json"}]', 'title' => '获取数据分类详情', ], 'DeleteSecurityLevel' => [ 'summary' => '删除数据分级。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => '分级敏感等级,当不传递时将按照分级名称进行精确匹配删除', 'description' => '分级敏感等级,当不传递时将按照分级名称进行精确匹配删除', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'DeleteResult' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', ], 'ErrorCode' => [ 'title' => '异常代码', 'description' => '异常代码', 'type' => 'string', 'example' => 'E10012011', ], 'RelatedClassifyIdList' => [ 'title' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', 'description' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', 'type' => 'array', 'items' => [ 'title' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', 'description' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"DeleteResult\\": {\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"E10012011\\",\\n \\"RelatedClassifyIdList\\": [\\n 1\\n ]\\n }\\n}","type":"json"}]', 'title' => '删除数据分级', ], 'DeleteSecurityIdentifyResults' => [ 'summary' => '批量删除安全识别结果。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'IdentifyResultIdList' => [ 'title' => '识别结果ID列表', 'description' => '识别结果ID列表', 'type' => 'array', 'items' => [ 'title' => '识别结果ID列表', 'description' => '识别结果ID列表', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '批量删除安全识别结果', ], 'DeleteSecurityClassifyCatalog' => [ 'summary' => '删除数据分类目录。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除指令', 'description' => '删除指令', 'type' => 'object', 'properties' => [ 'Path' => [ 'title' => '原目录的完整路径', 'description' => '原目录的完整路径', 'type' => 'string', 'required' => true, 'example' => '/d1/d2/', ], 'ReturnRemovedDetails' => [ 'title' => '是否返回删除详情,默认: true', 'description' => '是否返回删除详情,默认: true', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除结果详情', 'description' => '删除结果详情', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => '是否删除成功', 'description' => '是否删除成功', 'type' => 'boolean', ], 'ChildCatalogFullPathList' => [ 'title' => '被连带删除的子目录完整路径列表', 'description' => '被连带删除的子目录完整路径列表', 'type' => 'array', 'items' => [ 'title' => '被连带删除的子目录完整路径列表', 'description' => '被连带删除的子目录完整路径列表', 'type' => 'string', 'example' => '/d1/d2/d3/', ], ], 'ClassifyIdList' => [ 'title' => '被连带删除的分类ID列表', 'description' => '被连带删除的分类ID列表', 'type' => 'array', 'items' => [ 'title' => '被连带删除的分类ID列表', 'description' => '被连带删除的分类ID列表', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"ChildCatalogFullPathList\\": [\\n \\"/d1/d2/d3/\\"\\n ],\\n \\"ClassifyIdList\\": [\\n 5\\n ]\\n }\\n}","type":"json"}]', 'title' => '删除数据分类目录', ], 'DeleteSecurityClassify' => [ 'summary' => '删除数据分类。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新指令', 'description' => '更新指令', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '分类ID, 不传递时按照分类名称+分类父路径匹配分类进行删除', 'description' => '分类ID, 不传递时按照分类名称+分类父路径匹配分类进行删除', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Name' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ParentPath' => [ 'title' => '分类路径,默认/', 'description' => '分类路径,默认/', 'type' => 'string', 'required' => false, 'example' => '/', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => '删除数据分类', ], 'CreateSecurityLevel' => [ 'summary' => '新建数据分级。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '分级名称', 'description' => '分级名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Abbreviation' => [ 'title' => '分级缩写', 'description' => '分级缩写', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Index' => [ 'title' => '分级顺序，不传递将默认生成当前最大顺序Id', 'description' => '分级顺序，不传递将默认生成当前最大顺序Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'Description' => [ 'title' => '分级描述', 'description' => '分级描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '数据分级Index', 'description' => '数据分级ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建数据分级', ], 'CreateSecurityIdentifyResult' => [ 'summary' => '新建安全识别结果。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'IsDatasourceTable' => [ 'title' => '是否数据源表, 默认否(视为Dataphin表)', 'description' => '是否数据源表, 默认否(视为Dataphin表)', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DatasourceName' => [ 'title' => '数据源名称,仅数据源表需要填写', 'description' => '数据源名称,仅数据源表需要填写', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DatasourceEnv' => [ 'title' => '数据源环境标识,仅数据源表需要填写', 'description' => '数据源环境标识,仅数据源表需要填写', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'TableCatalog' => [ 'title' => '表Catalog,数据源表请填写所属db或schema名称；Dataphin物理表请填写项目英文名；Dataphin逻辑表请填写板块英文名', 'description' => '表Catalog,数据源表请填写所属db或schema名称；Dataphin物理表请填写项目英文名；Dataphin逻辑表请填写板块英文名', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'required' => true, 'example' => 't_test', ], 'FieldName' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'col1', ], 'ClassifyId' => [ 'title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], 'Enable' => [ 'title' => '生效状态: true开启、false关闭, 默认: true', 'description' => '生效状态: true开启、false关闭, 默认: true', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'ConflictStrategy' => [ 'title' => '去重策略: COVER_ALL 覆盖线上全部打标、COVER_UNLOCKED 仅覆盖线上未锁定打标、NOT_COVER 不覆盖,保留线上打标', 'description' => '去重策略: COVER_ALL 覆盖线上全部打标、COVER_UNLOCKED 仅覆盖线上未锁定打标、', 'type' => 'string', 'required' => true, 'example' => 'COVER_ALL', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '识别结果ID', 'description' => '识别结果ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建安全识别结果', ], 'CreateSecurityClassifyCatalog' => [ 'summary' => '新建数据分类目录。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '分类目录名称', 'description' => '分类目录名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'ParentPath' => [ 'title' => '分类父目录完整路径,默认/', 'description' => '分类父目录完整路径,默认/', 'type' => 'string', 'required' => false, 'example' => '/d1/', ], 'OwnerList' => [ 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'description' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'type' => 'array', 'items' => [ 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'description' => '管理员ID列表，仅当所属父目录为根目录时填写有效', 'type' => 'string', 'required' => false, 'example' => '30001011', ], 'required' => false, ], 'VisibleType' => [ 'title' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', 'description' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '新建成功的目录的完整路径', 'description' => '新建成功的目录的完整路径', 'type' => 'string', 'example' => '/d1/d2/', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"/d1/d2/\\"\\n}","type":"json"}]', 'title' => '新建数据分类目录', ], 'CreateSecurityClassify' => [ 'summary' => '新建数据分类。'."\n" .'上线版本：v5.4.2 。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建指令', 'description' => '创建指令', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'Abbreviation' => [ 'title' => '分类简称', 'description' => '分类简称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Description' => [ 'title' => '分类描述', 'description' => '分类描述', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ParentPath' => [ 'title' => '分类路径,可选，未填写或填写/均视为直接归属根目录', 'description' => '分类路径,可选，未填写或填写/均视为直接归属根目录', 'type' => 'string', 'required' => false, 'example' => '/', ], 'LevelName' => [ 'title' => '数据分级名称', 'description' => '数据分级名称', 'type' => 'string', 'required' => true, 'example' => 'L2', ], 'FeatureNameList' => [ 'title' => '特征名称', 'description' => '特征名称', 'type' => 'array', 'items' => [ 'title' => '特征名称', 'description' => '特征名称', 'type' => 'string', 'required' => false, 'example' => '行业', ], 'required' => false, ], 'Priority' => [ 'title' => '优先级,默认: 5', 'description' => '优先级,默认: 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'AdvancedConditionList' => [ 'title' => '高级配置', 'description' => '高级配置', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ParentId' => [ 'title' => '特征条件父节点', 'description' => '特征条件父节点', 'type' => 'string', 'required' => false, 'example' => '123', ], 'Id' => [ 'title' => '特征条件节点id，由业务随机生成且确保唯一', 'description' => '特征条件节点id，由业务随机生成且确保唯一', 'type' => 'string', 'required' => true, 'example' => '234', ], 'Relation' => [ 'title' => '条件关系: EXPRESSION 表达式、RELATION 关系', 'description' => '条件关系: EXPRESSION 表达式、RELATION 关系', 'type' => 'string', 'required' => true, 'example' => 'EXPRESSION', ], 'Property' => [ 'title' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', 'description' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', 'type' => 'string', 'required' => false, 'example' => 'TABLE_NAME', ], 'Operate' => [ 'title' => '条件操作: AND、OR、BUILT_IN_EXPRESSION 内置表达式、IGNORE_CASE_EXPRESSION 正则 - 大小写兼容、EXPRESSION 正则表达式、NOT_BELONG 不属于、CONTAINS 包含、NOT_CONTAINS 不包含、EQUAL、NOT_EQUAL', 'description' => '条件操作: AND、OR、BUILT_IN_EXPRESSION 内置表达式、IGNORE_CASE_EXPRESSION 正则 - 大小写兼容、EXPRESSION 正则表达式、NOT_BELONG 不属于、CONTAINS 包含、NOT_CONTAINS 不包含、EQUAL、NOT_EQUAL', 'type' => 'string', 'required' => true, 'example' => 'AND', ], 'ValueList' => [ 'title' => '条件取值', 'description' => '条件取值', 'type' => 'array', 'items' => [ 'title' => '条件取值', 'description' => '条件取值', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'required' => false, ], 'OptionList' => [ 'title' => '额外属性,如字段内容', 'description' => '额外属性,如字段内容', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'required' => true, 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'v1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'Status' => [ 'title' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'description' => '分类生效状态: ENABLE 启用、DISABLE 禁用', 'type' => 'string', 'required' => false, 'example' => 'ENABLE', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '数据分类ID', 'description' => '数据分类ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '新建数据分类', ], 'GetTableLineages' => [ 'summary' => '查询资产表血缘信息。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'TableGuid', 'in' => 'query', 'schema' => [ 'title' => '表Guid, 每个资产的唯一标识', 'description' => '表Guid, 每个资产的唯一标识', 'type' => 'string', 'required' => true, 'example' => '1121', ], ], [ 'name' => 'FilterQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '过滤条件', 'description' => '过滤条件', 'type' => 'object', 'properties' => [ 'NodeEnv' => [ 'title' => '用于过滤要查询的任务所属环境: dev、prod', 'description' => '用于过滤要查询的任务所属环境: dev、prod', 'type' => 'string', 'required' => false, 'example' => 'dev', ], 'NodeIdList' => [ 'title' => '用于过滤要查询的任务Id列表', 'description' => '用于过滤要查询的任务Id列表', 'type' => 'array', 'items' => [ 'title' => '用于过滤要查询的任务Id列表', 'description' => '用于过滤要查询的任务Id列表', 'type' => 'string', 'required' => false, 'example' => '110021', ], 'required' => false, ], 'NeedUpstream' => [ 'title' => '是否查询上游血缘, 默认：false', 'description' => '是否查询上游血缘, 默认：false', 'type' => 'boolean', 'required' => false, ], 'NeedDownstream' => [ 'title' => '是否查询下游血缘, 默认：false', 'description' => '是否查询下游血缘, 默认：false', 'type' => 'boolean', 'required' => false, ], 'NeedNotExistObject' => [ 'title' => '返回在资产清单中不存在的表, 默认：false', 'description' => '返回在资产清单中不存在的表, 默认：false', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'TableLineageList' => [ 'title' => '表血缘列表', 'description' => '表血缘列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '血缘对应的任务Id', 'description' => '血缘对应的任务Id', 'type' => 'string', 'example' => '110021', ], 'NodeEnv' => [ 'title' => '任务所属环境: dev、prod', 'description' => '任务所属环境: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'InputTableEnv' => [ 'title' => '输入表所属环境: dev、prod', 'description' => '输入表所属环境: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'InputTableGuid' => [ 'title' => '输入表Guid, 每个资产都有唯一标识', 'description' => '输入表Guid, 每个资产都有唯一标识', 'type' => 'string', 'example' => '123211', ], 'InputTableName' => [ 'title' => '输入表名', 'description' => '输入表名', 'type' => 'string', 'example' => 't_input', ], 'InputProjectId' => [ 'title' => '输入表所属项目Id', 'description' => '输入表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1233', ], 'InputBizUnitId' => [ 'title' => '输入表所属业务板块Id', 'description' => '输入表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'InputDataSourceId' => [ 'title' => '输入表所属数据源Id', 'description' => '输入表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'InputDataSourceType' => [ 'title' => '输入表所属数据源类型', 'description' => '输入表所属数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputTableDeleted' => [ 'title' => '输入表是否已删除', 'description' => '输入表是否已删除', 'type' => 'boolean', ], 'OutputTableEnv' => [ 'title' => '输出表所属的env: dev、prod', 'description' => '输出表所属的env: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'OutputTableGuid' => [ 'title' => '输出表Guid, 每个资产都有唯一标识', 'description' => '输出表Guid, 每个资产都有唯一标识', 'type' => 'string', 'example' => '2231', ], 'OutputTableName' => [ 'title' => '输出表名', 'description' => '输出表名', 'type' => 'string', 'example' => 't_output', ], 'OutputProjectId' => [ 'title' => '输出表所属项目Id', 'description' => '输出表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1233', ], 'OutputBizUnitId' => [ 'title' => '输出表所属业务板块Id', 'description' => '输出表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'OutputDataSourceId' => [ 'title' => '输出表所属数据源Id', 'description' => '输出表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'OutputDataSourceType' => [ 'title' => '输出表所属数据源类型', 'description' => '输出表所属数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputTableDeleted' => [ 'title' => '输出表是否已删除', 'description' => '输出表是否已删除', 'type' => 'boolean', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"TableLineageList\\": [\\n {\\n \\"NodeId\\": \\"110021\\",\\n \\"NodeEnv\\": \\"dev\\",\\n \\"InputTableEnv\\": \\"dev\\",\\n \\"InputTableGuid\\": \\"123211\\",\\n \\"InputTableName\\": \\"t_input\\",\\n \\"InputProjectId\\": 1233,\\n \\"InputBizUnitId\\": 1,\\n \\"InputDataSourceId\\": 1,\\n \\"InputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"InputTableDeleted\\": true,\\n \\"OutputTableEnv\\": \\"dev\\",\\n \\"OutputTableGuid\\": \\"2231\\",\\n \\"OutputTableName\\": \\"t_output\\",\\n \\"OutputProjectId\\": 1233,\\n \\"OutputBizUnitId\\": 1,\\n \\"OutputDataSourceId\\": 1,\\n \\"OutputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"OutputTableDeleted\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资产表血缘信息', ], 'GetBelongAssetMapping' => [ 'summary' => '根据归属资产GUID查询映射关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AssetMappingQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询指令', 'description' => '查询指令', 'type' => 'object', 'properties' => [ 'BelongGuid' => [ 'title' => '归属资产Guid', 'description' => '归属资产Guid', 'type' => 'string', 'required' => true, 'example' => '1121', ], 'RelationType' => [ 'title' => '映射关系类型: VALID 已映射、INVALID 无效映射', 'description' => '映射关系类型: VALID 已映射、INVALID 无效映射', 'type' => 'string', 'required' => false, 'example' => 'VALID', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'MappingRelationList' => [ 'title' => '映射关系列表', 'description' => '映射关系列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ModifyTime' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Guid' => [ 'title' => '资产guid', 'description' => '资产guid', 'type' => 'string', 'example' => '1122', ], 'Name' => [ 'title' => '资产名称', 'description' => '资产名称', 'type' => 'string', 'example' => 'test', ], 'AssetType' => [ 'title' => '资产类型: COLUMN 字段、INDEX 指标', 'description' => '资产类型: COLUMN 字段、INDEX 指标', 'type' => 'string', 'example' => 'COLUMN', ], 'StandardId' => [ 'title' => '标准id', 'description' => '标准id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StandardName' => [ 'title' => '标准名称', 'description' => '标准名称', 'type' => 'string', 'example' => 'test', ], 'StandardCode' => [ 'title' => '标准编码', 'description' => '标准编码', 'type' => 'string', 'example' => 'cc', ], 'StandardSetId' => [ 'title' => '标准集id', 'description' => '标准集id', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'StandardSetName' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'example' => 'test', ], 'StandardSetDirectory' => [ 'title' => '标准集所在的文件夹', 'description' => '标准集所在的文件夹', 'type' => 'string', 'example' => '/dir1', ], 'StandardStage' => [ 'title' => '标准阶段', 'description' => '标准阶段', 'type' => 'string', 'example' => 'PROD', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"MappingRelationList\\": [\\n {\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Guid\\": \\"1122\\",\\n \\"Name\\": \\"test\\",\\n \\"AssetType\\": \\"COLUMN\\",\\n \\"StandardId\\": 1,\\n \\"StandardName\\": \\"test\\",\\n \\"StandardCode\\": \\"cc\\",\\n \\"StandardSetId\\": 2,\\n \\"StandardSetName\\": \\"test\\",\\n \\"StandardSetDirectory\\": \\"/dir1\\",\\n \\"StandardStage\\": \\"PROD\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '根据归属资产GUID查询映射关系', ], 'GetAssetMappingRelations' => [ 'summary' => '根据资产对象GUID查询映射关系。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AssetMappingQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询指令', 'description' => '查询指令', 'type' => 'object', 'properties' => [ 'Guid' => [ 'title' => '资产对象guid', 'description' => '资产对象guid', 'type' => 'string', 'required' => true, 'example' => '1121', ], 'AssetType' => [ 'title' => '资产对象类型: COLUMN 字段、INDEX 指标', 'description' => '资产对象类型: COLUMN 字段、INDEX 指标', 'type' => 'string', 'required' => true, 'example' => 'INDEX', ], 'RelationType' => [ 'title' => '映射关系类型: VALID 已映射、INVALID 无效映射', 'description' => '映射关系类型: VALID 已映射、INVALID 无效映射', 'type' => 'string', 'required' => true, 'example' => 'VALID', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'MappingRelationList' => [ 'title' => '映射关系列表', 'description' => '映射关系列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ModifyTime' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Guid' => [ 'title' => '资产guid', 'description' => '资产guid', 'type' => 'string', 'example' => '1122', ], 'Name' => [ 'title' => '资产名称', 'description' => '资产名称', 'type' => 'string', 'example' => 'test', ], 'AssetType' => [ 'title' => '资产类型: COLUMN 字段、INDEX 指标', 'description' => '资产类型: COLUMN 字段、INDEX 指标', 'type' => 'string', 'example' => 'COLUMN', ], 'StandardId' => [ 'title' => '标准id', 'description' => '标准id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'StandardName' => [ 'title' => '标准名称', 'description' => '标准名称', 'type' => 'string', 'example' => 'test', ], 'StandardCode' => [ 'title' => '标准编码', 'description' => '标准编码', 'type' => 'string', 'example' => 'cc', ], 'StandardSetId' => [ 'title' => '标准集id', 'description' => '标准集id', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'StandardSetName' => [ 'title' => '标准集名称', 'description' => '标准集名称', 'type' => 'string', 'example' => 'test', ], 'StandardSetDirectory' => [ 'title' => '标准集所在的文件夹', 'description' => '标准集所在的文件夹', 'type' => 'string', 'example' => '/dir1', ], 'StandardStage' => [ 'title' => '标准阶段', 'description' => '标准阶段', 'type' => 'string', 'example' => 'PROD', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"MappingRelationList\\": [\\n {\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Guid\\": \\"1122\\",\\n \\"Name\\": \\"test\\",\\n \\"AssetType\\": \\"COLUMN\\",\\n \\"StandardId\\": 1,\\n \\"StandardName\\": \\"test\\",\\n \\"StandardCode\\": \\"cc\\",\\n \\"StandardSetId\\": 2,\\n \\"StandardSetName\\": \\"test\\",\\n \\"StandardSetDirectory\\": \\"/dir1\\",\\n \\"StandardStage\\": \\"PROD\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '根据资产对象GUID查询映射关系', ], 'ListTables' => [ 'summary' => '分页查询查询资产表元数据。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询条件', 'description' => '分页查询条件', 'type' => 'object', 'properties' => [ 'Catalog' => [ 'title' => '资产目录：项目名、业务板块名', 'description' => '资产目录：项目名、业务板块名', 'type' => 'string', 'required' => true, 'example' => 'LD_test01_dev', ], 'Keyword' => [ 'title' => '关键字支持：表名', 'description' => '关键字支持：表名', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'TableList' => [ 'title' => '表列表', 'description' => '表列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Guid' => [ 'title' => '表Guid', 'description' => '表Guid', 'type' => 'string', 'example' => '10011', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3301', ], 'TableSizeInBytes' => [ 'title' => '表存储总量, 单位：byte', 'description' => '表存储总量, 单位：byte', 'type' => 'integer', 'format' => 'int64', 'example' => '10241024', ], 'LifeCycle' => [ 'title' => '表生命周期: 天', 'description' => '表生命周期: 天', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'LastDdlTime' => [ 'title' => '表DDL最后变更时间', 'description' => '表DDL最后变更时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'LastQueryTime' => [ 'title' => '最近一次查看数据的时间', 'description' => '最近一次查看数据的时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Owner' => [ 'title' => '表负责人在Dataphin的用户Id, 未绑定可能为空', 'description' => '表负责人在Dataphin的用户Id, 未绑定可能为空', 'type' => 'string', 'example' => '30011211', ], 'Creator' => [ 'title' => '创建人id', 'description' => '创建人id', 'type' => 'string', 'example' => '30011211', ], 'VisitCount30d' => [ 'title' => '最近30天的访问次数', 'description' => '最近30天的访问次数', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'Env' => [ 'title' => '所属环境：dev、prod', 'description' => '所属环境：dev、prod', 'type' => 'string', 'example' => 'dev', ], 'Name' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_test01', ], 'DisplayName' => [ 'title' => '表展示名', 'description' => '表展示名', 'type' => 'string', 'example' => '学生', ], 'LastDmlTime' => [ 'title' => '表数据最近更新时间', 'description' => '表数据最近更新时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'Comment' => [ 'title' => '表注释', 'description' => '表注释', 'type' => 'string', 'example' => 'test', ], 'BizUnitId' => [ 'title' => '业务板块Id', 'description' => '业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '2011', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'LD_test01', ], 'DataDomainId' => [ 'title' => '数据域id', 'description' => '数据域id', 'type' => 'integer', 'format' => 'int64', 'example' => '211', ], 'DataDomainName' => [ 'title' => '主题域名称', 'description' => '主题域名称', 'type' => 'string', 'example' => '211', ], 'ProjectId' => [ 'title' => '逻辑项目id', 'description' => '逻辑项目id', 'type' => 'integer', 'format' => 'int64', 'example' => '1011', ], 'ProjectName' => [ 'title' => '逻辑项目名', 'description' => '逻辑项目名', 'type' => 'string', 'example' => 'testPrj', ], 'ParentModelId' => [ 'title' => '父模型ID, 跳转ODM模型使用', 'description' => '父模型ID, 跳转ODM模型使用', 'type' => 'string', 'example' => '1', ], 'FileId' => [ 'title' => '文件ID, 跳转ODM模型使用', 'description' => '文件ID, 跳转ODM模型使用', 'type' => 'string', 'example' => '2', ], 'IsPartitionTable' => [ 'title' => '是否分区键', 'description' => '是否分区键', 'type' => 'boolean', ], 'StorageType' => [ 'title' => '存储类型：HIVE、MAX_COMPUTE', 'description' => '存储类型：HIVE、MAX_COMPUTE', 'type' => 'string', 'example' => 'HIVE', ], 'StreamTableConfig' => [ 'title' => '实时元表类的动态属性', 'description' => '实时元表类的动态属性', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'example' => 'k1', ], 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'v1', ], ], ], ], 'IsBasicMode' => [ 'title' => '表所属项目或者业务版本是否是Basic模式', 'description' => '表所属项目或者业务版本是否是Basic模式', 'type' => 'boolean', ], 'AssetTagList' => [ 'title' => '资产清单标签', 'description' => '资产清单标签', 'type' => 'array', 'items' => [ 'title' => '资产清单标签', 'description' => '资产清单标签', 'type' => 'string', 'example' => 'LYDAAS', ], ], 'SecurityLevel' => [ 'title' => '安全分级', 'description' => '安全分级', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'SecurityLevelName' => [ 'title' => '安全分级名称', 'description' => '安全分级名称', 'type' => 'string', 'example' => '高级', ], 'SecurityLevelAbbreviation' => [ 'title' => '安全分级名称缩写', 'description' => '安全分级名称缩写', 'type' => 'string', 'example' => '高级', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"TableList\\": [\\n {\\n \\"Guid\\": \\"10011\\",\\n \\"DataSourceId\\": 3301,\\n \\"TableSizeInBytes\\": 10241024,\\n \\"LifeCycle\\": 30,\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"LastDdlTime\\": \\"2025-06-30 00:00:00\\",\\n \\"LastQueryTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Owner\\": \\"30011211\\",\\n \\"Creator\\": \\"30011211\\",\\n \\"VisitCount30d\\": 22,\\n \\"Env\\": \\"dev\\",\\n \\"Name\\": \\"t_test01\\",\\n \\"DisplayName\\": \\"学生\\",\\n \\"LastDmlTime\\": \\"2025-06-30 00:00:00\\",\\n \\"Comment\\": \\"test\\",\\n \\"BizUnitId\\": 2011,\\n \\"BizUnitName\\": \\"LD_test01\\",\\n \\"DataDomainId\\": 211,\\n \\"DataDomainName\\": \\"211\\",\\n \\"ProjectId\\": 1011,\\n \\"ProjectName\\": \\"testPrj\\",\\n \\"ParentModelId\\": \\"1\\",\\n \\"FileId\\": \\"2\\",\\n \\"IsPartitionTable\\": true,\\n \\"StorageType\\": \\"HIVE\\",\\n \\"StreamTableConfig\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"IsBasicMode\\": true,\\n \\"AssetTagList\\": [\\n \\"LYDAAS\\"\\n ],\\n \\"SecurityLevel\\": 1,\\n \\"SecurityLevelName\\": \\"高级\\",\\n \\"SecurityLevelAbbreviation\\": \\"高级\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询查询资产表元数据', ], 'GetTableColumnLineages' => [ 'summary' => '查询资产表字段血缘信息。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'TableGuid', 'in' => 'query', 'schema' => [ 'title' => '表Guid，在资产唯一标识', 'description' => '表Guid，在资产唯一标识', 'type' => 'string', 'required' => true, 'example' => '1121', ], ], [ 'name' => 'FilterQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '过滤条件', 'description' => '过滤条件', 'type' => 'object', 'properties' => [ 'NodeEnv' => [ 'title' => '用于过滤要查询的任务所属环境: dev、prod', 'description' => '用于过滤要查询的任务所属环境: dev、prod', 'type' => 'string', 'required' => false, 'example' => 'dev', ], 'NodeIdList' => [ 'title' => '用于过滤要查询的任务Id列表', 'description' => '用于过滤要查询的任务Id列表', 'type' => 'array', 'items' => [ 'title' => '用于过滤要查询的任务Id列表', 'description' => '用于过滤要查询的任务Id列表', 'type' => 'string', 'required' => false, 'example' => '110021', ], 'required' => false, ], 'NeedUpstream' => [ 'title' => '是否查询上游血缘, 默认：true', 'description' => '是否查询上游血缘, 默认：true', 'type' => 'boolean', 'required' => false, ], 'NeedDownstream' => [ 'title' => '是否查询下游血缘, 默认：true', 'description' => '是否查询下游血缘, 默认：true', 'type' => 'boolean', 'required' => false, ], 'NeedNotExistObject' => [ 'title' => '返回在资产清单中不存在的表, 默认：false', 'description' => '返回在资产清单中不存在的表, 默认：false', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'TableColumnLineageList' => [ 'title' => '表字段血缘列表', 'description' => '表字段血缘列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '血缘对应的任务Id', 'description' => '血缘对应的任务Id', 'type' => 'string', 'example' => '110021', ], 'NodeEnv' => [ 'title' => '任务所属环境: dev、prod', 'description' => '任务所属环境: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'InputTableEnv' => [ 'title' => '输入表所属环境: dev、prod', 'description' => '输入表所属环境: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'InputTableGuid' => [ 'title' => '输入表Guid, 每个资产都有唯一标识', 'description' => '输入表Guid, 每个资产都有唯一标识', 'type' => 'string', 'example' => '123211', ], 'InputTableName' => [ 'title' => '输入表名', 'description' => '输入表名', 'type' => 'string', 'example' => 't_input', ], 'InputColumnName' => [ 'title' => '输入字段名称', 'description' => '输入字段名称', 'type' => 'string', 'example' => 'col1', ], 'InputColumnGuid' => [ 'title' => '输入字段Guid, 格式: 表Guid.字段名', 'description' => '输入字段Guid, 格式: 表Guid.字段名', 'type' => 'string', 'example' => '1121.col1', ], 'InputProjectId' => [ 'title' => '输入表所属项目Id', 'description' => '输入表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1233', ], 'InputBizUnitId' => [ 'title' => '输入表所属业务板块Id', 'description' => '输入表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'InputDataSourceId' => [ 'title' => '输入表所属数据源Id', 'description' => '输入表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'InputDataSourceType' => [ 'title' => '输入表所属数据源类型', 'description' => '输入表所属数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputTableDeleted' => [ 'title' => '输入表是否已删除', 'description' => '输入表是否已删除', 'type' => 'boolean', ], 'OutputTableEnv' => [ 'title' => '输出表所属的env: dev、prod', 'description' => '输出表所属的env: dev、prod', 'type' => 'string', 'example' => 'dev', ], 'OutputTableGuid' => [ 'title' => '输出表Guid, 每个资产都有唯一标识', 'description' => '输出表Guid, 每个资产都有唯一标识', 'type' => 'string', 'example' => '2231', ], 'OutputTableName' => [ 'title' => '输出表名', 'description' => '输出表名', 'type' => 'string', 'example' => 't_output', ], 'OutputColumnName' => [ 'title' => '输出字段名称', 'description' => '输出字段名称', 'type' => 'string', 'example' => 'col2', ], 'OutputColumnGuid' => [ 'title' => '输出字段Guid, 格式为: 表Id.字段名', 'description' => '输出字段Guid, 格式为: 表Id.字段名', 'type' => 'string', 'example' => '2231.col2', ], 'OutputProjectId' => [ 'title' => '输出表所属项目Id', 'description' => '输出表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1233', ], 'OutputBizUnitId' => [ 'title' => '输出表所属业务板块Id', 'description' => '输出表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'OutputDataSourceId' => [ 'title' => '输出表所属数据源Id', 'description' => '输出表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'OutputDataSourceType' => [ 'title' => '输出表所属数据源类型', 'description' => '输出表所属数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputTableDeleted' => [ 'title' => '输出表是否已删除', 'description' => '输出表是否已删除', 'type' => 'boolean', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"TableColumnLineageList\\": [\\n {\\n \\"NodeId\\": \\"110021\\",\\n \\"NodeEnv\\": \\"dev\\",\\n \\"InputTableEnv\\": \\"dev\\",\\n \\"InputTableGuid\\": \\"123211\\",\\n \\"InputTableName\\": \\"t_input\\",\\n \\"InputColumnName\\": \\"col1\\",\\n \\"InputColumnGuid\\": \\"1121.col1\\",\\n \\"InputProjectId\\": 1233,\\n \\"InputBizUnitId\\": 1,\\n \\"InputDataSourceId\\": 1,\\n \\"InputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"InputTableDeleted\\": true,\\n \\"OutputTableEnv\\": \\"dev\\",\\n \\"OutputTableGuid\\": \\"2231\\",\\n \\"OutputTableName\\": \\"t_output\\",\\n \\"OutputColumnName\\": \\"col2\\",\\n \\"OutputColumnGuid\\": \\"2231.col2\\",\\n \\"OutputProjectId\\": 1233,\\n \\"OutputBizUnitId\\": 1,\\n \\"OutputDataSourceId\\": 1,\\n \\"OutputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"OutputTableDeleted\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资产表字段血缘信息', ], 'GetTableColumns' => [ 'summary' => '查询资产清单中Dataphin表的字段，支持表类型：维度逻辑表、事实逻辑表、汇总逻辑表、标签逻辑表、逻辑表视图、物理表、物理视图、物化视图表。'."\n" .'上线版本：v5.4.2。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Catalog', 'in' => 'query', 'schema' => [ 'title' => '资产表catalog: 业务板块或项目空间的名称', 'description' => '资产表catalog: 业务板块或项目空间的名称', 'type' => 'string', 'required' => true, 'example' => 'LD_test01_dev', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'required' => true, 'example' => 't_test01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ColumnList' => [ 'title' => '资产表列列表', 'description' => '资产表列列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Guid' => [ 'title' => '列Guid', 'description' => '列Guid', 'type' => 'string', 'example' => '1121.col1', ], 'Env' => [ 'title' => '所属环境：dev、prod', 'description' => '所属环境：dev、prod', 'type' => 'string', 'example' => 'dev', ], 'TableGuid' => [ 'title' => '表Guid', 'description' => '表Guid', 'type' => 'string', 'example' => '1121', ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3301', ], 'DataSourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 't_test', ], 'SeqNumber' => [ 'title' => '序号', 'description' => '序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'title' => '字段名', 'description' => '字段名', 'type' => 'string', 'example' => 'age', ], 'DisplayName' => [ 'title' => '字段展示名', 'description' => '字段展示名', 'type' => 'string', 'example' => '年龄', ], 'Comment' => [ 'title' => '字段注释', 'description' => '字段注释', 'type' => 'string', 'example' => 'test', ], 'DataType' => [ 'title' => '数据类型', 'description' => '数据类型', 'type' => 'string', 'example' => 'varchar', ], 'Nullable' => [ 'title' => '是否允许为空', 'description' => '是否允许为空', 'type' => 'boolean', ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'test', ], 'IsPrimaryKey' => [ 'title' => '是否主键', 'description' => '是否主键', 'type' => 'boolean', ], 'IsForeignKey' => [ 'title' => '是否外键', 'description' => '是否外键', 'type' => 'boolean', ], 'IsPartitionColumn' => [ 'title' => '是否分区键', 'description' => '是否分区键', 'type' => 'boolean', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '30012011', ], 'LastModifier' => [ 'title' => '最近更新者', 'description' => '最近更新者', 'type' => 'string', 'example' => '30012011', ], 'VisitCount30d' => [ 'title' => '最近30天查询', 'description' => '最近30天查询', 'type' => 'integer', 'format' => 'int64', 'example' => '99', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-06-30 00:00:00', ], 'ClassifyId' => [ 'title' => '数据分类Id', 'description' => '数据分类Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'ClassifyName' => [ 'title' => '数据分类名称', 'description' => '数据分类名称', 'type' => 'string', 'example' => 'test', ], 'LevelAbbreviation' => [ 'title' => '数据分级缩写', 'description' => '数据分级缩写', 'type' => 'string', 'example' => 'L1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ColumnList\\": [\\n {\\n \\"Guid\\": \\"1121.col1\\",\\n \\"Env\\": \\"dev\\",\\n \\"TableGuid\\": \\"1121\\",\\n \\"DataSourceId\\": 3301,\\n \\"DataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"TableName\\": \\"t_test\\",\\n \\"SeqNumber\\": 1,\\n \\"Name\\": \\"age\\",\\n \\"DisplayName\\": \\"年龄\\",\\n \\"Comment\\": \\"test\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"test\\",\\n \\"IsPrimaryKey\\": true,\\n \\"IsForeignKey\\": true,\\n \\"IsPartitionColumn\\": true,\\n \\"Creator\\": \\"30012011\\",\\n \\"LastModifier\\": \\"30012011\\",\\n \\"VisitCount30d\\": 99,\\n \\"CreateTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ModifyTime\\": \\"2025-06-30 00:00:00\\",\\n \\"ClassifyId\\": 12345,\\n \\"ClassifyName\\": \\"test\\",\\n \\"LevelAbbreviation\\": \\"L1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资产清单中Dataphin表的字段', ], 'CreateBizMetric' => [ 'summary' => '创建业务指标。'."\n" .'发布版本号：v5.5.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateBizMetricCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '创建请求', 'description' => '创建请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务指标名称，需要在租户内唯一。仅支持输入英文字母、数字及部分特殊符号(-_/\\·#$^&*()%+=)，最多256字符。', 'description' => '业务指标名称，需要在租户内唯一。仅支持输入英文字母、数字及部分特殊符号(-_/\\·#$^&*()%+=)，最多256字符。', 'type' => 'string', 'required' => true, 'example' => 'Metric1', 'maxLength' => 256, ], 'DisplayName' => [ 'title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'required' => false, 'example' => 'MetricDisplayName', 'maxLength' => 256, ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'MetricDesc', 'maxLength' => 1000, ], 'Labels' => [ 'title' => '资产标签', 'description' => '资产标签', 'type' => 'array', 'items' => [ 'description' => '资产标签', 'type' => 'string', 'required' => false, 'example' => 'Label1', ], 'required' => false, ], 'CatalogIds' => [ 'title' => '归属目录ID', 'description' => '归属目录ID', 'type' => 'array', 'items' => [ 'description' => '归属目录ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567890', ], 'required' => false, ], 'BizOwnerName' => [ 'title' => '业务负责人名称，请填写负责人账号的用户名', 'description' => '业务负责人名称，请填写负责人账号的用户名', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin', ], 'MetricDefinition' => [ 'title' => '指标口径，如需引用其他业务指标，请使用半角中括号[ ]包裹指标名称', 'description' => '指标口径，如需引用其他业务指标，请使用半角中括号[ ]包裹指标名称', 'type' => 'string', 'required' => false, 'example' => '[Metric1]+[Metric2]', 'maxLength' => 2000, ], 'RelatedBizMetrics' => [ 'title' => '相关业务指标列表，请填写相关业务指标名称及其关联关系', 'description' => '相关业务指标列表，请填写相关业务指标名称及其关联关系', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '指标名称', 'description' => '指标名称', 'type' => 'string', 'required' => false, 'example' => 'Metric2', ], 'RelationType' => [ 'title' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'description' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'type' => 'string', 'required' => false, 'example' => 'POSITIVE', 'enum' => [ 'POSITIVE', 'NEGATIVE', 'OTHER', ], ], ], 'required' => false, ], 'required' => false, ], 'AssociatedTechMetricFullNames' => [ 'title' => '关联技术指标全名列表。请填写技术指标的“所属表全名.指标名称”，其中“所属表全名”等于“资产来源.所属表名”。一个技术指标只能被一个业务指标关联，无法重复关联', 'description' => '关联技术指标全名列表。请填写技术指标的“所属表全名.指标名称”，其中“所属表全名”等于“资产来源.所属表名”。一个技术指标只能被一个业务指标关联，无法重复关联', 'type' => 'array', 'items' => [ 'description' => '关联技术指标全名', 'type' => 'string', 'required' => false, 'example' => 'LD_bizunit.table1.index1', ], 'required' => false, ], 'MetricRelationDiagramSwitchOpen' => [ 'title' => '指标关系图开关：true开启；false关闭。当且仅当至少有一个“相关业务指标”时可开启，否则会自动关闭', 'description' => '指标关系图开关：true开启；false关闭。当且仅当至少有一个“相关业务指标”时可开启，否则会自动关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'MetricRelationDiagramExpression' => [ 'title' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', 'description' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', 'type' => 'string', 'required' => false, 'example' => '[Metric1]+[Metric2]', ], 'OperateInstructionEnabled' => [ 'title' => '操作说明是否开启：true开启；false关闭', 'description' => '操作说明是否开启：true开启；false关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'OperateInstructionContent' => [ 'title' => '操作说明内容，仅支持文本格式', 'description' => '操作说明内容，仅支持文本格式', 'type' => 'string', 'required' => false, 'example' => 'content', ], 'ViewScope' => [ 'title' => '可见范围', 'description' => '可见范围', 'type' => 'object', 'properties' => [ 'ScopeType' => [ 'title' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'description' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'type' => 'string', 'required' => false, 'example' => 'PART_USERS_CAN_VIEW', 'enum' => [ 'ALL_USERS_CAN_VIEW', 'PART_USERS_CAN_VIEW', 'PART_USERS_CAN_NOT_VIEW', ], ], 'UserNames' => [ 'title' => '请填写个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'description' => '请填写个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'type' => 'array', 'items' => [ 'description' => '个人账号用户名', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin', ], 'required' => false, ], 'UserGroupNames' => [ 'title' => '请填写用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时会读取此信息', 'description' => '请填写用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时会读取此信息', 'type' => 'array', 'items' => [ 'description' => '用户组名称', 'type' => 'string', 'required' => false, 'example' => 'UserGroup1', ], 'required' => false, ], ], 'required' => false, ], 'CustomAttribute' => [ 'title' => '自定义属性', 'description' => '自定义属性', 'type' => 'array', 'items' => [ 'title' => '自定义属性列表，请分别填写属性的编码及属性值', 'description' => '自定义属性列表，请分别填写属性的编码及属性值', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '自定义属性编码', 'description' => '自定义属性编码', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeCode', ], 'Values' => [ 'title' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', 'description' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', 'type' => 'array', 'items' => [ 'title' => '自定义属性值', 'description' => '自定义属性值', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeValue', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'description' => '后端响应码', 'type' => 'string', 'example' => 'success', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => '是否创建成功：true成功；false失败', 'description' => '是否创建成功：true成功；false失败', 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'title' => '异常信息', 'description' => '异常信息', 'type' => 'string', 'example' => 'success', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n }\\n}","type":"json"}]', 'title' => '创建业务指标', ], 'UpdateBizMetric' => [ 'summary' => '更新业务指标。'."\n" .'发布版本号：v5.5.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'UpdateBizMetricCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '更新请求', 'description' => '更新请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '请输入需要更新的业务指标的名称', 'description' => '请输入需要更新的业务指标的名称', 'type' => 'string', 'required' => true, 'example' => 'Metric1', 'maxLength' => 256, ], 'NewName' => [ 'title' => '更新后的名称，当您需要修改指标名称时输入', 'description' => '更新后的名称，当您需要修改指标名称时输入', 'type' => 'string', 'required' => false, 'example' => 'Metric1_new', 'maxLength' => 256, ], 'DisplayName' => [ 'title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'required' => false, 'example' => 'Metric1_DisplayName', 'maxLength' => 256, ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'Metric Desc', 'maxLength' => 1000, ], 'Labels' => [ 'title' => '资产标签', 'description' => '资产标签', 'type' => 'array', 'items' => [ 'title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'Label', ], 'required' => false, ], 'CatalogIds' => [ 'title' => '归属目录ID列表', 'description' => '归属目录ID列表', 'type' => 'array', 'items' => [ 'title' => '归属目录ID', 'description' => '归属目录ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789', ], 'required' => false, ], 'BizOwnerName' => [ 'title' => '业务负责人，请填写负责人账号的用户名', 'description' => '业务负责人，请填写负责人账号的用户名', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin', ], 'MetricDefinition' => [ 'title' => '指标口径，如需引用其他业务指标，请使用半角中括号[ ]包裹指标名称', 'description' => '指标口径，如需引用其他业务指标，请使用半角中括号[ ]包裹指标名称', 'type' => 'string', 'required' => false, 'example' => '[Metric2]+[Metric3]', 'maxLength' => 2000, ], 'RelatedBizMetrics' => [ 'title' => '相关业务指标列表', 'description' => '相关业务指标列表', 'type' => 'array', 'items' => [ 'title' => '相关业务指标', 'description' => '相关业务指标', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务指标名称', 'description' => '业务指标名称', 'type' => 'string', 'required' => false, 'example' => 'Metric2', ], 'RelationType' => [ 'title' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'description' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'type' => 'string', 'required' => false, 'example' => 'POSITIVE', 'enum' => [ 'POSITIVE', 'NEGATIVE', 'OTHER', ], ], ], 'required' => false, ], 'required' => false, ], 'AssociatedTechMetricFullNames' => [ 'title' => '关联的技术指标列表。请填写技术指标的“所属表全名.指标名称”，其中“所属表全名”等于“资产来源.所属表名”。一个技术指标只能被一个业务指标关联，无法重复关联', 'description' => '关联的技术指标列表。请填写技术指标的“所属表全名.指标名称”，其中“所属表全名”等于“资产来源.所属表名”。一个技术指标只能被一个业务指标关联，无法重复关联', 'type' => 'array', 'items' => [ 'title' => '技术指标全名', 'description' => '技术指标全名', 'type' => 'string', 'required' => false, 'example' => 'LD_BizUnit.test_table.tech_index', ], 'required' => false, ], 'MetricRelationDiagramSwitchOpen' => [ 'title' => '指标关系图开关：true开启；false关闭。当且仅当至少有一个“相关业务指标”时可开启，否则会自动关闭', 'description' => '指标关系图开关：true开启；false关闭。当且仅当至少有一个“相关业务指标”时可开启，否则会自动关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'False', ], 'MetricRelationDiagramExpression' => [ 'title' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', 'description' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', 'type' => 'string', 'required' => false, 'example' => '[Metric1]+[Metric2]', ], 'OperateInstructionEnabled' => [ 'title' => '使用说明是否开启：true开启；false关闭', 'description' => '使用说明是否开启：true开启；false关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'False', ], 'OperateInstructionContent' => [ 'title' => '使用说明内容，仅支持文本格式', 'description' => '使用说明内容，仅支持文本格式', 'type' => 'string', 'required' => false, 'example' => 'content test', ], 'ViewScope' => [ 'title' => '可见范围', 'description' => '可见范围', 'type' => 'object', 'properties' => [ 'ScopeType' => [ 'title' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'description' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'type' => 'string', 'required' => false, 'example' => 'ALL_USERS_CAN_VIEW', 'enum' => [ 'ALL_USERS_CAN_VIEW', 'PART_USERS_CAN_VIEW', 'PART_USERS_CAN_NOT_VIEW', ], ], 'UserNames' => [ 'title' => '请填写个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'description' => '请填写个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'type' => 'array', 'items' => [ 'title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin', ], 'required' => false, 'maxItems' => 500, ], 'UserGroupNames' => [ 'title' => '请填写用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时会读取此信息', 'description' => '请填写用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时会读取此信息', 'type' => 'array', 'items' => [ 'title' => '用户组名称', 'description' => '用户组名称', 'type' => 'string', 'required' => false, 'example' => '运营用户组', ], 'required' => false, 'maxItems' => 500, ], ], 'required' => false, ], 'CustomAttribute' => [ 'title' => '自定义属性列表，请分别填写属性编码及属性值', 'description' => '自定义属性列表，请分别填写属性编码及属性值', 'type' => 'array', 'items' => [ 'title' => '自定义属性', 'description' => '自定义属性', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '自定义属性编码', 'description' => '自定义属性编码', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeCode', ], 'Values' => [ 'title' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', 'description' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', 'type' => 'array', 'items' => [ 'title' => '自定义属性值', 'description' => '自定义属性值', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeValue', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => '是否更新成功：true成功；false失败', 'description' => '是否更新成功：true成功；false失败', 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'title' => '异常信息', 'description' => '异常信息', 'type' => 'string', 'example' => 'npe', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"npe\\"\\n }\\n}","type":"json"}]', 'title' => '编辑业务指标', ], 'GetBizMetricByName' => [ 'summary' => '根据名称查询业务指标详情。'."\n" .'发布版本号：v5.5.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'BizMetricByNameQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '业务指标名称', 'description' => '业务指标名称', 'type' => 'string', 'required' => true, 'example' => 'Metric1', ], 'Draft' => [ 'title' => '查询草稿态或已发布资产详情：True草稿态；False已发布', 'description' => '查询草稿态或已发布资产详情：True草稿态；False已发布', 'type' => 'boolean', 'required' => true, 'example' => 'True', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'SUCCESS', ], 'Data' => [ 'title' => '业务指标详情', 'description' => '业务指标详情', 'type' => 'object', 'properties' => [ 'TenantId' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '30001011', ], 'Guid' => [ 'title' => '业务指标GUID', 'description' => '业务指标GUID', 'type' => 'string', 'example' => 'guid', ], 'Name' => [ 'title' => '业务指标名称', 'description' => '业务指标名称', 'type' => 'string', 'example' => 'Metric1', ], 'DisplayName' => [ 'title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'example' => 'Metric Display Name', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'Metric Desc', ], 'Labels' => [ 'title' => '标签列表', 'description' => '标签列表', 'type' => 'array', 'items' => [ 'title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => 'Label', ], ], 'Catalogs' => [ 'title' => '归属目录列表', 'description' => '归属目录列表', 'type' => 'array', 'items' => [ 'description' => '指标归属目录详情', 'type' => 'object', 'properties' => [ 'TopicId' => [ 'title' => '目录所属专题ID', 'description' => '目录所属专题ID', 'type' => 'integer', 'format' => 'int64', 'example' => '43297700', ], 'TopicName' => [ 'title' => '目录所属专题名称', 'description' => '目录所属专题名称', 'type' => 'string', 'example' => 'test topic', ], 'CatalogId' => [ 'title' => '目录ID', 'description' => '目录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1561740764851842', ], 'CatalogName' => [ 'title' => '目录名称', 'description' => '目录名称', 'type' => 'string', 'example' => 'test catalog', ], 'CatalogDesc' => [ 'title' => '目录描述', 'description' => '目录描述', 'type' => 'string', 'example' => 'catalog desc', ], 'ParentCatalogId' => [ 'title' => '目录所属父目录ID', 'description' => '目录所属父目录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1561740764851841', ], 'ParentPath' => [ 'title' => '目录所属父路径', 'description' => '目录所属父路径', 'type' => 'string', 'example' => '/catalog1/', ], ], ], ], 'BizOwnerName' => [ 'title' => '业务负责人名称', 'description' => '业务负责人名称', 'type' => 'string', 'example' => 'SuperAdmin', ], 'MetricDefinition' => [ 'title' => '指标口径', 'description' => '指标口径', 'type' => 'string', 'example' => '[Metric1]+[Metric2]', ], 'RelatedBizMetrics' => [ 'title' => '相关业务指标列表', 'description' => '相关业务指标列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '相关业务指标详情', 'type' => 'object', 'properties' => [ 'Guid' => [ 'title' => 'guid', 'description' => 'guid', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'Metric2', ], 'DisplayName' => [ 'title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'example' => 'display name', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'desc', ], 'RelationType' => [ 'title' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'description' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', 'type' => 'string', 'example' => 'POSITIVE', ], ], ], ], 'AssociatedTechMetrics' => [ 'title' => '关联技术指标列表', 'description' => '关联技术指标列表', 'type' => 'array', 'items' => [ 'description' => '关联的技术指标详情', 'type' => 'object', 'properties' => [ 'Guid' => [ 'title' => 'guid', 'description' => 'guid', 'type' => 'string', 'example' => 'table1.a.b', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'metric3', ], 'DisplayName' => [ 'title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'example' => 'display name', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'desc', ], 'SubType' => [ 'title' => '技术指标类型：INDEX建模指标；CUSTOM_INDEX自定义指标', 'description' => '技术指标类型：INDEX建模指标；CUSTOM_INDEX自定义指标', 'type' => 'string', 'example' => 'CUSTOM_INDEX', ], ], ], ], 'MetricRelationDiagramSwitchOpen' => [ 'title' => '指标关系图是否开启：true开启；false关闭', 'description' => '指标关系图是否开启：true开启；false关闭', 'type' => 'boolean', 'example' => 'true', ], 'MetricRelationDiagramExpression' => [ 'title' => '指标关系图表达式', 'description' => '指标关系图表达式', 'type' => 'string', 'example' => '[Metric2]*10', ], 'OperateInstructionEnabled' => [ 'title' => '使用说明是否开启：true开启；false关闭', 'description' => '使用说明是否开启：true开启；false关闭', 'type' => 'boolean', 'example' => 'true', ], 'OperateInstructionContent' => [ 'title' => '使用说明文本内容', 'description' => '使用说明文本内容', 'type' => 'string', 'example' => 'content', ], 'ViewScope' => [ 'title' => '可见范围', 'description' => '可见范围', 'type' => 'object', 'properties' => [ 'ScopeType' => [ 'title' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'description' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', 'type' => 'string', 'example' => 'PART_USERS_CAN_NOT_VIEW', 'enum' => [ 'ALL_USERS_CAN_VIEW', 'PART_USERS_CAN_VIEW', 'PART_USERS_CAN_NOT_VIEW', ], ], 'UserNames' => [ 'title' => '个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'description' => '个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', 'type' => 'array', 'items' => [ 'description' => '个人账号的用户名', 'type' => 'string', 'example' => 'SuperAdmin', ], ], 'UserGroupNames' => [ 'title' => '用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时生效', 'description' => '用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时生效', 'type' => 'array', 'items' => [ 'description' => '用户组名称', 'type' => 'string', 'example' => 'UserGroup1', ], ], ], ], 'CustomAttribute' => [ 'title' => '自定义属性列表', 'description' => '自定义属性列表', 'type' => 'array', 'items' => [ 'description' => '自定义属性项', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '自定义属性编码', 'description' => '自定义属性编码', 'type' => 'string', 'example' => 'CustomAttributeCode', ], 'Values' => [ 'title' => '属性值列表：1、自定义输入和下拉单选属性，取列表第一个属性值；2、下拉多选属性，取列表全部属性值；3、超链接属性，列表第一个属性值是展示文本，第二个属性值是跳转链接。', 'description' => '属性值列表：1、自定义输入和下拉单选属性，取列表第一个属性值；2、下拉多选属性，取列表全部属性值；3、超链接属性，列表第一个属性值是展示文本，第二个属性值是跳转链接。', 'type' => 'array', 'items' => [ 'title' => '自定义属性值', 'description' => '自定义属性值', 'type' => 'string', 'example' => 'CustomAttributeValue', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"TenantId\\": 30001011,\\n \\"Guid\\": \\"guid\\",\\n \\"Name\\": \\"Metric1\\",\\n \\"DisplayName\\": \\"Metric Display Name\\",\\n \\"Description\\": \\"Metric Desc\\",\\n \\"Labels\\": [\\n \\"Label\\"\\n ],\\n \\"Catalogs\\": [\\n {\\n \\"TopicId\\": 43297700,\\n \\"TopicName\\": \\"test topic\\",\\n \\"CatalogId\\": 1561740764851842,\\n \\"CatalogName\\": \\"test catalog\\",\\n \\"CatalogDesc\\": \\"catalog desc\\",\\n \\"ParentCatalogId\\": 1561740764851841,\\n \\"ParentPath\\": \\"/catalog1/\\"\\n }\\n ],\\n \\"BizOwnerName\\": \\"SuperAdmin\\",\\n \\"MetricDefinition\\": \\"[Metric1]+[Metric2]\\",\\n \\"RelatedBizMetrics\\": [\\n {\\n \\"Guid\\": \\"test\\",\\n \\"Name\\": \\"Metric2\\",\\n \\"DisplayName\\": \\"display name\\",\\n \\"Description\\": \\"desc\\",\\n \\"RelationType\\": \\"POSITIVE\\"\\n }\\n ],\\n \\"AssociatedTechMetrics\\": [\\n {\\n \\"Guid\\": \\"table1.a.b\\",\\n \\"Name\\": \\"metric3\\",\\n \\"DisplayName\\": \\"display name\\",\\n \\"Description\\": \\"desc\\",\\n \\"SubType\\": \\"CUSTOM_INDEX\\"\\n }\\n ],\\n \\"MetricRelationDiagramSwitchOpen\\": true,\\n \\"MetricRelationDiagramExpression\\": \\"[Metric2]*10\\",\\n \\"OperateInstructionEnabled\\": true,\\n \\"OperateInstructionContent\\": \\"content\\",\\n \\"ViewScope\\": {\\n \\"ScopeType\\": \\"PART_USERS_CAN_NOT_VIEW\\",\\n \\"UserNames\\": [\\n \\"SuperAdmin\\"\\n ],\\n \\"UserGroupNames\\": [\\n \\"UserGroup1\\"\\n ]\\n },\\n \\"CustomAttribute\\": [\\n {\\n \\"Code\\": \\"CustomAttributeCode\\",\\n \\"Values\\": [\\n \\"CustomAttributeValue\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '根据名称查询业务指标详情', ], 'DeleteBizMetric' => [ 'summary' => '删除业务指标。'."\n" .'发布版本号：v5.5.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteBizMetricCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '删除请求', 'description' => '删除请求', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '待删除的业务指标名称', 'description' => '待删除的业务指标名称', 'type' => 'string', 'required' => true, 'example' => 'Metric1', 'maxLength' => 256, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => '是否删除成功：true成功；false失败', 'description' => '是否删除成功：true成功；false失败', 'type' => 'boolean', 'example' => 'true', ], 'Message' => [ 'title' => '异常信息', 'description' => '异常信息', 'type' => 'string', 'example' => 'success', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n }\\n}","type":"json"}]', 'title' => '删除业务指标', ], 'DeleteRegisterLineage' => [ 'summary' => '删除注册血缘，上线版本 v5.4.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DeleteRegisterLineageCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '注册血缘, 删除血缘command', 'description' => '注册血缘, 删除血缘command', 'type' => 'object', 'properties' => [ 'Source' => [ 'title' => '血缘的source', 'description' => '血缘的source', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'MetadataSubType' => [ 'title' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'description' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL_TABLE, PHYSICAL_VIEW, PHYSICAL_MATERIALIZED_VIEW, DATASOURCE_TABLE, DATASOURCE_VIEW, DATASOURCE_MATERIALIZED_VIEW, DIM_NORMAL, DIM_LEVEL, DIM_ENUM, DIM_VIRTUAL, FACT_EVENT, FACT_PROCESS, FACT_SNAPSHOT, SUM_BIZ_UNIT', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'table1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'Target' => [ 'title' => '血缘的target', 'description' => '血缘的target', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'MetadataSubType' => [ 'title' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'description' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL_TABLE, PHYSICAL_VIEW, PHYSICAL_MATERIALIZED_VIEW, DATASOURCE_TABLE, DATASOURCE_VIEW, DATASOURCE_MATERIALIZED_VIEW, DIM_NORMAL, DIM_LEVEL, DIM_ENUM, DIM_VIRTUAL, FACT_EVENT, FACT_PROCESS, FACT_SNAPSHOT,SUM_BIZ_UNIT', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'table1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'DetailedLineages' => [ 'title' => '详细血缘关系. 对于表, 这里的详细血缘关系就是字段血缘', 'description' => '详细血缘关系. 对于表, 这里的详细血缘关系就是字段血缘', 'type' => 'array', 'items' => [ 'title' => '子对象血缘关系', 'description' => '子对象血缘关系', 'type' => 'object', 'properties' => [ 'IsDirect' => [ 'title' => '是否是直接血缘, 默认为true', 'description' => '是否是直接血缘, 默认为true', 'type' => 'boolean', 'required' => false, ], 'Source' => [ 'title' => 'source资产引用', 'description' => 'source资产引用', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => false, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'ParentGuid' => [ 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'description' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => false, 'example' => 'COLUMN', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'Target' => [ 'title' => 'target资产引用', 'description' => 'target资产引用', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => false, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'ParentGuid' => [ 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'description' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => false, 'example' => 'COLUMN', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], ], 'required' => false, ], 'required' => false, ], 'CascadeDeleteLineage' => [ 'title' => '是否在删除完所有detailedLineage后, 自动删除对象血缘, 默认为true', 'description' => '是否在删除完所有detailedLineage后, 自动删除对象血缘, 默认为true', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], 'TenantId' => [ 'title' => '租户Id', 'description' => '租户Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300001234', ], 'UserId' => [ 'title' => '当前用户Id', 'description' => '当前用户Id', 'type' => 'string', 'required' => false, 'example' => '300004567', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '删除注册血缘', 'extraInfo' => '上线版本：5.4.0', ], 'AddRegisterLineage' => [ 'summary' => '新增注册血缘，上线版本v5.4.0。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'AddRegisterLineageCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '注册血缘, 增加血缘command', 'description' => '注册血缘, 增加血缘command', 'type' => 'object', 'properties' => [ 'Source' => [ 'title' => 'source资产', 'description' => 'source资产', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'MetadataSubType' => [ 'title' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'description' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL_TABLE, PHYSICAL_VIEW, PHYSICAL_MATERIALIZED_VIEW, DATASOURCE_TABLE, DATASOURCE_VIEW, DATASOURCE_MATERIALIZED_VIEW, DIM_NORMAL, DIM_LEVEL, DIM_ENUM, DIM_VIRTUAL, FACT_EVENT, FACT_PROCESS, FACT_SNAPSHOT, SUM_BIZ_UNIT', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'table1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'Target' => [ 'title' => 'target资产', 'description' => 'target资产', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => true, 'example' => 'TABLE', ], 'MetadataSubType' => [ 'title' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'description' => '资产子类型, 仅在metadataType为TABLE, 并且referenceType不是BY_GUID时填写', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL_TABLE, PHYSICAL_VIEW, PHYSICAL_MATERIALIZED_VIEW, DATASOURCE_TABLE, DATASOURCE_VIEW, DATASOURCE_MATERIALIZED_VIEW, DIM_NORMAL, DIM_LEVEL, DIM_ENUM, DIM_VIRTUAL, FACT_EVENT, FACT_PROCESS, FACT_SNAPSHOT, SUM_BIZ_UNIT', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'table1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'DetailedLineages' => [ 'title' => '详细血缘关系. 对于表, 这里的详细血缘关系就是字段血缘, 如果不想增加字段血缘, 可以为空', 'description' => '详细血缘关系. 对于表, 这里的详细血缘关系就是字段血缘, 如果不想增加字段血缘, 可以为空', 'type' => 'array', 'items' => [ 'title' => '子对象血缘关系', 'description' => '子对象血缘关系', 'type' => 'object', 'properties' => [ 'Source' => [ 'title' => 'source资产引用', 'description' => 'source资产引用', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => false, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1.column1', ], 'ParentGuid' => [ 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'description' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => false, 'example' => 'COLUMN', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'Target' => [ 'title' => 'target资产引用', 'description' => 'target资产引用', 'type' => 'object', 'properties' => [ 'ReferenceType' => [ 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', 'description' => '资产引用类型: BY_GUID, BY_PROPERTY', 'type' => 'string', 'required' => false, 'example' => 'BY_GUID, BY_PROPERTY', ], 'Guid' => [ 'title' => '资产guid, 在referenceType为BY_GUID时必填', 'description' => '资产guid, 在referenceType为BY_GUID时必填', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1.column1', ], 'ParentGuid' => [ 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'description' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1', ], 'MetadataType' => [ 'title' => '资产类型, 按实际情况填写', 'description' => '资产类型, 按实际情况填写', 'type' => 'string', 'required' => false, 'example' => 'COLUMN', ], 'Catalog' => [ 'title' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'catalog, 资产属性. 对于表而言, 计算源表或者逻辑表的catalog统一为dataphin. 该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'dataphin', ], 'Schema' => [ 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1', ], 'Env' => [ 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD', ], 'Name' => [ 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'description' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', 'type' => 'string', 'required' => false, 'example' => 'column1', ], 'ExtProperties' => [ 'title' => '扩展属性', 'description' => '扩展属性', 'type' => 'object', 'required' => false, ], ], 'required' => true, ], 'IsDirect' => [ 'title' => '是否是直接血缘, 默认为true', 'description' => '是否是直接血缘, 默认为true', 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], 'required' => false, ], 'required' => false, ], 'CheckAssetExist' => [ 'title' => '是否需要校验资产本身的存在性, 默认不校验存在性', 'description' => '是否需要校验资产本身的存在性, 默认不校验存在性', 'type' => 'boolean', 'required' => false, ], 'RelationProperties' => [ 'title' => '血缘关系属性', 'description' => '血缘关系属性', 'type' => 'object', 'required' => false, ], 'TenantId' => [ 'title' => '租户Id', 'description' => '租户Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300001234', ], 'UserId' => [ 'title' => '当前用户Id', 'description' => '当前用户Id', 'type' => 'string', 'required' => false, 'example' => '300004567', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '新增注册血缘', 'extraInfo' => '上线版本：v5.4.0', ], 'GetTableLineageByTaskId' => [ 'summary' => '查询表血缘信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'TableLineageByTaskIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询表血缘的数据结构', 'description' => '查询表血缘的数据结构', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '用于过滤要查询的任务(节点)Id', 'description' => '用于过滤要查询的任务(节点)Id', 'type' => 'string', 'required' => true, 'example' => 'n_123', ], 'TaskEnv' => [ 'title' => '用于过滤要查询的任务所属的环境 DEV/PROD', 'description' => '用于过滤要查询的任务所属的环境 DEV/PROD', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], 'NeedNotExistObject' => [ 'title' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', 'description' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'array', 'items' => [ 'title' => '血缘详情', 'description' => '血缘详情', 'type' => 'object', 'properties' => [ 'TenantId' => [ 'title' => '租户id', 'description' => '租户id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'TaskId' => [ 'title' => '血缘对应的任务(节点)Id', 'description' => '血缘对应的任务(节点)Id', 'type' => 'string', 'example' => 'n_123', ], 'TaskEnv' => [ 'title' => '血缘对应的任务(节点)所属环境 DEV/PROD', 'description' => '血缘对应的任务(节点)所属环境 DEV/PROD', 'type' => 'string', 'example' => 'DEV', ], 'InputEnv' => [ 'title' => '输入表所属的env, DEV/PROD', 'description' => '输入表所属的env, DEV/PROD', 'type' => 'string', 'example' => 'DEV', ], 'InputTableId' => [ 'title' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', 'description' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" ."\n" .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', 'type' => 'string', 'example' => 'odps.123.test_project.order', ], 'InputTableName' => [ 'title' => '输入表名', 'description' => '输入表名', 'type' => 'string', 'example' => 'order', ], 'InputTableType' => [ 'title' => '输入表类型'."\n" .'- PHYSICAL_TABLE 物理表（计算源）'."\n" .'- DIM_LOGIC_TABLE 维度逻辑表'."\n" .'- FACT_LOGIC_TABLE 事实逻辑表'."\n" .'- SUM_LOGIC_TABLE 汇总逻辑表'."\n" .'- REAL_TIME_LOGIC_TABLE 实时元表'."\n" .'- REAL_TIME_MIRROR_TABLE 实时镜像表'."\n" .'- PHYSICAL_VIEW 物理视图'."\n" .'- LOGICAL_VIEW 逻辑视图'."\n" .'- DATA_SOURCE_PHYSICAL_TABLE 数据源表'."\n" .'- DATA_SOURCE_VIEW 数据源视图'."\n" .'- DATA_SOURCE_MATERIALIZED_VIEW 数据源物化视图', 'description' => '输入表类型 '."\n" ."\n" .'- PHYSICAL_TABLE 物理表（计算源）'."\n" .'- DIM_LOGIC_TABLE 维度逻辑表'."\n" .'- FACT_LOGIC_TABLE 事实逻辑表'."\n" .'- SUM_LOGIC_TABLE 汇总逻辑表'."\n" .'- REAL_TIME_LOGIC_TABLE 实时元表'."\n" .'- REAL_TIME_MIRROR_TABLE 实时镜像表'."\n" .'- PHYSICAL_VIEW 物理视图'."\n" .'- LOGICAL_VIEW 逻辑视图'."\n" .'- DATA_SOURCE_PHYSICAL_TABLE 数据源表'."\n" .'- DATA_SOURCE_VIEW 数据源视图'."\n" .'- DATA_SOURCE_MATERIALIZED_VIEW 数据源物化视图', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'InputDataSourceType' => [ 'title' => '输入表存储格式', 'description' => '输入表存储格式', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputDbType' => [ 'title' => '输入数据源类型', 'description' => '输入数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputProjectId' => [ 'title' => '输入表所属项目Id', 'description' => '输入表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputBizUnitId' => [ 'title' => '输入表所属业务板块Id', 'description' => '输入表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputDataSourceId' => [ 'title' => '输入表所属数据源Id', 'description' => '输入表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputTableDeleted' => [ 'title' => '输入表是否已删除', 'description' => '输入表是否已删除', 'type' => 'boolean', ], 'OutputTableType' => [ 'title' => '输出表类型, 枚举值见: InputTableType', 'description' => '输出表类型, 枚举值见:InputTableType', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'OutputEnv' => [ 'title' => '输出表所属的env, DEV/PROD', 'description' => '输出表所属的env, DEV/PROD', 'type' => 'string', 'example' => 'DEV/PROD', ], 'OutputBizUnitId' => [ 'title' => '输出表所属业务板块Id', 'description' => '输出表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputDataSourceType' => [ 'title' => '输出表存储格式', 'description' => '输出表存储格式', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputDbType' => [ 'title' => '输出数据源类型', 'description' => '输出数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputProjectId' => [ 'title' => '输出表所属项目Id', 'description' => '输出表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputDataSourceId' => [ 'title' => '输出表所属数据源Id', 'description' => '输出表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputTableId' => [ 'title' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', 'description' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', 'type' => 'string', 'example' => 'odps.123.test_project.order', ], 'OutputTableName' => [ 'title' => '输出表名', 'description' => '输出表名', 'type' => 'string', 'example' => 'order', ], 'OutputTableDeleted' => [ 'title' => '输出表是否已删除', 'description' => '输出表是否已删除', 'type' => 'boolean', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"TenantId\\": 12345,\\n \\"TaskId\\": \\"n_123\\",\\n \\"TaskEnv\\": \\"DEV\\",\\n \\"InputEnv\\": \\"DEV\\",\\n \\"InputTableId\\": \\"odps.123.test_project.order\\",\\n \\"InputTableName\\": \\"order\\",\\n \\"InputTableType\\": \\"PHYSICAL_TABLE\\",\\n \\"InputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"InputDbType\\": \\"MAX_COMPUTE\\",\\n \\"InputProjectId\\": 123,\\n \\"InputBizUnitId\\": 123,\\n \\"InputDataSourceId\\": 123,\\n \\"InputTableDeleted\\": true,\\n \\"OutputTableType\\": \\"PHYSICAL_TABLE\\",\\n \\"OutputEnv\\": \\"DEV/PROD\\",\\n \\"OutputBizUnitId\\": 123,\\n \\"OutputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"OutputDbType\\": \\"MAX_COMPUTE\\",\\n \\"OutputProjectId\\": 123,\\n \\"OutputDataSourceId\\": 123,\\n \\"OutputTableId\\": \\"odps.123.test_project.order\\",\\n \\"OutputTableName\\": \\"order\\",\\n \\"OutputTableDeleted\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '表血缘查询', 'extraInfo' => '接口上线版本：v5.1.0', ], 'GetTableColumnLineageByTaskId' => [ 'summary' => '查询表字段血缘信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'TableColumnLineageByTaskIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询表字段血缘的数据结构', 'description' => '查询表字段血缘的数据结构', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '用于过滤要查询的任务(节点)Id', 'description' => '用于过滤要查询的任务(节点)Id', 'type' => 'string', 'required' => true, 'example' => 'n_123', ], 'TaskEnv' => [ 'title' => '用于过滤要查询的任务所属的环境 DEV/PROD', 'description' => '用于过滤要查询的任务所属的环境 DEV/PROD', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'DEV', ], 'NeedNotExistObject' => [ 'title' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', 'description' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'array', 'items' => [ 'title' => '血缘详情', 'description' => '血缘详情', 'type' => 'object', 'properties' => [ 'TenantId' => [ 'title' => '租户id', 'description' => '租户id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'TaskId' => [ 'title' => '血缘对应的任务(节点)Id', 'description' => '血缘对应的任务(节点)Id', 'type' => 'string', 'example' => 'n_123', ], 'TaskEnv' => [ 'title' => '血缘对应的任务(节点)所属环境 DEV/PROD', 'description' => '血缘对应的任务(节点)所属环境 DEV/PROD', 'type' => 'string', 'example' => 'DEV', ], 'InputEnv' => [ 'title' => '输入表所属的env, DEV/PROD', 'description' => '输入表所属的env, DEV/PROD', 'type' => 'string', 'example' => 'DEV', ], 'InputTableId' => [ 'title' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', 'description' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" ."\n" .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', 'type' => 'string', 'example' => 'odps.123.test_project.order', ], 'InputTableName' => [ 'title' => '输入表名', 'description' => '输入表名', 'type' => 'string', 'example' => 'order', ], 'InputColumnId' => [ 'title' => '输入字段guid', 'description' => '输入字段guid', 'type' => 'string', 'example' => 'odps.123.test_project.input_table.id', ], 'InputColumnName' => [ 'title' => '输入字段名', 'description' => '输入字段名', 'type' => 'string', 'example' => 'id', ], 'InputTableType' => [ 'title' => '输入表类型'."\n" .'- PHYSICAL_TABLE 物理表（计算源）'."\n" .'- DIM_LOGIC_TABLE 维度逻辑表'."\n" .'- FACT_LOGIC_TABLE 事实逻辑表'."\n" .'- SUM_LOGIC_TABLE 汇总逻辑表'."\n" .'- REAL_TIME_LOGIC_TABLE 实时元表'."\n" .'- REAL_TIME_MIRROR_TABLE 实时镜像表'."\n" .'- PHYSICAL_VIEW 物理视图'."\n" .'- LOGICAL_VIEW 逻辑视图'."\n" .'- DATA_SOURCE_PHYSICAL_TABLE 数据源表'."\n" .'- DATA_SOURCE_VIEW 数据源视图'."\n" .'- DATA_SOURCE_MATERIALIZED_VIEW 数据源物化视图', 'description' => '输入表类型'."\n" .'- PHYSICAL_TABLE 物理表（计算源）'."\n" .'- DIM_LOGIC_TABLE 维度逻辑表'."\n" .'- FACT_LOGIC_TABLE 事实逻辑表'."\n" .'- SUM_LOGIC_TABLE 汇总逻辑表'."\n" .'- REAL_TIME_LOGIC_TABLE 实时元表'."\n" .'- REAL_TIME_MIRROR_TABLE 实时镜像表'."\n" .'- PHYSICAL_VIEW 物理视图'."\n" .'- LOGICAL_VIEW 逻辑视图'."\n" .'- DATA_SOURCE_PHYSICAL_TABLE 数据源表'."\n" .'- DATA_SOURCE_VIEW 数据源视图'."\n" .'- DATA_SOURCE_MATERIALIZED_VIEW 数据源物化视图', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'InputDataSourceType' => [ 'title' => '输入表存储格式', 'description' => '输入表存储格式', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputDbType' => [ 'title' => '输入数据源类型', 'description' => '输入数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'InputProjectId' => [ 'title' => '输入表所属项目Id', 'description' => '输入表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputBizUnitId' => [ 'title' => '输入表所属业务板块Id', 'description' => '输入表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputDataSourceId' => [ 'title' => '输入表所属数据源Id', 'description' => '输入表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InputTableDeleted' => [ 'title' => '输入表是否已删除', 'description' => '输入表是否已删除', 'type' => 'boolean', ], 'OutputTableType' => [ 'title' => '输出表类型, 枚举值见: InputTableType', 'description' => '输出表类型, 枚举值见: InputTableType', 'type' => 'string', 'example' => 'PHYSICAL_TABLE', ], 'OutputEnv' => [ 'title' => '输出表所属的env, DEV/PROD', 'description' => '输出表所属的env, DEV/PROD', 'type' => 'string', 'example' => 'DEV', ], 'OutputBizUnitId' => [ 'title' => '输出表所属业务板块Id', 'description' => '输出表所属业务板块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputDataSourceType' => [ 'title' => '输出表存储格式', 'description' => '输出表存储格式', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputDbType' => [ 'title' => '输出数据源类型', 'description' => '输出数据源类型', 'type' => 'string', 'example' => 'MAX_COMPUTE', ], 'OutputProjectId' => [ 'title' => '输出表所属项目Id', 'description' => '输出表所属项目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputDataSourceId' => [ 'title' => '输出表所属数据源Id', 'description' => '输出表所属数据源Id', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'OutputTableId' => [ 'title' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', 'description' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', 'type' => 'string', 'example' => 'odps.123.test_project.order', ], 'OutputTableName' => [ 'title' => '输出表名', 'description' => '输出表名', 'type' => 'string', 'example' => 'order', ], 'OutputColumnId' => [ 'title' => '输出字段guid', 'description' => '输出字段guid', 'type' => 'string', 'example' => 'odps.123.test_project.input_table.id', ], 'OutputColumnName' => [ 'title' => '输出字段名', 'description' => '输出字段名', 'type' => 'string', 'example' => 'id', ], 'OutputTableDeleted' => [ 'title' => '输出表是否已删除', 'description' => '输出表是否已删除', 'type' => 'boolean', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"TenantId\\": 12345,\\n \\"TaskId\\": \\"n_123\\",\\n \\"TaskEnv\\": \\"DEV\\",\\n \\"InputEnv\\": \\"DEV\\",\\n \\"InputTableId\\": \\"odps.123.test_project.order\\",\\n \\"InputTableName\\": \\"order\\",\\n \\"InputColumnId\\": \\"odps.123.test_project.input_table.id\\",\\n \\"InputColumnName\\": \\"id\\",\\n \\"InputTableType\\": \\"PHYSICAL_TABLE\\",\\n \\"InputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"InputDbType\\": \\"MAX_COMPUTE\\",\\n \\"InputProjectId\\": 123,\\n \\"InputBizUnitId\\": 123,\\n \\"InputDataSourceId\\": 123,\\n \\"InputTableDeleted\\": true,\\n \\"OutputTableType\\": \\"PHYSICAL_TABLE\\",\\n \\"OutputEnv\\": \\"DEV\\",\\n \\"OutputBizUnitId\\": 123,\\n \\"OutputDataSourceType\\": \\"MAX_COMPUTE\\",\\n \\"OutputDbType\\": \\"MAX_COMPUTE\\",\\n \\"OutputProjectId\\": 123,\\n \\"OutputDataSourceId\\": 123,\\n \\"OutputTableId\\": \\"odps.123.test_project.order\\",\\n \\"OutputTableName\\": \\"order\\",\\n \\"OutputColumnId\\": \\"odps.123.test_project.input_table.id\\",\\n \\"OutputColumnName\\": \\"id\\",\\n \\"OutputTableDeleted\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '表字段血缘查询', 'extraInfo' => '接口上线版本：v5.1.0', ], 'GetInstanceUpDownStream' => [ 'summary' => '查询实例的上下游，支持逻辑表和代码任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '中心节点', 'description' => '中心节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例id/', 'description' => '实例id/', 'type' => 'string', 'required' => true, 'example' => 't_123456', ], 'FieldInstanceIdList' => [ 'title' => '当节点时逻辑表实例id时可以传，不传默认是全表', 'description' => '字段ID列表：当节点是逻辑表实例id时可以传，不传默认是全表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '字段ID', 'type' => 'string', 'required' => false, 'example' => '123', ], 'required' => false, ], ], 'required' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1001121', ], ], [ 'name' => 'UpStreamDepth', 'in' => 'query', 'schema' => [ 'title' => '上游节点层级，默认：1', 'description' => '上游节点层级，默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DownStreamDepth', 'in' => 'query', 'schema' => [ 'title' => '下游节点层级，默认：1', 'description' => '下游节点层级，默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'InstanceDagInfo' => [ 'title' => '实例上下游数据，包含当前实例，以及上下游实例', 'description' => '实例上下游数据，包含当前实例，以及上下游实例', 'type' => 'object', 'properties' => [ 'StartInstanceList' => [ 'title' => '中心实例', 'description' => '中心实例', 'type' => 'array', 'items' => [ 'title' => '中心实例', 'description' => '中心实例', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_1234567', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_1234567', ], 'NodeType' => [ 'title' => '节点类型'."\n" .'DATA_PROCESS：代码任务'."\n" .'BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'ONE_ID_LABEL：萃取标签节点'."\n" .'ONE_ID_RULE：萃取标签节点'."\n" .'PIPELINE_NODE：PIPELINE节点', 'description' => '节点类型'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：逻辑表节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldInstanceIdList' => [ 'title' => '字段ID列表', 'description' => '字段ID列表', 'type' => 'array', 'items' => [ 'description' => '字段ID', 'type' => 'string', 'example' => '1011', ], ], ], ], ], 'UpInstanceList' => [ 'title' => '上游实例', 'description' => '上游实例', 'type' => 'array', 'items' => [ 'title' => '上游实例', 'description' => '上游实例', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_1234567', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_1234567', ], 'NodeType' => [ 'title' => '节点类型', 'description' => '节点类型', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldInstanceIdList' => [ 'title' => '字段ID列表', 'description' => '字段ID列表', 'type' => 'array', 'items' => [ 'description' => '字段ID', 'type' => 'string', 'example' => '1021', ], ], ], ], ], 'DownInstanceList' => [ 'title' => '下游实例', 'description' => '下游实例', 'type' => 'array', 'items' => [ 'title' => '下游实例', 'description' => '下游实例', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_1234567', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_1234567', ], 'NodeType' => [ 'title' => '节点类型', 'description' => '节点类型', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldInstanceIdList' => [ 'title' => '字段ID列表', 'description' => '字段ID列表', 'type' => 'array', 'items' => [ 'description' => '字段ID', 'type' => 'string', 'example' => '1031', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"InstanceDagInfo\\": {\\n \\"StartInstanceList\\": [\\n {\\n \\"Id\\": \\"t_1234567\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"NodeId\\": \\"n_1234567\\",\\n \\"NodeType\\": \\"DATA_PROCESS\\",\\n \\"FieldInstanceIdList\\": [\\n \\"1011\\"\\n ]\\n }\\n ],\\n \\"UpInstanceList\\": [\\n {\\n \\"Id\\": \\"t_1234567\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"NodeId\\": \\"n_1234567\\",\\n \\"NodeType\\": \\"DATA_PROCESS\\",\\n \\"FieldInstanceIdList\\": [\\n \\"1021\\"\\n ]\\n }\\n ],\\n \\"DownInstanceList\\": [\\n {\\n \\"Id\\": \\"t_1234567\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"NodeId\\": \\"n_1234567\\",\\n \\"NodeType\\": \\"DATA_PROCESS\\",\\n \\"FieldInstanceIdList\\": [\\n \\"1031\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询实例的上下游', ], 'GetInstanceDownStream' => [ 'summary' => '根据起始的实例查询该实例的下游。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'InstanceGet', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '获取请求', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 't_5929472_20210411_9577721', ], 'NodeType' => [ 'title' => '实例的节点类型：'."\n" .'BBOX_LOGIC_TABLE_NODE,'."\n" .'BBOX_LOGIC_FIELD_NODE,'."\n" .'BBOX_LOGIC_FIELD_GROUP_NODE,'."\n" .'BBOX_INNER_TEMP_NODE,'."\n" .'DATA_PROCESS,'."\n" .'STREAM_TASK_NODE,'."\n" .'ONE_ID_LABEL,'."\n" .'ONE_ID_RULE,'."\n" .'ONE_ID_SYSTEM,PIPELINE_NODE,'."\n" .'FLINK_BATCH', 'description' => '实例的节点类型'."\n" .'- BBOX_LOGIC_TABLE_NODE'."\n" .'- BBOX_LOGIC_FIELD_NODE'."\n" .'- BBOX_LOGIC_FIELD_GROUP_NODE'."\n" .'- BBOX_INNER_TEMP_NODE'."\n" .'- DATA_PROCESS'."\n" .'- STREAM_TASK_NODE'."\n" .'- FLINK_BATCH', 'type' => 'string', 'required' => true, 'example' => 'DATA_PROCESS', ], ], 'required' => true, ], ], [ 'name' => 'RunStatus', 'in' => 'query', 'schema' => [ 'title' => '实例的运行状态'."\n" .'INIT、WATING、RUNNING、SUCCESS、FAILED', 'description' => '实例的运行状态'."\n" .'- INIT'."\n" .'- WATING'."\n" .'- RUNNING'."\n" .'- SUCCESS'."\n" .'- FAILED', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', ], ], [ 'name' => 'DownStreamDepth', 'in' => 'query', 'schema' => [ 'title' => '查询的dag向下展开的层数，允许值1~6', 'description' => '查询的dag向下展开的层数，允许值1~6', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'InstanceRelationList' => [ 'title' => '下游及依赖关系'."\n", 'description' => '下游及依赖关系'."\n", 'type' => 'array', 'items' => [ 'title' => '下游及依赖关系', 'description' => '下游及依赖关系', 'type' => 'object', 'properties' => [ 'InstanceInfo' => [ 'title' => '实力信息', 'description' => '实力信息', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_232411', ], 'Name' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型', 'description' => '节点类型', 'type' => 'string', 'example' => 'DATA_PROCESS', ], ], ], 'SelectStatus' => [ 'title' => '实例选择状态,主要用于逻辑字段'."\n" .'OPTIONAL可选'."\n" .'SELECTED 必选'."\n" .'DISABLE 不可选'."\n" .'GROUP_SELECTED 全选或全不选', 'description' => '实例选择状态，主要用于逻辑字段'."\n" .'- OPTIONAL可选'."\n" .'- SELECTED 必选'."\n" .'- DISABLE 不可选'."\n" .'- GROUP_SELECTED 全选或全不选', 'type' => 'string', 'example' => 'OPTIONAL', ], 'SelectStatusCause' => [ 'title' => '实例被选中原因'."\n" .'PK_CHANGE, LOGIC_CHANGE, RELATION, BIZ_RELATION,MV_RELATION,MODEL_REFRESH,FIELD_DELETED,FIELD_ADDED_NO_INSTANCE,PERMISSION_DENY,OUTSIDE_INCOMING, INSTANCE_STATUS,AFFECT_BY_UPSTREAM', 'description' => '实例被选中原因'."\n" .'- PK_CHANGE'."\n" .'- LOGIC_CHANGE'."\n" .'- RELATION'."\n" .'- BIZ_RELATIO'."\n" .'- MV_RELATION'."\n" .'- MODEL_REFRESH'."\n" .'- FIELD_DELETED'."\n" .'- FIELD_ADDED_NO_INSTANCE'."\n" .'- PERMISSION_DENY'."\n" .'- OUTSIDE_INCOMING'."\n" .'- INSTANCE_STATUS'."\n" .'- AFFECT_BY_UPSTREAM', 'type' => 'string', 'example' => 'FIELD_DELETED', ], 'RunStatus' => [ 'title' => '实例运行状态'."\n" .'INIT、WATING、RUNNING、SUCCESS、FAILED', 'description' => '实例运行状态', 'type' => 'string', 'example' => 'RUNNING', ], 'FieldInstanceList' => [ 'description' => '字段实例列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SelectStatus' => [ 'description' => '实例选择状态', 'type' => 'string', 'example' => 'OPTIONAL', ], 'FieldInstanceId' => [ 'description' => '字段实例ID', 'type' => 'string', 'example' => 't_23211', ], 'RunStatus' => [ 'description' => '运行状态', 'type' => 'string', 'example' => 'SUCCESS', ], ], ], ], 'DownStreamDepth' => [ 'title' => '层级', 'description' => '层级', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExtendInfo' => [ 'title' => '节点实例扩展信息', 'description' => '节点实例扩展信息', 'type' => 'string', 'example' => '{"a":"x"}', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"InstanceRelationList\\": [\\n {\\n \\"InstanceInfo\\": {\\n \\"Id\\": \\"t_232411\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\"\\n },\\n \\"SelectStatus\\": \\"OPTIONAL\\",\\n \\"SelectStatusCause\\": \\"FIELD_DELETED\\",\\n \\"RunStatus\\": \\"RUNNING\\",\\n \\"FieldInstanceList\\": [\\n {\\n \\"SelectStatus\\": \\"OPTIONAL\\",\\n \\"FieldInstanceId\\": \\"t_23211\\",\\n \\"RunStatus\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"DownStreamDepth\\": 1,\\n \\"ExtendInfo\\": \\"{\\\\\\"a\\\\\\":\\\\\\"x\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取实例下游实例列表', ], 'GetSupplementDagrunInstance' => [ 'summary' => '列出补数据工作流下具体一个业务日期的所有节点的实例。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'DagrunId', 'in' => 'query', 'schema' => [ 'title' => 'Dagrun ID', 'description' => 'Dagrun ID', 'type' => 'string', 'required' => true, 'example' => 'dr_2242792_14542', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'InstanceList' => [ 'title' => '实例列表', 'description' => '实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'description' => '实例详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_239496_20210411_246982077481', ], 'Type' => [ 'title' => '实例类型'."\n" .'NORMAL：周期实例、'."\n" .'SUPPLEMENT：补数据实例'."\n" .'MANUAL：手动实例', 'description' => '实例类型'."\n" ."\n" .'- NORMAL：周期实例、'."\n" .'- SUPPLEMENT：补数据实例'."\n" .'- MANUAL：手动实例', 'type' => 'string', 'example' => 'SUPPLEMENT', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-01', ], 'DueTime' => [ 'title' => '调度日期', 'description' => '调度日期', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-02', ], 'StatusList' => [ 'title' => '实例的状态列表，物理实例列表中只会有一个状态'."\n" .'NIT：初始化'."\n" .'WATING：待运行'."\n" .'RUNNING：运行中'."\n" .'SUCCESS：成功'."\n" .'FAILED：失败', 'description' => '实例的状态列表，物理实例列表中只会有一个状态'."\n" ."\n" .'- NIT：初始化'."\n" .'- WATING：待运行'."\n" .'- RUNNING：运行中'."\n" .'- SUCCESS：成功'."\n" .'- FAILED：失败', 'type' => 'array', 'items' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'SUCCESS', ], ], 'StartExecuteTime' => [ 'title' => '开始执行时间', 'description' => '开始执行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-12 00:00:00', ], 'EndExecuteTime' => [ 'title' => '结束执行时间', 'description' => '结束执行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-12 00:25:02', ], 'Duration' => [ 'title' => '执行时间，单位：秒 ', 'description' => '执行时间，单位：秒 ', 'type' => 'string', 'example' => '60', ], 'Index' => [ 'title' => '小时/分钟实例序号', 'description' => '小时/分钟实例序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExtendInfo' => [ 'title' => '扩展信息'."\n" .'不同业务系统实例的特有信息，例如pipeline的fileId，逻辑表是否层级维度以及mid节点信息，实例输出名', 'description' => '扩展信息'."\n" .'不同业务系统实例的特有信息，例如pipeline的fileId，逻辑表是否层级维度以及mid节点信息，实例输出名', 'type' => 'string', 'example' => '{"a":"b"}', ], 'NodeInfo' => [ 'title' => '实例对应节点详情', 'description' => '实例对应节点详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_239496', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型'."\n" .'DATA_PROCESS：代码任务'."\n" .'BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'ONE_ID_LABEL：萃取标签节点'."\n" .'ONE_ID_RULE：萃取标签节点'."\n" .'PIPELINE_NODE：PIPELINE节点', 'description' => '节点类型'."\n" ."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'- ONE_ID_LABEL：萃取标签节点'."\n" .'- ONE_ID_RULE：萃取标签节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'From' => [ 'title' => '来源业务系统'."\n" .'DATA_PROCESS：代码研发'."\n" .'BLACK_BOX：黑盒'."\n" .'ONE_ID：萃取'."\n" .'PIPELINE：PIPELINE', 'description' => '来源业务系统'."\n" ."\n" .'- DATA_PROCESS：代码研发'."\n" .'- BLACK_BOX：黑盒'."\n" .'- ONE_ID：萃取'."\n" .'- PIPELINE：PIPELINE', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'SubDetailType' => [ 'title' => '节点子类型', 'description' => '节点子类型', 'type' => 'string', 'example' => 'SHELL', ], 'Description' => [ 'title' => '节点描述', 'description' => '节点描述', 'type' => 'string', 'example' => 'xx测试', ], 'DryRun' => [ 'title' => '是否空跑', 'description' => '是否空跑', 'type' => 'boolean', 'example' => 'true', ], 'SchedulePaused' => [ 'title' => '是否暂停', 'description' => '是否暂停', 'type' => 'boolean', 'example' => 'true', ], 'HasProd' => [ 'title' => '是否存在生产环境', 'description' => '是否存在生产环境', 'type' => 'boolean', 'example' => 'true', ], 'HasDev' => [ 'title' => '是否存在开发环境', 'description' => '是否存在开发环境', 'type' => 'boolean', 'example' => 'true', ], 'ResourceGroupList' => [ 'title' => '资源组', 'description' => '资源组', 'type' => 'array', 'items' => [ 'title' => '资源组', 'description' => '资源组', 'type' => 'string', 'example' => 'rs_group_test', ], ], 'PriorityList' => [ 'title' => '优先级'."\n" .'HIGHEST'."\n" .'HIGH'."\n" .'MIDDLE'."\n" .'LOW'."\n" .'LOWEST', 'description' => '优先级'."\n" ."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'array', 'items' => [ 'title' => '优先级', 'description' => '优先级', 'type' => 'string', 'example' => 'MIDDLE', ], ], 'SchedulePeriodList' => [ 'title' => '调度周期'."\n" .'MINUTELY'."\n" .'HOURLY'."\n" .'DAILY'."\n" .'WEEKLY'."\n" .'MONTHLY'."\n" .'QUARTERLY', 'description' => '调度周期'."\n" ."\n" .'- MINUTELY'."\n" .'- HOURLY'."\n" .'- DAILY'."\n" .'- WEEKLY'."\n" .'- MONTHLY'."\n" .'- QUARTERLY', 'type' => 'array', 'items' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'string', 'example' => 'DAILY', ], ], 'BizUnitName' => [ 'title' => '业务板块', 'description' => '业务板块', 'type' => 'string', 'example' => 'xx测试', ], 'Creator' => [ 'title' => '节点创建者', 'description' => '节点创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '1001012', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Modifier' => [ 'title' => '修改者', 'description' => '修改者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '1001012', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'OwnerList' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'array', 'items' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '1001012', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-30 10:08:49', ], 'LastModifiedTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-01-30 10:08:49', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"InstanceList\\": [\\n {\\n \\"Id\\": \\"t_239496_20210411_246982077481\\",\\n \\"Type\\": \\"SUPPLEMENT\\",\\n \\"BizDate\\": 0,\\n \\"DueTime\\": 0,\\n \\"StatusList\\": [\\n \\"SUCCESS\\"\\n ],\\n \\"StartExecuteTime\\": 0,\\n \\"EndExecuteTime\\": 0,\\n \\"Duration\\": \\"60\\",\\n \\"Index\\": 1,\\n \\"ExtendInfo\\": \\"{\\\\\\"a\\\\\\":\\\\\\"b\\\\\\"}\\",\\n \\"NodeInfo\\": {\\n \\"Id\\": \\"n_239496\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"From\\": \\"DATA_PROCESS\\",\\n \\"SubDetailType\\": \\"SHELL\\",\\n \\"Description\\": \\"xx测试\\",\\n \\"DryRun\\": true,\\n \\"SchedulePaused\\": true,\\n \\"HasProd\\": true,\\n \\"HasDev\\": true,\\n \\"ResourceGroupList\\": [\\n \\"rs_group_test\\"\\n ],\\n \\"PriorityList\\": [\\n \\"MIDDLE\\"\\n ],\\n \\"SchedulePeriodList\\": [\\n \\"DAILY\\"\\n ],\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"Creator\\": {\\n \\"Id\\": \\"1001012\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Modifier\\": {\\n \\"Id\\": \\"1001012\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"1001012\\",\\n \\"Name\\": \\"xx测试\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-01-30 10:08:49\\",\\n \\"LastModifiedTime\\": \\"2024-01-30 10:08:49\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取补数据工作流Dagrun下实例列表', ], 'GetPhysicalInstance' => [ 'summary' => '获取实例信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 't_23231', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2323131', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '● 环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '● 环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Instance' => [ 'title' => '实例详情', 'description' => '实例详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_23231', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2023-06-25', ], 'DueTime' => [ 'title' => '调度时间', 'description' => '调度时间', 'type' => 'string', 'example' => '2023-06-27 00:30:00', ], 'StatusList' => [ 'title' => '状态列表', 'description' => '状态列表', 'type' => 'array', 'items' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'SUCCESS', ], ], 'StartExecuteTime' => [ 'title' => '开始运行时间', 'description' => '开始运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-27 01:30:00', ], 'EndExecuteTime' => [ 'title' => '结束运行时间', 'description' => '结束运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-27 02:30:00', ], 'Duration' => [ 'title' => '运行耗时', 'description' => '运行耗时', 'type' => 'string', 'example' => '3600s', ], 'Index' => [ 'title' => '运行实例序号', 'description' => '运行实例序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeInfo' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_3232312', ], 'From' => [ 'title' => '节点来源系统', 'description' => '节点来源系统', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'Type' => [ 'title' => '节点类型', 'description' => '节点类型'."\n" .'- BBOX_LOGIC_TABLE_NODE：逻辑表节点'."\n" .'- BBOX_LOGIC_FIELD_NODE：逻辑字段节点'."\n" .'- BBOX_LOGIC_FIELD_GROUP_NODE：字段组节点'."\n" .'- BBOX_INNER_TEMP_NODE：逻辑表temp节点'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- STREAM_TASK_NODE：实时任务'."\n" .'- PIPELINE_NODE：PIPELINE节点'."\n" .'- FLINK_BATCH：flink批任务'."\n" .'- ODM_NODE：ODM节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'SubDetailType' => [ 'title' => '子业务类型', 'description' => '子业务类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL', 'type' => 'string', 'example' => 'SHELL', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx 测试', ], 'DryRun' => [ 'title' => '是否空跑', 'description' => '是否空跑', 'type' => 'boolean', 'example' => 'false', ], 'SchedulePaused' => [ 'title' => '是否暂停调度', 'description' => '是否暂停调度', 'type' => 'boolean', 'example' => 'false', ], 'HasProd' => [ 'title' => '是否有生产环境', 'description' => '是否有生产环境', 'type' => 'boolean', 'example' => 'true', ], 'HasDev' => [ 'title' => '是否有开发环境', 'description' => '是否有开发环境', 'type' => 'boolean', 'example' => 'true', ], 'PriorityList' => [ 'title' => '优先级', 'description' => '优先级'."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'array', 'items' => [ 'title' => '优先级', 'description' => '优先级', 'type' => 'string', 'example' => 'MIDDLE', ], ], 'ResourceGroupList' => [ 'title' => '资源组', 'description' => '资源组', 'type' => 'array', 'items' => [ 'title' => '资源组', 'description' => '资源组', 'type' => 'string', 'example' => 'rs_group_test', ], ], 'SchedulePeriodList' => [ 'title' => '调度周期', 'description' => '调度周期'."\n" .'- YEARLY'."\n" .'- MONTHLY'."\n" .'- WEEKLY'."\n" .'- DAILY'."\n" .'- HOURLY'."\n" .'- MINUTELY', 'type' => 'array', 'items' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'string', 'example' => 'DAILY', ], ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'xx', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '2323111', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'Modifier' => [ 'title' => '编辑者', 'description' => '编辑者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '2323111', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'zhangsan', ], ], ], 'OwnerList' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'array', 'items' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '2323111', ], 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'zhangsan', ], ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-02-02 23:53:17', ], 'LastModifiedTime' => [ 'title' => '编辑时间', 'description' => '编辑时间', 'type' => 'string', 'example' => '2024-02-02 23:53:17', ], ], ], 'ExtendInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => 'xx', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Instance\\": {\\n \\"Id\\": \\"t_23231\\",\\n \\"BizDate\\": \\"2023-06-25\\",\\n \\"DueTime\\": \\"2023-06-27 00:30:00\\",\\n \\"StatusList\\": [\\n \\"SUCCESS\\"\\n ],\\n \\"StartExecuteTime\\": 0,\\n \\"EndExecuteTime\\": 0,\\n \\"Duration\\": \\"3600s\\",\\n \\"Index\\": 1,\\n \\"NodeInfo\\": {\\n \\"Id\\": \\"n_3232312\\",\\n \\"From\\": \\"DATA_PROCESS\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"SubDetailType\\": \\"SHELL\\",\\n \\"Description\\": \\"xx 测试\\",\\n \\"DryRun\\": false,\\n \\"SchedulePaused\\": false,\\n \\"HasProd\\": true,\\n \\"HasDev\\": true,\\n \\"PriorityList\\": [\\n \\"MIDDLE\\"\\n ],\\n \\"ResourceGroupList\\": [\\n \\"rs_group_test\\"\\n ],\\n \\"SchedulePeriodList\\": [\\n \\"DAILY\\"\\n ],\\n \\"BizUnitName\\": \\"xx\\",\\n \\"Creator\\": {\\n \\"Id\\": \\"2323111\\",\\n \\"Name\\": \\"zhangsan\\"\\n },\\n \\"Modifier\\": {\\n \\"Id\\": \\"2323111\\",\\n \\"Name\\": \\"zhangsan\\"\\n },\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"2323111\\",\\n \\"Name\\": \\"zhangsan\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-02-02 23:53:17\\",\\n \\"LastModifiedTime\\": \\"2024-02-02 23:53:17\\"\\n },\\n \\"ExtendInfo\\": \\"xx\\"\\n }\\n}","type":"json"}]', 'title' => '获取实例信息', ], 'ListInstances' => [ 'summary' => '分页查询实例。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => 'n_23131', ], 'RunStatusList' => [ 'title' => 'INIT(初始化)、WAIT_SUBMISSION(等待提交)、WAIT_SCHEDULE(等待调度时间)、DISPATCH_BLOCKED(限流中)、WAIT_RESOURCE(等待调度资源)、RUNNING(运行中)、SUCCESS(成功)、FAILED(失败) ', 'description' => '运行状态'."\n" .'- INIT：初始化'."\n" .'- WAIT_SUBMISSION：等待提交'."\n" .'- WAIT_SCHEDULE：等待调度时间'."\n" .'- DISPATCH_BLOCKED：限流中'."\n" .'- WAIT_RESOURCE：等待调度资源'."\n" .'- RUNNING：运行中'."\n" .'- SUCCESS：成功'."\n" .'- FAILED：失败', 'type' => 'array', 'items' => [ 'title' => '允许状态', 'description' => '运行状态', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], 'required' => false, ], 'MinBizDate' => [ 'title' => '开始业务日期时间，时间格式须符合业务板块指定的分区格式', 'description' => '开始业务日期时间，时间格式须符合业务板块指定的分区格式', 'type' => 'string', 'required' => false, 'example' => '2024-05-30', ], 'MaxBizDate' => [ 'title' => '截止业务日期时间，时间格式须符合业务板块指定的分区格式'."\n", 'description' => '截止业务日期时间，时间格式须符合业务板块指定的分区格式'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-05-31', ], 'BizType' => [ 'title' => '业务类型', 'description' => '业务类型'."\n" ."\n" .'- SCRIPT：脚本实例'."\n" .'- LOGICAL_TABLE：逻辑表', 'type' => 'string', 'required' => false, 'example' => 'SCRIPT', ], 'SubBizTypeList' => [ 'title' => '子业务类型', 'description' => '子业务类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL', 'type' => 'array', 'items' => [ 'description' => '子业务类型', 'type' => 'string', 'required' => false, 'example' => 'SHELL', ], 'required' => false, ], 'SchedulePeriodList' => [ 'title' => '调度周期', 'description' => '调度周期'."\n" .'- YEARLY'."\n" .'- MONTHLY'."\n" .'- WEEKLY'."\n" .'- DAILY'."\n" .'- HOURLY'."\n" .'- MINUTELY', 'type' => 'array', 'items' => [ 'description' => '调度周期', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'required' => false, ], 'OwnerList' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'array', 'items' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'required' => false, 'example' => '123131', ], 'required' => false, ], 'PriorityList' => [ 'title' => '优先级', 'description' => '优先级'."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'array', 'items' => [ 'description' => '优先级', 'type' => 'string', 'required' => false, 'example' => 'MIDDLE', ], 'required' => false, ], 'SchedulePaused' => [ 'title' => '是否暂停调度', 'description' => '是否暂停调度', 'type' => 'boolean', 'required' => false, ], 'MinRunDate' => [ 'title' => '实例运行日期', 'description' => '最小实例运行时间', 'type' => 'string', 'required' => false, 'example' => '2024-05-30', ], 'MaxRunDate' => [ 'title' => '实例运行日期', 'description' => '最大实例运行时间', 'type' => 'string', 'required' => false, 'example' => '2024-05-31', ], 'ScheduleType' => [ 'title' => '实例调度类型'."\n" .'NORMAL（周期实例）'."\n" .'MANUAL（手动实例）', 'description' => '实例调度类型'."\n" .'- NORMAL（周期实例）'."\n" .'- MANUAL（手动实例）', 'type' => 'string', 'required' => true, 'example' => 'NORMAL', ], 'SearchText' => [ 'title' => '节点名称模糊匹配或节点ID精确匹配', 'description' => '节点名称模糊匹配或节点ID精确匹配', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131311111321', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'BizUnitId' => [ 'title' => '业务板块id，查询汇总逻辑表时需要传入', 'description' => '业务板块id，查询汇总逻辑表时需要传入', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6232322111', ], 'FlowId' => [ 'title' => '任务流Id', 'description' => '任务流Id', 'type' => 'string', 'required' => false, 'example' => '1021', ], ], 'required' => false, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'description' => '分页结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '107', ], 'Data' => [ 'description' => '分页记录', 'type' => 'array', 'items' => [ 'description' => '实例信息', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_23231', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2024-05-30', ], 'DueTime' => [ 'title' => '调度时间', 'description' => '调度时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'StatusList' => [ 'title' => '实例状态', 'description' => '实例状态', 'type' => 'array', 'items' => [ 'description' => '实例状态', 'type' => 'string', 'example' => 'RUNNING', ], ], 'StartExecuteTime' => [ 'title' => '运行', 'description' => '执行开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-05-30 16:46:13', ], 'EndExecuteTime' => [ 'title' => '执行结束时间', 'description' => '执行结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-05-30 16:47:13'."\n", ], 'Duration' => [ 'title' => '运行耗时，单位：秒', 'description' => '运行耗时，单位：秒', 'type' => 'string', 'example' => '60s', ], 'Index' => [ 'title' => '小时分钟实例序号', 'description' => '小时分钟实例序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeInfo' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_132331', ], 'From' => [ 'title' => '节点来源', 'description' => '节点来源', 'type' => 'string', 'example' => 'DATA_PROCES', ], 'Type' => [ 'title' => '节点业务类型', 'description' => '节点业务类型'."\n" .'- SCRIPT：脚本'."\n" .'- LOGICAL_TABLE：逻辑表', 'type' => 'string', 'example' => 'DATA_PROCES', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试'."\n", ], 'SubDetailType' => [ 'title' => '子业务类型', 'description' => '子业务类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL', 'type' => 'string', 'example' => 'SHELL', ], 'Description' => [ 'title' => '节点描述', 'description' => '节点描述', 'type' => 'string', 'example' => 'xx 测试', ], 'DryRun' => [ 'title' => '是否空跑', 'description' => '是否空跑', 'type' => 'boolean', 'example' => 'false', ], 'SchedulePaused' => [ 'title' => '是否暂停调度', 'description' => '是否暂停调度', 'type' => 'boolean', 'example' => 'false', ], 'HasProd' => [ 'title' => '是否有生产环境', 'description' => '是否有生产环境', 'type' => 'boolean', 'example' => 'true', ], 'HasDev' => [ 'title' => '是否有开发环境', 'description' => '是否有开发环境', 'type' => 'boolean', 'example' => 'false', ], 'PriorityList' => [ 'description' => '优先级'."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'array', 'items' => [ 'description' => '优先级', 'type' => 'string', 'example' => 'MIDDLE', ], ], 'ResourceGroupList' => [ 'title' => '运行资源组', 'description' => '运行资源组', 'type' => 'array', 'items' => [ 'description' => '资源组', 'type' => 'string', 'example' => 'rs_group_test', ], ], 'SchedulePeriodList' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'array', 'items' => [ 'description' => '调度周期'."\n" .'- YEARLY'."\n" .'- MONTHLY'."\n" .'- WEEKLY'."\n" .'- DAILY'."\n" .'- HOURLY'."\n" .'- MINUTELY', 'type' => 'string', 'example' => 'DAILY', ], ], 'BizUnitName' => [ 'title' => '业务板块', 'description' => '业务板块', 'type' => 'string', 'example' => 'xx测试', ], 'Creator' => [ 'title' => '节点创建人', 'description' => '节点创建人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '21313112', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Modifier' => [ 'title' => '编辑人', 'description' => '编辑人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户名', 'type' => 'string', 'example' => '21313112', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'OwnerList' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '21313112', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'LastModifiedTime' => [ 'title' => '编辑时间', 'description' => '编辑时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13'."\n", ], ], ], 'ExtendInfo' => [ 'title' => '节点扩展信息：不同业务系统实例的特有信息，例如pipeline的fileId，逻辑表是否层级维度以及mid节点信息，实例输出名 ', 'description' => '节点扩展信息：不同业务系统实例的特有信息，例如pipeline的fileId，逻辑表是否层级维度以及mid节点信息，实例输出名 ', 'type' => 'string', 'example' => 'xx', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 107,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"t_23231\\",\\n \\"BizDate\\": \\"2024-05-30\\",\\n \\"DueTime\\": \\"2024-05-30 16:47:13\\",\\n \\"StatusList\\": [\\n \\"RUNNING\\"\\n ],\\n \\"StartExecuteTime\\": 0,\\n \\"EndExecuteTime\\": 0,\\n \\"Duration\\": \\"60s\\",\\n \\"Index\\": 1,\\n \\"NodeInfo\\": {\\n \\"Id\\": \\"n_132331\\",\\n \\"From\\": \\"DATA_PROCES\\",\\n \\"Type\\": \\"DATA_PROCES\\",\\n \\"Name\\": \\"xx测试\\\\n\\",\\n \\"SubDetailType\\": \\"SHELL\\",\\n \\"Description\\": \\"xx 测试\\",\\n \\"DryRun\\": false,\\n \\"SchedulePaused\\": false,\\n \\"HasProd\\": true,\\n \\"HasDev\\": false,\\n \\"PriorityList\\": [\\n \\"MIDDLE\\"\\n ],\\n \\"ResourceGroupList\\": [\\n \\"rs_group_test\\"\\n ],\\n \\"SchedulePeriodList\\": [\\n \\"DAILY\\"\\n ],\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"Creator\\": {\\n \\"Id\\": \\"21313112\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Modifier\\": {\\n \\"Id\\": \\"21313112\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"21313112\\",\\n \\"Name\\": \\"xx测试\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-05-30 16:47:13\\",\\n \\"LastModifiedTime\\": \\"2024-05-30 16:47:13\\\\n\\"\\n },\\n \\"ExtendInfo\\": \\"xx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取实例列表', ], 'OperateInstance' => [ 'summary' => '批量运维实例，支持物理实例和逻辑表实例。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'OperateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '操作请求', 'description' => '操作请求', 'type' => 'object', 'properties' => [ 'InstanceIdList' => [ 'title' => '运维实例列表', 'description' => '运维实例列表', 'type' => 'array', 'items' => [ 'description' => '运维实例', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 't_32111312', ], 'FieldInstanceIdList' => [ 'description' => '字段实例ID', 'type' => 'array', 'items' => [ 'description' => '字段实例ID', 'type' => 'string', 'required' => false, 'example' => 't_2311', ], 'required' => false, ], ], 'required' => true, ], 'required' => true, ], 'Operation' => [ 'title' => '操作 '."\n" .'RERUN:重跑/PAUSE:暂停/RESUME:恢复/TERMINATE:终止/SET_SUCCESS:置为成功', 'description' => '操作 '."\n" .'- RERUN:重跑'."\n" .'- PAUSE:暂停'."\n" .'- RESUME:恢复'."\n" .'- TERMINATE:终止'."\n" .'- SET_SUCCESS:置为成功', 'type' => 'string', 'required' => true, 'example' => 'RERUN', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '132311', ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'InstanceStatusList' => [ 'title' => '实例运维结果', 'description' => '实例运维结果', 'type' => 'array', 'items' => [ 'description' => '实例运维结果', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 't_132435', ], 'Name' => [ 'title' => '实例名', 'description' => '实例名', 'type' => 'string', 'example' => 'xx测试', ], 'DisplayName' => [ 'title' => '实例显示名', 'description' => '实例显示名', 'type' => 'string', 'example' => 'xx测试', ], 'Status' => [ 'title' => '操作的结果，成功或者失败', 'description' => '操作的结果，成功或者失败', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMessage' => [ 'title' => '操作失败时的错误信息', 'description' => '操作失败时的错误信息', 'type' => 'string', 'example' => 'xx', ], 'OwnerId' => [ 'title' => '实例负责人', 'description' => '实例负责人', 'type' => 'string', 'example' => '121311', ], 'OwnerName' => [ 'title' => '实例负责人', 'description' => '实例负责人', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"InstanceStatusList\\": [\\n {\\n \\"Id\\": \\"t_132435\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"DisplayName\\": \\"xx测试\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"OwnerId\\": \\"121311\\",\\n \\"OwnerName\\": \\"xx测试\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '实例运维', ], 'FixData' => [ 'summary' => '重跑下游(修复链路数据), 支持强制重跑下游；影响范围：会产生计算成本、影响数据产出。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'FixDataCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '重跑下游(修复链路数据),可以选择强制重跑', 'description' => '重跑下游(修复链路数据),可以选择强制重跑', 'type' => 'object', 'properties' => [ 'RootInstanceId' => [ 'title' => '根实例', 'description' => '根实例', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 't_2323111', ], 'FieldInstanceIdList' => [ 'title' => '当节点时逻辑表实例id时可以传，不传默认是全表', 'description' => '字段ID：当节点是逻辑表实例id时可以传，不传默认是全表', 'type' => 'array', 'items' => [ 'description' => '字段ID', 'type' => 'string', 'required' => false, 'example' => '121', ], 'required' => false, ], ], 'required' => true, ], 'DownStreamInstanceIdList' => [ 'title' => '下游实例(如果选择了下游范围，则此处可不传，否则需要传入下游实例列表) ', 'description' => '下游实例(如果选择了下游范围，则此处可不传，否则需要传入下游实例列表) ', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 't_2323421', ], 'FieldInstanceIdList' => [ 'description' => '字段实例ID', 'type' => 'array', 'items' => [ 'description' => '字段实例ID', 'type' => 'string', 'required' => false, 'example' => 't_2311', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'ContainRootInstance' => [ 'title' => '根实例是否重跑，不选默认为是', 'description' => '根实例是否重跑，不选默认为是', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'DownstreamRange' => [ 'title' => '下游范围(快捷选项：ALL_FAILED_INSTANCE:所有失败实例; ALL_INSTANCE: 所有实例; ALL_FINAL_INSTANCE: 所有终态实例;) 不传默认需要根据传入的下游进行重跑', 'description' => '下游范围'."\n" .'- ALL_FAILED_INSTANCE:所有失败实例'."\n" .'- ALL_INSTANCE: 所有实例'."\n" .'- ALL_FINAL_INSTANCE: 所有终态实例'."\n" .'- 不传默认需要根据传入的下游进行重跑', 'type' => 'string', 'required' => false, 'example' => 'ALL_INSTANCE', ], 'ForceRerun' => [ 'title' => '释放强制重跑', 'description' => '是否强制重跑', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '132344', ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'SubmitId' => [ 'title' => '本次提交的提交id，如果选择downstreamRange为快捷模式，则此处会返回提交id，需要通过提交状态查询接口([QueryOperationSubmitJobStatus])，查询本次提交的状态。人为选择下游实例可忽略该返回', 'description' => '本次提交的提交ID', 'type' => 'string', 'example' => '12324234', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitId\\": \\"12324234\\"\\n}","type":"json"}]', 'title' => '修复性数据重跑', ], 'ExecuteTriggerNode' => [ 'summary' => '运行触发式节点。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'string', 'required' => true, 'example' => 'n_12345678', ], ], [ 'name' => 'BizDate', 'in' => 'query', 'schema' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'required' => true, 'example' => '2025-06-01', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10110201', ], ], [ 'name' => 'Index', 'in' => 'query', 'schema' => [ 'title' => '如果节点ID为小时或分钟节点，一天会有多个实例，index代表实例的序号', 'description' => '如果节点ID为小时或分钟节点，一天会有多个实例，index代表实例的序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '开发或生产环境：DEV 开发、PROD 生产，默认PROD', 'description' => '开发或生产环境：DEV 开发、PROD 生产，默认PROD', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '运行触发式节点', ], 'CreateNodeSupplement' => [ 'summary' => '通用补数据接口，支持列表模式补数据和海量模式补数据：'."\n" .'1.会生成补数据实例运行，影响相关表数据产出。'."\n" .'2.会进行任务运行，造成计算的费用以及存储的费用。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '新建补数据请求', 'description' => '新建补数据请求', 'type' => 'object', 'properties' => [ 'NodeIdList' => [ 'title' => '补数据的根节点，支持多个根节点', 'description' => '补数据的根节点，支持多个根节点', 'type' => 'array', 'items' => [ 'title' => '根节点', 'description' => '根节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_1232324', ], 'FieldIdList' => [ 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', 'description' => '字段ID列表：当节点是逻辑表节点ID时可以传，不传默认是全表', 'type' => 'array', 'items' => [ 'description' => '字段ID', 'type' => 'string', 'required' => false, 'example' => '1201', ], 'required' => false, ], ], 'required' => true, ], 'required' => true, ], 'StartBizDate' => [ 'title' => '起始业务日期 ', 'description' => '起始业务日期 ', 'type' => 'string', 'required' => true, 'example' => '2024-05-21', ], 'EndBizDate' => [ 'title' => '截止业务日期 ', 'description' => '截止业务日期 ', 'type' => 'string', 'required' => true, 'example' => '2024-05-21', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101121', ], 'Name' => [ 'title' => '补数据名称，不传时系统生成', 'description' => '补数据名称，不传时系统生成', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'DownStreamNodeIdList' => [ 'title' => '下游节点ID，指定下游节点运行；'."\n" .'ContainAllDownStream = false 时生效', 'description' => '下游节点ID，指定下游节点运行', 'type' => 'array', 'items' => [ 'title' => '根节点', 'description' => '节点ID', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => '2323232', ], 'FieldIdList' => [ 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', 'description' => '字段ID', 'type' => 'array', 'items' => [ 'description' => '字段iD', 'type' => 'string', 'required' => false, 'example' => '232322211', ], 'required' => false, ], ], 'required' => false, 'example' => 'n_23243', ], 'required' => false, ], 'ContainAllDownStream' => [ 'title' => '海量模式：包含所有下游，默认为false ', 'description' => '海量模式：包含所有下游，默认为false ', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'FilterList' => [ 'title' => '过滤器，和ContainAllDownStream搭配使用，可以根据项目，节点等进行正选和反选，默认为空', 'description' => '过滤器列表：和ContainAllDownStream搭配使用，可以根据项目，节点等进行正选和反选，默认为空', 'type' => 'array', 'items' => [ 'description' => '过滤器', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '筛选键，支持：'."\n" .'- PROJECT: 项目'."\n" .'- NODE_OUTPUT_NAME: 节点输出名'."\n" .'- NODE_NAME: 节点名称'."\n" .'- NODE_ID: 节点ID'."\n" .'- TARGETS: 指定终点'."\n" .'- SOURCES:指定起点', 'type' => 'string', 'required' => false, 'example' => 'NODE_OUTPUT_NAME', ], 'ValueList' => [ 'description' => '过滤值列表', 'type' => 'array', 'items' => [ 'description' => '过滤值', 'type' => 'string', 'required' => false, 'example' => 'xxtest', ], 'required' => false, ], 'Exclude' => [ 'description' => '是否反选，默认：false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'required' => false, ], 'Parallelism' => [ 'title' => '并发数，默认为1', 'description' => '并发数，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'MinDueTime' => [ 'title' => '最早调起时间(HH:MM)，小时任务专用', 'description' => '最早调起时间(HH:MM)，小时任务专用', 'type' => 'string', 'required' => false, 'example' => '00:00', ], 'MaxDueTime' => [ 'title' => '最晚调起时间(HH:MM)，小时任务专用', 'description' => '最晚调起时间(HH:MM)，小时任务专用', 'type' => 'string', 'required' => false, 'example' => '20:59', ], 'GlobalParamList' => [ 'title' => '运行时全局参数', 'description' => '运行时全局参数', 'type' => 'array', 'items' => [ 'description' => '参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '参数', 'type' => 'string', 'required' => false, 'example' => 'param1', ], 'Value' => [ 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], 'required' => false, ], 'required' => false, ], 'NodeParamsList' => [ 'title' => '运行时自定义参数, 按照节点进行配置', 'description' => '运行时自定义参数, 按照节点进行配置', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeId' => [ 'description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => 'n_23324', ], 'ParamList' => [ 'description' => '参数列表', 'type' => 'array', 'items' => [ 'description' => '参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '参数', 'type' => 'string', 'required' => false, 'example' => 'param1', ], 'Value' => [ 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true/false', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'SubmitId' => [ 'title' => '如果是普通模式，返回的是flowId; 如果是海量模式，返回提交的jobId，可以根据GetOperationSubmitStatus 查询提交的状态，提交成功后会返回flowId', 'description' => '- 普通模式:返回的是FlowId'."\n" .'- 海量模式，返回提交的JobId，可以根据GetOperationSubmitStatus查询任务提交的状态，提交成功后会返回FlowId', 'type' => 'string', 'example' => 'f_2264518792396800000_20210223_2329354897145659392', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitId\\": \\"f_2264518792396800000_20210223_2329354897145659392\\"\\n}","type":"json"}]', 'title' => '通用补数据接口', ], 'PausePhysicalNode' => [ 'summary' => '暂停物理节点调度，会暂停任务的调度，下游任务将无法调起，暂时仅支持离线代码任务及集成任务。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PauseCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '暂停调度请求', 'description' => '暂停调度请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13222210', ], 'NodeIdList' => [ 'title' => '节点ID列表', 'description' => '节点ID列表', 'type' => 'array', 'items' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_2311121', ], 'required' => true, ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeOperateResultList' => [ 'title' => '节点暂停调度操作结果', 'description' => '节点暂停调度操作结果', 'type' => 'array', 'items' => [ 'title' => '节点暂停调度操作结果', 'description' => '节点暂停调度操作结果', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_123456', ], 'Status' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMessage' => [ 'title' => '操作失败时，异常信息提示', 'description' => '操作失败时，异常信息提示', 'type' => 'string', 'example' => 'xx ', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeOperateResultList\\": [\\n {\\n \\"NodeId\\": \\"n_123456\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"ErrorMessage\\": \\"xx \\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '暂停物理节点调度', ], 'GetOperationSubmitStatus' => [ 'summary' => '查询补数据提交的状态。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'title' => '海量模式下提交后返回的jobId', 'description' => '海量模式下提交后返回的jobId', 'type' => 'string', 'required' => true, 'example' => '1324444131', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'OperationSubmitJob' => [ 'title' => '操作提交的状态', 'description' => '操作提交的状态', 'type' => 'object', 'properties' => [ 'JobId' => [ 'title' => '补数据的提交id', 'description' => '补数据的提交id', 'type' => 'string', 'example' => '123456', ], 'Progress' => [ 'title' => '进度 ', 'description' => '进度 ', 'type' => 'string', 'example' => '80', ], 'Operation' => [ 'title' => '操作类型'."\n" .'SUPPLY_DATA：补数据'."\n" .'UPDATE_OWNER：修改责任人'."\n" .'UPDATE_PRIORITY：修改优先级'."\n" .'UPDATE_TASK_GROUP：修改任务组'."\n" .'UPDATE_RESOURCE_GROUP：修改资源组'."\n" .'PAUSE：暂停'."\n" .'RESUME：恢复'."\n" .'TRIGGER_EXECUTE：触发执行', 'description' => '操作类型'."\n" .'- SUPPLY_DATA：补数据', 'type' => 'string', 'example' => 'SUPPLY_DATA', ], 'OperationStatus' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'ExternalBizId' => [ 'title' => '业务id，如果是补数据操作则为补数据工作流', 'description' => '业务id，如果是补数据操作则为补数据工作流', 'type' => 'string', 'example' => 'f_122_232342', ], 'Operator' => [ 'title' => '提交人用户ID', 'description' => '提交人用户ID', 'type' => 'string', 'example' => '132344', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"OperationSubmitJob\\": {\\n \\"JobId\\": \\"123456\\",\\n \\"Progress\\": \\"80\\",\\n \\"Operation\\": \\"SUPPLY_DATA\\",\\n \\"OperationStatus\\": \\"SUCCESS\\",\\n \\"ExternalBizId\\": \\"f_122_232342\\",\\n \\"Operator\\": \\"132344\\"\\n }\\n}","type":"json"}]', 'title' => '获取补数据工作流提交状态', ], 'GetPhysicalInstanceLog' => [ 'summary' => '获取实例执行的日志，如果实例重跑了多次，则会有多条日志。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 't_5929472_20210411_9577721', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123131', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'TaskrunLogList' => [ 'title' => '实例所有的执行日志. 包含实例多次重跑的日志', 'description' => '实例所有的执行日志. 包含实例多次重跑的日志', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskrunId' => [ 'title' => '每一次运行的任务ID', 'description' => '每一次运行的任务ID', 'type' => 'string', 'example' => 'tr_23231', ], 'StartTime' => [ 'title' => '任务开始运行时间', 'description' => '任务开始运行时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'EndTime' => [ 'title' => '任务结束运行时间', 'description' => '任务结束运行时间', 'type' => 'string', 'example' => '2024-05-30 16:48:13', ], 'LogContent' => [ 'title' => '运行日志，如果未运行则为空', 'description' => '运行日志，如果未运行则为空', 'type' => 'string', 'example' => 'xx', ], 'Status' => [ 'title' => 'INIT、WAITING、RUNNING、SUCCESS、FAILED', 'description' => '运行状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'Duration' => [ 'title' => '任务执行耗时，单位：秒', 'description' => '任务执行耗时，单位：秒', 'type' => 'string', 'example' => '60s', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskrunLogList\\": [\\n {\\n \\"TaskrunId\\": \\"tr_23231\\",\\n \\"StartTime\\": \\"2024-05-30 16:47:13\\",\\n \\"EndTime\\": \\"2024-05-30 16:48:13\\",\\n \\"LogContent\\": \\"xx\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Duration\\": \\"60s\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取实例执行日志', ], 'GetSupplementDagrun' => [ 'summary' => '获取补数据工作流所有业务日期的Dagrun信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'SupplementId', 'in' => 'query', 'schema' => [ 'title' => '补数据工作流ID', 'description' => '补数据ID', 'type' => 'string', 'required' => true, 'example' => 'f_8241792_20201202_2099680', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'DagrunList' => [ 'title' => 'Dagrun列表', 'description' => 'Dagrun列表', 'type' => 'array', 'items' => [ 'title' => 'Dagrun详情', 'description' => 'Dagrun详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Dagrun ID', 'description' => 'Dagrun ID', 'type' => 'string', 'example' => 'dr_2242792_14542', ], 'BizDate' => [ 'title' => '业务日期，时间格式须符合业务板块指定的分区格式', 'description' => '业务日期，时间格式须符合业务板块指定的分区格式', 'type' => 'string', 'example' => '2024-04-01', ], 'Status' => [ 'title' => '补数工作流状态：'."\n" .'INIT：dagrun初始化'."\n" .'CREATE_FAILED：dagrun创建失败'."\n" .'CREATED：dagrun创建成功'."\n" .'READY：dagrun准备好可以执行'."\n" .'RUNNING：dagrun运行中'."\n" .'KILLED：dagrun运行中止'."\n" .'FAILED：dagrun运行失败'."\n" .'SUCCESS：dagrun运行成功', 'description' => '补数工作流状态：'."\n" ."\n" .'- INIT：dagrun初始化'."\n" .'- CREATE_FAILED：dagrun创建失败'."\n" .'- CREATED：dagrun创建成功'."\n" .'- READY：dagrun准备好可以执行'."\n" .'- RUNNING：dagrun运行中'."\n" .'- KILLED：dagrun运行中止'."\n" .'- FAILED：dagrun运行失败'."\n" .'- SUCCESS：dagrun运行成功', 'type' => 'string', 'example' => 'RUNNING', ], 'StartExecuteTime' => [ 'title' => '执行起始时间戳', 'description' => '执行起始时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1717081729000', ], 'EndExecuteTime' => [ 'title' => '执行终止时间戳', 'description' => '执行终止时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1717081789000', ], 'SupplementId' => [ 'title' => '补数工作流Id', 'description' => '补数工作流Id', 'type' => 'string', 'example' => 'f_8241792_20201202_2099680', ], 'Duration' => [ 'title' => '部署工作流运行时长', 'description' => '运行时长，单位：秒', 'type' => 'string', 'example' => '60s', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"DagrunList\\": [\\n {\\n \\"Id\\": \\"dr_2242792_14542\\",\\n \\"BizDate\\": \\"2024-04-01\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"StartExecuteTime\\": 1717081729000,\\n \\"EndExecuteTime\\": 1717081789000,\\n \\"SupplementId\\": \\"f_8241792_20201202_2099680\\",\\n \\"Duration\\": \\"60s\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取补数据工作流Dagrun列表', ], 'GetPhysicalNode' => [ 'summary' => '查询物理调度节点。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_232132', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeInfo' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_232132', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => '节点名称', ], 'Description' => [ 'title' => '节点描述', 'description' => '节点描述', 'type' => 'string', 'example' => 'xx测试', ], 'OperatorType' => [ 'title' => '节点子类型', 'description' => '节点子类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL等', 'type' => 'string', 'example' => 'SHELL', ], 'ScheduleType' => [ 'title' => '调度周期类型'."\n" .'MINUTELY'."\n" .'HOURLY'."\n" .'DAILY'."\n" .'WEEKLY'."\n" .'MONTHLY'."\n" .'QUARTERLY', 'description' => '调度周期类型'."\n" .'- MINUTELY'."\n" .'- HOURLY'."\n" .'- DAILY'."\n" .'- WEEKLY'."\n" .'- MONTHLY'."\n" .'- QUARTERLY', 'type' => 'string', 'example' => 'DAILY', ], 'Priority' => [ 'title' => '调度优先级'."\n" .'HIGHEST'."\n" .'HIGH'."\n" .'MIDDLE'."\n" .'LOW'."\n" .'LOWEST', 'description' => '调度优先级'."\n" ."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'string', 'example' => 'MIDDLE', ], 'ProjectInfo' => [ 'title' => '节点归属项目', 'description' => '节点归属项目', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'example' => '102132', ], 'Name' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Creator' => [ 'title' => '节点创建者', 'description' => '节点创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '101312', ], 'Name' => [ 'description' => '用户ID', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Owner' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '101312', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Modifier' => [ 'title' => '更新人', 'description' => '更新人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '101312', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'LastModifiedTime' => [ 'title' => '最新1次更新时间', 'description' => '最新1次更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'Status' => [ 'title' => '调度状态', 'description' => '调度状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'TriggerConfig' => [ 'title' => '触发配置, 用于实现对逻辑表的字段依赖', 'description' => '触发配置, 用于实现对逻辑表的字段依赖', 'type' => 'string', 'example' => '{"expression":"any_success"}', ], 'From' => [ 'title' => '节点来源', 'description' => '节点来源'."\n" .'- DATA_PROCESS：代码研发'."\n" .'- BLACK_BOX：建模研发'."\n" .'- PIPELINE：PIPELINE', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'CronExpression' => [ 'title' => 'cron表达式，用于计算调起时间', 'description' => 'cron表达式，用于计算调起时间', 'type' => 'string', 'example' => '0 0 10 * * *', ], 'OutputNameList' => [ 'title' => '输出名列表', 'description' => '输出名列表', 'type' => 'array', 'items' => [ 'description' => '输出名', 'type' => 'string', 'example' => 'xxtest', ], ], 'DataSourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', ], 'DataSourceSchema' => [ 'title' => '数据源SCHEMA', 'description' => '数据源SCHEMA，仅对如Oracle等需要设置Schema的数据源类型生效。若设置为“默认”，则为空（null）', 'type' => 'string', 'example' => 'null', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeInfo\\": {\\n \\"Id\\": \\"n_232132\\",\\n \\"Name\\": \\"节点名称\\",\\n \\"Description\\": \\"xx测试\\",\\n \\"OperatorType\\": \\"SHELL\\",\\n \\"ScheduleType\\": \\"DAILY\\",\\n \\"Priority\\": \\"MIDDLE\\",\\n \\"ProjectInfo\\": {\\n \\"Id\\": \\"102132\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Creator\\": {\\n \\"Id\\": \\"101312\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Owner\\": {\\n \\"Id\\": \\"101312\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Modifier\\": {\\n \\"Id\\": \\"101312\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"CreateTime\\": 1717343597000,\\n \\"LastModifiedTime\\": 1717343597000,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"TriggerConfig\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"any_success\\\\\\"}\\",\\n \\"From\\": \\"DATA_PROCESS\\",\\n \\"CronExpression\\": \\"0 0 10 * * *\\",\\n \\"OutputNameList\\": [\\n \\"xxtest\\"\\n ],\\n \\"DataSourceId\\": 123456789,\\n \\"DataSourceSchema\\": \\"null\\"\\n }\\n}","type":"json"}]', 'title' => '查询物理调度节点', ], 'GetPhysicalNodeContent' => [ 'summary' => '查询调度节点代码内容。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_232411', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '节点信息', 'description' => '节点信息', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_232411', ], 'NodeName' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'CodeContent' => [ 'title' => '节点代码内容', 'description' => '节点代码内容', 'type' => 'string', 'example' => 'select 1;', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"NodeId\\": \\"n_232411\\",\\n \\"NodeName\\": \\"xx测试\\",\\n \\"CodeContent\\": \\"select 1;\\"\\n }\\n}","type":"json"}]', 'title' => '查询调度节点代码内容', ], 'GetNodeUpDownStream' => [ 'summary' => '通用查询节点上下游接口。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'NodeId', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点id', 'description' => '节点id', 'type' => 'string', 'required' => true, 'example' => '11313', ], 'FieldIdList' => [ 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', 'description' => '当节点时逻辑表节点id时可以传，不传默认是全表', 'type' => 'string', 'required' => false, 'example' => '12', ], ], 'required' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '113123', ], ], [ 'name' => 'UpStreamDepth', 'in' => 'query', 'schema' => [ 'title' => '上游层级，默认：1', 'description' => '上游层级，默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DownStreamDepth', 'in' => 'query', 'schema' => [ 'title' => '下游层级，默认：1', 'description' => '下游层级，默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'DEV', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeDagInfo' => [ 'title' => '节点上下游数据', 'description' => '节点上下游数据', 'type' => 'object', 'properties' => [ 'StartNodeList' => [ 'title' => '中心节点 ', 'description' => '中心节点 ', 'type' => 'array', 'items' => [ 'title' => '节点', 'description' => '节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_123456', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型'."\n" .'DATA_PROCESS：代码任务'."\n" .'BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'ONE_ID_LABEL：萃取标签节点'."\n" .'ONE_ID_RULE：萃取标签节点'."\n" .'PIPELINE_NODE：PIPELINE节点', 'description' => '节点类型'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：逻辑表节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldIdList' => [ 'title' => '字段id列表', 'description' => '字段id列表', 'type' => 'array', 'items' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => '123', ], ], ], ], ], 'UpStreamNodeList' => [ 'title' => '上游节点', 'description' => '上游节点', 'type' => 'array', 'items' => [ 'title' => '节点', 'description' => '节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_123456', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型'."\n" .'DATA_PROCESS：代码任务'."\n" .'BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'ONE_ID_LABEL：萃取标签节点'."\n" .'ONE_ID_RULE：萃取标签节点'."\n" .'PIPELINE_NODE：PIPELINE节点', 'description' => '节点类型'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldIdList' => [ 'title' => '字段id列表', 'description' => '字段id列表', 'type' => 'array', 'items' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => '123', ], ], ], ], ], 'DownStreamNodeList' => [ 'title' => '下游节点', 'description' => '下游节点', 'type' => 'array', 'items' => [ 'title' => '节点', 'description' => '节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_123456', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型'."\n" .'DATA_PROCESS：代码任务'."\n" .'BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'ONE_ID_LABEL：萃取标签节点'."\n" .'ONE_ID_RULE：萃取标签节点'."\n" .'PIPELINE_NODE：PIPELINE节点', 'description' => '节点类型'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：逻辑表节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldIdList' => [ 'title' => '字段id列表', 'description' => '字段id列表', 'type' => 'array', 'items' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'example' => '123', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeDagInfo\\": {\\n \\"StartNodeList\\": [\\n {\\n \\"Id\\": \\"n_123456\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"FieldIdList\\": [\\n \\"123\\"\\n ]\\n }\\n ],\\n \\"UpStreamNodeList\\": [\\n {\\n \\"Id\\": \\"n_123456\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"FieldIdList\\": [\\n \\"123\\"\\n ]\\n }\\n ],\\n \\"DownStreamNodeList\\": [\\n {\\n \\"Id\\": \\"n_123456\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"FieldIdList\\": [\\n \\"123\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取节点上下游', ], 'ListNodes' => [ 'summary' => '获取任务节点列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询条件', 'description' => '查询条件', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12111', ], 'NodeBizType' => [ 'title' => '节点业务类型（脚本、逻辑表、萃取）：SCRIPT/LOGICAL_TABLE/ONE_ID', 'description' => '节点业务类型'."\n" .'- SCRIPT：脚本'."\n" .'- LOGICAL_TABLE：逻辑表', 'type' => 'string', 'required' => true, 'example' => 'SCRIPT', ], 'NodeSubBizTypeList' => [ 'title' => '子业务类型(HIVE_SQL/HADOOP_MR/SHELL/DATAX/PYTHON等)'."\n", 'description' => '子业务类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL等', 'type' => 'array', 'items' => [ 'description' => '子业务类型', 'type' => 'string', 'required' => false, 'example' => 'SHELL', ], 'required' => true, ], 'SchedulePeriodList' => [ 'title' => '调度周期（年、月、周、日、时、分）：YEARLY/MONTHLY/WEEKLY/DAILY/HOURLY/MINUTELY', 'description' => '调度周期'."\n" .'- YEARLY'."\n" .'- MONTHLY'."\n" .'- WEEKLY'."\n" .'- DAILY'."\n" .'- HOURLY'."\n" .'- MINUTELY', 'type' => 'array', 'items' => [ 'description' => '调度周期', 'type' => 'string', 'required' => false, 'example' => 'DAILY', ], 'required' => false, ], 'OwnerList' => [ 'title' => '负责人用户ID', 'description' => '负责人用户ID', 'type' => 'array', 'items' => [ 'description' => '负责人', 'type' => 'string', 'required' => false, 'example' => '121112', ], 'required' => false, ], 'PriorityList' => [ 'title' => '节点优先级（最高，高，中，低，最低）：HIGHEST/HIGH/MIDDLE/LOW/LOWEST', 'description' => '节点优先级'."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'array', 'items' => [ 'description' => '优先级', 'type' => 'string', 'required' => false, 'example' => 'MIDDLE', ], 'required' => false, ], 'SchedulePaused' => [ 'title' => '是否暂停', 'description' => '是否暂停调度', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DryRun' => [ 'title' => '是否空跑', 'description' => '是否空跑', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'ScheduleType' => [ 'title' => '节点调度类型（如周期、补数据、手工）：NORMAL/SUPPLEMENT/MANUAL', 'description' => '节点调度类型'."\n" .'- NORMAL：周期'."\n" .'- SUPPLEMENT：补数据'."\n" .'- MANUAL：手工', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', ], 'SearchText' => [ 'title' => '关键词搜索：支持节点名称模糊搜索，节点id精确搜索', 'description' => '关键词搜索：支持节点名称模糊搜索，节点id精确搜索', 'type' => 'string', 'required' => false, 'example' => 'xx', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数', 'description' => '分页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NodeList' => [ 'title' => '分页节点列表', 'description' => '分页节点列表', 'type' => 'array', 'items' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx test', ], 'PriorityList' => [ 'title' => '优先级', 'description' => '优先级', 'type' => 'array', 'items' => [ 'description' => '优先级', 'type' => 'string', 'example' => 'MIDDLE', ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'DryRun' => [ 'title' => '是否空跑', 'description' => '是否空跑', 'type' => 'boolean', 'example' => 'true', ], 'OwnerList' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'array', 'items' => [ 'description' => '负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '23222', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], 'From' => [ 'title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'Creator' => [ 'title' => '创建者', 'description' => '创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '23222', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'SubDetailType' => [ 'title' => '节点子类型（如数据处理中的MAX_COMPUTER_SQL/HIVE_SQL/SHELL等，如逻辑表中的维度表/事实表/汇总表等）。如DATA_PROCESS中的MAX_COMPUTER_SQL、HIVE_SQL、SHELL等，如BBOX_LOGIC_TABLE_NODE中的DIM_LOGICAL_TABLE、FACT_LOGICAL_TABLE、SUMMARY_LOGICAL_TABLE等', 'description' => '子业务类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL等', 'type' => 'string', 'example' => 'SHELL', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'HasProd' => [ 'title' => '是否有生产环境', 'description' => '是否有生产环境', 'type' => 'boolean', 'example' => 'true', ], 'Type' => [ 'title' => '节点类型', 'description' => '节点类型', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'HasDev' => [ 'title' => '是否有开发环境', 'description' => '是否有开发环境', 'type' => 'boolean', 'example' => 'true', ], 'SchedulePaused' => [ 'title' => '是否暂停', 'description' => '是否暂停', 'type' => 'boolean', 'example' => 'true', ], 'SchedulePeriodList' => [ 'title' => '调度周期', 'description' => '调度周期', 'type' => 'array', 'items' => [ 'description' => '调度周期', 'type' => 'string', 'example' => 'HOURLY', ], ], 'ProjectInfo' => [ 'title' => '归属项目', 'description' => '归属项目', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '项目ID', 'type' => 'string', 'example' => '1121321', ], 'Name' => [ 'description' => '项目名称', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'LastModifiedTime' => [ 'description' => '编辑时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'BizUnitName' => [ 'title' => '所属业务板块名称', 'description' => '所属业务板块名称', 'type' => 'string', 'example' => 'xx测试', ], 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_31111', ], 'Modifier' => [ 'title' => '节点更新者', 'description' => '节点更新者', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '311131', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'ExtendInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => '{"xx":"zz"}', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 100,\\n \\"NodeList\\": [\\n {\\n \\"Description\\": \\"xx test\\",\\n \\"PriorityList\\": [\\n \\"MIDDLE\\"\\n ],\\n \\"CreateTime\\": \\"2024-05-30 16:47:13\\",\\n \\"DryRun\\": true,\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"23222\\",\\n \\"Name\\": \\"xx测试\\"\\n }\\n ],\\n \\"From\\": \\"DATA_PROCESS\\",\\n \\"Creator\\": {\\n \\"Id\\": \\"23222\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"SubDetailType\\": \\"SHELL\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"HasProd\\": true,\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"HasDev\\": true,\\n \\"SchedulePaused\\": true,\\n \\"SchedulePeriodList\\": [\\n \\"HOURLY\\"\\n ],\\n \\"ProjectInfo\\": {\\n \\"Id\\": \\"1121321\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"LastModifiedTime\\": \\"2024-05-30 16:47:13\\",\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"Id\\": \\"n_31111\\",\\n \\"Modifier\\": {\\n \\"Id\\": \\"311131\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"ExtendInfo\\": \\"{\\\\\\"xx\\\\\\":\\\\\\"zz\\\\\\"}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询调度节点列表', ], 'GetPhysicalNodeOperationLog' => [ 'summary' => '查询节点的操作日志。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_231131', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'OperationLogList' => [ 'title' => '节点操作日志', 'description' => '节点操作日志', 'type' => 'array', 'items' => [ 'title' => '节点操作日志信息', 'description' => '节点操作日志信息', 'type' => 'object', 'properties' => [ 'Context' => [ 'title' => '日志详情', 'description' => '日志详情', 'type' => 'string', 'example' => 'xx', ], 'OperationType' => [ 'title' => '操作类型'."\n" .'TASK_UPDATE_PRIORITY:修改节点优先级'."\n" .'PAUSE_TASK:暂停调度'."\n" .'RESUME_TASK:恢复调度'."\n" .'CREATE_NODE:创建节点'."\n" .'FORCE_DELETE_NODE:强制删除节点'."\n" .'UPDATE_NODE:更新节点'."\n" .'DELETE_NODE:删除节点'."\n" .'CHANGE_NODE_OWNER:修改节点负责人', 'description' => '操作类型'."\n" .'- TASK_UPDATE_PRIORITY:修改节点优先级'."\n" .'- PAUSE_TASK:暂停调度'."\n" .'- RESUME_TASK:恢复调度'."\n" .'- CREATE_NODE:创建节点'."\n" .'- FORCE_DELETE_NODE:强制删除节点'."\n" .'- UPDATE_NODE:更新节点'."\n" .'- DELETE_NODE:删除节点'."\n" .'- CHANGE_NODE_OWNER:修改节点负责人', 'type' => 'string', 'example' => 'PAUSE_TASK', ], 'Operator' => [ 'title' => '操作人ID', 'description' => '操作人ID', 'type' => 'string', 'example' => '132222', ], 'OperationTime' => [ 'title' => '操作时间', 'description' => '操作时间', 'type' => 'string', 'example' => '2024-05-30 16:47:13', ], 'OperatorName' => [ 'title' => '操作者名字', 'description' => '操作者名字', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"OperationLogList\\": [\\n {\\n \\"Context\\": \\"xx\\",\\n \\"OperationType\\": \\"PAUSE_TASK\\",\\n \\"Operator\\": \\"132222\\",\\n \\"OperationTime\\": \\"2024-05-30 16:47:13\\",\\n \\"OperatorName\\": \\"xx测试\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询节点的操作日志', ], 'ListNodeDownStream' => [ 'summary' => '查询节点下游，创建补数据工作流时可以作为数据参考。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询节点下游请求', 'description' => '查询节点下游请求', 'type' => 'object', 'properties' => [ 'NodeIdList' => [ 'title' => '节点列表', 'description' => '节点列表', 'type' => 'array', 'items' => [ 'title' => '节点', 'description' => '节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => 'n_23431', ], 'FieldIdList' => [ 'title' => '字段ID列表：当节点是逻辑表节点ID时可以传，不传默认是全表', 'description' => '字段ID列表：当节点是逻辑表节点ID时可以传，不传默认是全表', 'type' => 'array', 'items' => [ 'title' => '字段ID', 'description' => '字段ID', 'type' => 'string', 'required' => false, 'example' => '23211121', ], 'required' => false, 'example' => '112', ], ], 'required' => false, ], 'required' => true, ], 'DownStreamDepth' => [ 'title' => '深度, 默认3', 'description' => '深度，默认3层 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'FilterList' => [ 'title' => '过滤器', 'description' => '过滤器：可以根据项目、节点等进行正选和反选，默认为空', 'type' => 'array', 'items' => [ 'description' => '过滤器', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '筛选键，支持：'."\n" .'- PROJECT: 项目'."\n" .'- PHYSICAL_NODE_ID: 物理任务id'."\n" .'- LOGICAL_TABLE_NODE_ID: 逻辑表id', 'type' => 'string', 'required' => false, 'example' => 'PROJECT', ], 'ValueList' => [ 'description' => '过滤值列表', 'type' => 'array', 'items' => [ 'description' => '过滤值', 'type' => 'string', 'required' => false, 'example' => '102113', ], 'required' => false, ], 'Exclude' => [ 'description' => '是否反选，默认：false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'required' => false, ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123011', ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeInfoList' => [ 'title' => '节点列表', 'description' => '节点列表', 'type' => 'array', 'items' => [ 'title' => '节点', 'description' => '节点', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_2423351', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'Type' => [ 'title' => '节点类型', 'description' => '节点类型', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'FieldIdList' => [ 'title' => '字段id列表', 'description' => '字段id列表', 'type' => 'array', 'items' => [ 'description' => '字段id', 'type' => 'string', 'example' => '123', ], ], 'Depth' => [ 'title' => '层级', 'description' => '层级', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeInfoList\\": [\\n {\\n \\"Id\\": \\"n_2423351\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Type\\": \\"DATA_PROCESS\\",\\n \\"FieldIdList\\": [\\n \\"123\\"\\n ],\\n \\"Depth\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询节点下游', ], 'GetPhysicalNodeByOutputName' => [ 'summary' => '根据输出名查询物理节点，仅支持离线代码节点及集成任务节点。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => [ 'title' => '节点输出名', 'description' => '节点输出名', 'type' => 'string', 'required' => true, 'example' => 't_test', ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeInfo' => [ 'title' => '节点详情', 'description' => '节点详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_2321', ], 'Name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'xx测试', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'xx测试', ], 'OperatorType' => [ 'title' => '节点子类型', 'description' => '节点子类型'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL等', 'type' => 'string', 'example' => 'SHELL', ], 'ScheduleType' => [ 'title' => '调度周期类型', 'description' => '调度周期类型'."\n" .'- MINUTELY'."\n" .'- HOURLY'."\n" .'- DAILY'."\n" .'- WEEKLY'."\n" .'- MONTHLY'."\n" .'- YEARLY', 'type' => 'string', 'example' => 'DAILY', ], 'Priority' => [ 'title' => '调度优先级', 'description' => '优先级'."\n" .'- HIGHEST'."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW'."\n" .'- LOWEST', 'type' => 'string', 'example' => 'MIDDLE', ], 'ProjectInfo' => [ 'title' => '节点归属项目', 'description' => '节点归属项目', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '项目ID', 'type' => 'string', 'example' => '1324211', ], 'Name' => [ 'description' => '项目名称', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Creator' => [ 'title' => '节点创建者', 'description' => '节点创建者', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '1311131', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Owner' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '1311131', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'Modifier' => [ 'title' => '节点修改者', 'description' => '节点修改者', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '用户ID', 'type' => 'string', 'example' => '1311131', ], 'Name' => [ 'description' => '用户名', 'type' => 'string', 'example' => 'xx测试', ], ], ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'LastModifiedTime' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', ], 'Status' => [ 'title' => '节点调度状态', 'description' => '节点调度状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'TriggerConfig' => [ 'title' => '触发配置, 用于实现对逻辑表的字段依赖', 'description' => '触发配置, 用于实现对逻辑表的字段依赖', 'type' => 'string', 'example' => '{"expression":"any_success"}', ], 'From' => [ 'title' => '节点来源', 'description' => '节点来源'."\n" .'- DATA_PROCESS：代码研发'."\n" .'- BLACK_BOX：黑盒'."\n" .'- ONE_ID：萃取'."\n" .'- PIPELINE：PIPELINE', 'type' => 'string', 'example' => 'DATA_PROCESS', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeInfo\\": {\\n \\"Id\\": \\"n_2321\\",\\n \\"Name\\": \\"xx测试\\",\\n \\"Description\\": \\"xx测试\\",\\n \\"OperatorType\\": \\"SHELL\\",\\n \\"ScheduleType\\": \\"DAILY\\",\\n \\"Priority\\": \\"MIDDLE\\",\\n \\"ProjectInfo\\": {\\n \\"Id\\": \\"1324211\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Creator\\": {\\n \\"Id\\": \\"1311131\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Owner\\": {\\n \\"Id\\": \\"1311131\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"Modifier\\": {\\n \\"Id\\": \\"1311131\\",\\n \\"Name\\": \\"xx测试\\"\\n },\\n \\"CreateTime\\": 1717343597000,\\n \\"LastModifiedTime\\": 1717343597000,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"TriggerConfig\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"any_success\\\\\\"}\\",\\n \\"From\\": \\"DATA_PROCESS\\"\\n }\\n}","type":"json"}]', 'title' => '根据输出名查询物理节点', ], 'GetDevObjectDependency' => [ 'summary' => '查询开发态对象上游依赖。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ObjectId', 'in' => 'query', 'schema' => [ 'title' => '开发对象id, 对于逻辑表需要传入模型id，对于其他任务需要传入FileId', 'description' => '对象ID', 'type' => 'string', 'required' => true, 'example' => '7026498387616064', ], ], [ 'name' => 'ObjectType', 'in' => 'query', 'schema' => [ 'title' => '开发对象类型. 任务FileId:FILE_ID, 逻辑表：MODEL_ID', 'description' => '开发对象类型'."\n" .'- FILE_ID：任务FileId'."\n" .'- MODEL_ID：逻辑表', 'type' => 'string', 'required' => true, 'example' => '7026498387616064', ], ], [ 'name' => 'ObjectFrom', 'in' => 'query', 'schema' => [ 'title' => '开发对象来源. BLACK_BOX: 逻辑表；DATA_PROCESS：计算任务；PIPELINE：集成任务', 'description' => '开发对象来源'."\n" .'- BLACK_BOX: 逻辑表'."\n" .'- DATA_PROCESS：计算任务'."\n" .'- PIPELINE：集成任务', 'type' => 'string', 'required' => true, 'example' => 'DATA_PROCESS', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7021037162911616L', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'DevObjectDependencyList' => [ 'title' => '依赖列表', 'description' => '依赖列表', 'type' => 'array', 'items' => [ 'title' => '依赖', 'description' => '依赖', 'type' => 'object', 'properties' => [ 'ScheduleType' => [ 'title' => '调度类型'."\n" .'MINUTELY: 分钟,HOURLY: 小时,DAILY: 天,WEEKLY: 周,MONTHLY: 月,YEARLY: 年', 'description' => '调度类型'."\n" .'- MINUTELY: 分钟'."\n" .'- HOURLY: 小时'."\n" .'- DAILY: 天'."\n" .'- WEEKLY: 周'."\n" .'- MONTHLY: 月'."\n" .'- YEARLY: 年', 'type' => 'string', 'example' => 'DAILY', ], 'NodeName' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'xx测试', ], 'NodeOutputTableName' => [ 'title' => '输出表信息 ', 'description' => '输出表信息 ', 'type' => 'string', 'example' => 't_xx', ], 'DependencyPeriod' => [ 'title' => '依赖周期配置', 'description' => '依赖周期配置', 'type' => 'object', 'properties' => [ 'PeriodType' => [ 'title' => '依赖周期类型：CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', 'description' => '依赖周期类型'."\n" .'- CURRENT_PERIOD'."\n" .'- LAST_PERIOD'."\n" .'- LAST_N_PERIOD'."\n" .'- LAST_24_HOUR', 'type' => 'string', 'example' => 'CURRENT_PERIOD', ], 'PeriodOffset' => [ 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值'."\n", 'description' => '周期偏移量，依赖周期类型是LAST_N_PERIOD时须传值', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'NodeOutputName' => [ 'title' => '节点输出名', 'description' => '节点输出名', 'type' => 'string', 'example' => 'n_xx', ], 'ManuallyAdd' => [ 'title' => '是否手动添加', 'description' => '是否手动添加', 'type' => 'boolean', 'example' => 'false', ], 'BizUnitId' => [ 'title' => '业务模块ID', 'description' => '业务模块ID', 'type' => 'string', 'example' => '13111', ], 'CustomCronExpression' => [ 'title' => '是否自定义调度节点表达式', 'description' => '是否自定义调度节点表达式', 'type' => 'boolean', 'example' => 'true', ], 'DependencyStrategy' => [ 'title' => '依赖策略：ALL,FIRST,LAST,NEAR'."\n", 'description' => '依赖策略'."\n" .'- ALL'."\n" .'- FIRST'."\n" .'- LAST'."\n" .'- NEAR', 'type' => 'string', 'example' => 'ALL', ], 'BizUnitName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'xx测试', ], 'EffectFieldList' => [ 'title' => '依赖字段', 'description' => '依赖字段', 'type' => 'array', 'items' => [ 'description' => '依赖字段', 'type' => 'string', 'example' => '112', ], ], 'CronExpression' => [ 'title' => '调度节点表达式', 'description' => '调度节点表达式', 'type' => 'string', 'example' => '0 0 0 * * ?', ], 'SubBizType' => [ 'title' => '子业务类型：'."\n" .'DIM_LOGICAL_TABLE,FACT_LOGICAL_TABLE,SUMMARY_LOGICAL_TABLE,MAX_COMPUTE_SQL,MAX_COMPUTE_MR,HIVE_SQL,HADOOP_MR,SPARK_JAR_ON_HIVE,SPARK_SQL_ON_HIVE,SPARK_JAR_ON_MAX_COMPUTE,SHELL,PYTHON,PYTHON37,DATAX,MERGE,DLINK,CHECK,PERL,ONE_SERVICE_SQL_ADB_FOR_PG,ONE_SERVICE_SQL_ADB_FOR_MYSQL,ADB_FOR_PG,INCEPTOR_SQL,VIRTUAL,FLINK_SQL,FLINK_TEMPLATE_SQL,FLINK_DATASTREAM,REAL_TIME_PIPELINE,PAI_DESIGNER,HOLOGRES_SQL,ARGODB_SQL,IMPALA_SQL,STARROCKS_SQL'."\n", 'description' => '子业务类型：'."\n" .'- MAX_COMPUTE_SQL'."\n" .'- HIVE_SQL'."\n" .'- SHELL'."\n" .'- PYTHON'."\n" .'- ONE_SERVICE_SQL'."\n" .'- DATABASE_SQL等', 'type' => 'string', 'example' => 'SHELL', ], 'DimMidNode' => [ 'title' => '是否是维度表中间节点', 'description' => '是否是维度表中间节点', 'type' => 'boolean', 'example' => 'true', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123131', ], 'BizType' => [ 'title' => '业务类型：'."\n" .'SCRIPT: 脚本，LOGICAL_TABLE：逻辑表', 'description' => '业务类型：'."\n" .'- SCRIPT: 脚本'."\n" .'- LOGICAL_TABLE：逻辑表', 'type' => 'string', 'example' => 'SCRIPT', ], 'OwnerList' => [ 'title' => '节点负责人', 'description' => '节点负责人', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => '11123', ], 'Name' => [ 'title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'xx测试', ], ], ], ], 'SelfDepend' => [ 'title' => '是否自依赖', 'description' => '是否自依赖', 'type' => 'boolean', 'example' => 'true', ], 'DependFieldList' => [ 'title' => '依赖字段', 'description' => '依赖字段', 'type' => 'array', 'items' => [ 'description' => '依赖字段', 'type' => 'string', 'example' => '121', ], ], 'ExternalBizInfo' => [ 'title' => '额外业务信息', 'description' => '额外业务信息', 'type' => 'string', 'example' => '所有字段信息/hasProd/hasDev等信息', ], 'PeriodDiff' => [ 'title' => '依赖周期差', 'description' => '依赖周期差', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Valid' => [ 'title' => '配置是否生效', 'description' => '配置是否生效', 'type' => 'boolean', 'example' => 'true', ], 'NodeType' => [ 'title' => '节点类型', 'description' => '节点类型'."\n" .'- DATA_PROCESS：代码任务'."\n" .'- BBOX_LOGIC_TABLE_NODE：黑盒逻辑表节点'."\n" .'- ONE_ID_LABEL：萃取标签节点'."\n" .'- ONE_ID_RULE：萃取标签节点'."\n" .'- PIPELINE_NODE：PIPELINE节点', 'type' => 'string', 'example' => 'DATA_PROCESS', ], 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_13211', ], 'OutputContextParamList' => [ 'title' => '跨节点输出参数 ', 'description' => '跨节点输出参数 ', 'type' => 'array', 'items' => [ 'description' => '跨节点输出参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '参数', 'type' => 'string', 'example' => 'v1', ], 'Description' => [ 'description' => '描述', 'type' => 'string', 'example' => 'xxtest', ], 'DefaultValue' => [ 'description' => '默认值', 'type' => 'string', 'example' => 'v1', ], ], ], ], 'AutoParse' => [ 'title' => '任务是否自动解析 ', 'description' => '任务是否自动解析 ', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"DevObjectDependencyList\\": [\\n {\\n \\"ScheduleType\\": \\"DAILY\\",\\n \\"NodeName\\": \\"xx测试\\",\\n \\"ProjectName\\": \\"xx测试\\",\\n \\"NodeOutputTableName\\": \\"t_xx\\",\\n \\"DependencyPeriod\\": {\\n \\"PeriodType\\": \\"CURRENT_PERIOD\\",\\n \\"PeriodOffset\\": 1\\n },\\n \\"NodeOutputName\\": \\"n_xx\\",\\n \\"ManuallyAdd\\": false,\\n \\"BizUnitId\\": \\"13111\\",\\n \\"CustomCronExpression\\": true,\\n \\"DependencyStrategy\\": \\"ALL\\",\\n \\"BizUnitName\\": \\"xx测试\\",\\n \\"EffectFieldList\\": [\\n \\"112\\"\\n ],\\n \\"CronExpression\\": \\"0 0 0 * * ?\\",\\n \\"SubBizType\\": \\"SHELL\\",\\n \\"DimMidNode\\": true,\\n \\"ProjectId\\": 123131,\\n \\"BizType\\": \\"SCRIPT\\",\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"11123\\",\\n \\"Name\\": \\"xx测试\\"\\n }\\n ],\\n \\"SelfDepend\\": true,\\n \\"DependFieldList\\": [\\n \\"121\\"\\n ],\\n \\"ExternalBizInfo\\": \\"所有字段信息/hasProd/hasDev等信息\\",\\n \\"PeriodDiff\\": 1,\\n \\"Valid\\": true,\\n \\"NodeType\\": \\"DATA_PROCESS\\",\\n \\"NodeId\\": \\"n_13211\\",\\n \\"OutputContextParamList\\": [\\n {\\n \\"Key\\": \\"v1\\",\\n \\"Description\\": \\"xxtest\\",\\n \\"DefaultValue\\": \\"v1\\"\\n }\\n ],\\n \\"AutoParse\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询开发态对象上游依赖', ], 'ResumePhysicalNode' => [ 'summary' => '恢复物理节点调度。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ResumeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '恢复调度请求', 'description' => '恢复调度请求', 'type' => 'object', 'properties' => [ 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102011', ], 'NodeIdList' => [ 'title' => '节点ID列表', 'description' => '节点ID列表', 'type' => 'array', 'items' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => '30132', ], 'required' => true, ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'NodeOperateResultList' => [ 'title' => '', 'description' => '节点恢复调度操作结果', 'type' => 'array', 'items' => [ 'description' => '点恢复调度操作结果', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => 'n_123456', ], 'Status' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'string', 'example' => 'SUCCESS', ], 'ErrorMessage' => [ 'title' => '操作失败时，异常信息提示', 'description' => '操作失败时，异常信息提示', 'type' => 'string', 'example' => 'xx', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"NodeOperateResultList\\": [\\n {\\n \\"NodeId\\": \\"n_123456\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"ErrorMessage\\": \\"xx\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '恢复物理节点调度', ], 'ExecuteManualNode' => [ 'summary' => '运行手动调度节点。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ExecuteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '运行手动任务请求', 'description' => '运行手动任务请求', 'type' => 'object', 'properties' => [ 'NodeId' => [ 'title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'n_12132', ], 'FlowName' => [ 'title' => '工作流名字', 'description' => '工作流名字', 'type' => 'string', 'required' => false, 'example' => 'xx测试', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123324', ], 'StartBizDate' => [ 'title' => '起始业务日期', 'description' => '起始业务日期', 'type' => 'string', 'required' => true, 'example' => '2024-05-01', ], 'EndBizDate' => [ 'title' => '终止业务日期', 'description' => '终止业务日期', 'type' => 'string', 'required' => true, 'example' => '2024-05-07', ], 'ParamList' => [ 'title' => '运行参数', 'description' => '运行参数', 'type' => 'array', 'items' => [ 'title' => '运行参数', 'description' => '运行参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '参数', 'description' => '参数', 'type' => 'string', 'required' => false, 'example' => 'param1', ], 'Value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], [ 'name' => 'Env', 'in' => 'query', 'schema' => [ 'title' => '环境标识'."\n" .'DEV：开发环境 '."\n" .'PROD（默认）：生产环境', 'description' => '环境标识'."\n" .'- DEV：开发环境 '."\n" .'- PROD（默认）：生产环境', 'type' => 'string', 'required' => false, 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'FlowId' => [ 'title' => '工作流ID', 'description' => '工作流ID', 'type' => 'string', 'example' => 'f_1231_121324', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FlowId\\": \\"f_1231_121324\\"\\n}","type":"json"}]', 'title' => '运行手动任务', ], 'ListAlertNotifications' => [ 'summary' => '根据条件查询多个推送记录。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询条件', 'description' => '查询条件', 'type' => 'object', 'properties' => [ 'UserIdList' => [ 'title' => '推送接收人id列表', 'description' => '推送接收人id列表', 'type' => 'array', 'items' => [ 'title' => '推送接收人id', 'description' => '推送接收人id', 'type' => 'string', 'required' => false, 'example' => '12345', ], 'required' => false, ], 'NotifyStartTime' => [ 'title' => '推送起始时间', 'description' => '推送起始时间', 'type' => 'string', 'required' => true, 'example' => '2024-11-16 00:00:00', ], 'NotifyEndTime' => [ 'title' => '推送结束时间', 'description' => '推送结束时间', 'type' => 'string', 'required' => true, 'example' => '2024-11-27 13:47:00', ], 'ChannelTypeList' => [ 'title' => '推送渠道类型列表', 'description' => '推送渠道类型列表', 'type' => 'array', 'items' => [ 'title' => '推送渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'description' => '推送渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'type' => 'string', 'required' => false, 'example' => 'SMS', ], 'required' => false, ], 'CustomChannelIdList' => [ 'title' => '自定义消息渠道id列表', 'description' => '自定义消息渠道id列表', 'type' => 'array', 'items' => [ 'title' => '自定义消息渠道id', 'description' => '自定义消息渠道id', 'type' => 'string', 'required' => false, 'example' => '12345', ], 'required' => false, ], 'StatusList' => [ 'title' => '推送状态列表', 'description' => '推送状态列表', 'type' => 'array', 'items' => [ 'title' => '推送状态：'."\n" .'- SUCCESS：发送成功'."\n" .'- FAILED：发送失败'."\n" .'- SENDING：发送中', 'description' => '推送状态：'."\n" .'- SUCCESS：发送成功'."\n" .'- FAILED：发送失败'."\n" .'- SENDING：发送中', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', ], 'required' => false, ], 'AlertReasonList' => [ 'title' => '告警原因列表', 'description' => '告警原因列表', 'type' => 'array', 'items' => [ 'title' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'description' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_FINISH', ], 'required' => false, ], 'SourceSystem' => [ 'title' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'description' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'type' => 'string', 'required' => true, 'example' => 'ALL', ], 'MonitoredItemIdList' => [ 'title' => '监控项id列表', 'description' => '监控项id列表', 'type' => 'array', 'items' => [ 'title' => '监控项id', 'description' => '监控项id', 'type' => 'string', 'required' => false, 'example' => '12345', ], 'required' => false, ], 'Keyword' => [ 'title' => '关键字查询', 'description' => '关键字查询', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '一页数据条数', 'description' => '一页数据条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'True', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ListResult' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Data' => [ 'title' => '推送记录列表', 'description' => '推送记录列表', 'type' => 'array', 'items' => [ 'title' => '推送记录信息', 'description' => '推送记录信息', 'type' => 'object', 'properties' => [ 'AlertEventId' => [ 'title' => '告警事件id', 'description' => '告警事件id', 'type' => 'string', 'example' => '12345', ], 'AlertObject' => [ 'title' => '告警对象', 'description' => '告警对象', 'type' => 'object', 'properties' => [ 'SourceSystemType' => [ 'title' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'description' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH', ], 'Name' => [ 'title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'description' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH_SHELL', ], ], ], 'AlertReason' => [ 'title' => '告警原因', 'description' => '告警原因', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'description' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '20241125', ], 'UniqueKey' => [ 'title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => '123456', ], 'AlertReasonParamList' => [ 'title' => '告警参数列表', 'description' => '告警参数列表', 'type' => 'array', 'items' => [ 'title' => '告警参数', 'description' => '告警参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '告警参数名', 'description' => '告警参数名', 'type' => 'string', 'example' => 'biz_date', ], 'Value' => [ 'title' => '告警参数值', 'description' => '告警参数值', 'type' => 'string', 'example' => '2024-11-24 00:00:00', ], ], ], ], ], ], 'AlertReceiver' => [ 'title' => '接收人信息', 'description' => '接收人信息', 'type' => 'object', 'properties' => [ 'AlertChannelType' => [ 'title' => '推送渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'description' => '推送渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'type' => 'string', 'example' => 'SMS', ], 'CustomAlertChannelId' => [ 'title' => '自定义消息消息渠道id', 'description' => '自定义消息消息渠道id', 'type' => 'string', 'example' => '123456', ], 'Type' => [ 'title' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'description' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'type' => 'string', 'example' => 'OWNER', ], 'User' => [ 'title' => '用户信息', 'description' => '用户信息', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '告警接收人姓名', 'description' => '告警接收人姓名', 'type' => 'string', 'example' => 'ADMIN', ], ], ], 'OnCallTableId' => [ 'title' => '值班表id', 'description' => '值班表id', 'type' => 'string', 'example' => '12345', ], 'OnCallTableName' => [ 'title' => '值班表名称', 'description' => '值班表名称', 'type' => 'string', 'example' => 'test', ], ], ], 'AlertSend' => [ 'title' => '告警发送信息', 'description' => '告警发送信息', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '推送状态：'."\n" .'- SUCCESS：发送成功'."\n" .'- FAILE：发送失败'."\n" .'- SENDING：发送中', 'description' => '推送状态：'."\n" .'- SUCCESS：发送成功'."\n" .'- FAILE：发送失败'."\n" .'- SENDING：发送中', 'type' => 'string', 'example' => 'SUCCESS', ], 'FailReason' => [ 'title' => '告警原因', 'description' => '告警原因', 'type' => 'string', 'example' => '不合法', ], 'SendTime' => [ 'title' => '推送时间', 'description' => '推送时间', 'type' => 'string', 'example' => '2024-11-25 10:02:47', ], 'SendContent' => [ 'title' => '推送内容', 'description' => '推送内容', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ListResult\\": {\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"AlertEventId\\": \\"12345\\",\\n \\"AlertObject\\": {\\n \\"SourceSystemType\\": \\"VDM_BATCH\\",\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"VDM_BATCH_SHELL\\"\\n },\\n \\"AlertReason\\": {\\n \\"Type\\": \\"VDM_BATCH_FINISH\\",\\n \\"BizDate\\": \\"20241125\\",\\n \\"UniqueKey\\": \\"123456\\",\\n \\"AlertReasonParamList\\": [\\n {\\n \\"Key\\": \\"biz_date\\",\\n \\"Value\\": \\"2024-11-24 00:00:00\\"\\n }\\n ]\\n },\\n \\"AlertReceiver\\": {\\n \\"AlertChannelType\\": \\"SMS\\",\\n \\"CustomAlertChannelId\\": \\"123456\\",\\n \\"Type\\": \\"OWNER\\",\\n \\"User\\": {\\n \\"Name\\": \\"ADMIN\\"\\n },\\n \\"OnCallTableId\\": \\"12345\\",\\n \\"OnCallTableName\\": \\"test\\"\\n },\\n \\"AlertSend\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"FailReason\\": \\"不合法\\",\\n \\"SendTime\\": \\"2024-11-25 10:02:47\\",\\n \\"SendContent\\": \\"test\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询推送记录列表', ], 'ListAlertEvents' => [ 'summary' => '根据条件查询多个告警事件。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'UserIdList' => [ 'title' => '告警接口人id列表', 'description' => '告警接口人id列表', 'type' => 'array', 'items' => [ 'title' => '告警接口人id', 'description' => '告警接口人id', 'type' => 'string', 'required' => false, 'example' => '12345', ], 'required' => false, ], 'AlertStartTime' => [ 'title' => '告警起始日期', 'description' => '告警起始日期', 'type' => 'string', 'required' => true, 'example' => '2024-11-16 00:00:00', ], 'AlertEndTime' => [ 'title' => '告警结束日期', 'description' => '告警结束日期', 'type' => 'string', 'required' => true, 'example' => '2024-11-27 13:47:00', ], 'StatusList' => [ 'title' => '告警状态列表', 'description' => '告警状态列表', 'type' => 'array', 'items' => [ 'title' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'description' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'type' => 'string', 'required' => false, 'example' => 'FINISH', ], 'required' => false, ], 'ProjectNameList' => [ 'title' => '所属项目列表', 'description' => '所属项目列表', 'type' => 'array', 'items' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'string', 'required' => false, 'example' => 'project_1', ], 'required' => false, ], 'BizNameList' => [ 'title' => '业务板块列表', 'description' => '业务板块列表', 'type' => 'array', 'items' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'required' => false, 'example' => 'biz_1', ], 'required' => false, ], 'AlertObjectTypeList' => [ 'title' => '告警对象类型列表', 'description' => '告警对象类型列表', 'type' => 'array', 'items' => [ 'title' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'description' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_PYTHON37', ], 'required' => false, ], 'AlertReasonList' => [ 'title' => '告警原因列表', 'description' => '告警原因列表', 'type' => 'array', 'items' => [ 'title' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'description' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_FINISH', ], 'required' => false, ], 'SourceSystem' => [ 'title' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'description' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'type' => 'string', 'required' => true, 'example' => 'ALL', ], 'MonitoredItemIdList' => [ 'title' => '监控项id列表', 'description' => '监控项id列表', 'type' => 'array', 'items' => [ 'title' => '监控项id', 'description' => '监控项id', 'type' => 'string', 'required' => false, 'example' => '12345', ], 'required' => false, ], 'Keyword' => [ 'title' => '关键字查询', 'description' => '关键字查询', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'Page' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PageSize' => [ 'title' => '一页数据条数', 'description' => '一页数据条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'True', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'ListResult' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Data' => [ 'title' => '告警事件查询结果', 'description' => '告警事件查询结果', 'type' => 'array', 'items' => [ 'title' => '告警事件信息', 'description' => '告警事件信息', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '告警事件id', 'description' => '告警事件id', 'type' => 'string', 'example' => '12345', ], 'AlertObject' => [ 'title' => '告警对象', 'description' => '告警对象', 'type' => 'object', 'properties' => [ 'SourceSystemType' => [ 'title' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'description' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH', ], 'Name' => [ 'title' => '告警对象名称', 'description' => '告警对象名称', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'description' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'STREAM_TASK', ], ], ], 'LatestAlertTime' => [ 'title' => '最新告警时间', 'description' => '最新告警时间', 'type' => 'string', 'example' => '2024-11-25 10:02:47', ], 'FirstAlertTime' => [ 'title' => '首次告警时间', 'description' => '首次告警时间', 'type' => 'string', 'example' => '2024-11-25 10:02:47', ], 'AlertReceiverList' => [ 'title' => '告警接收人列表', 'description' => '告警接收人列表', 'type' => 'array', 'items' => [ 'title' => '告警接收人', 'description' => '告警接收人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'description' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'type' => 'string', 'example' => 'OWNER', ], 'AlertChannelTypeList' => [ 'title' => '告警渠道类型列表', 'description' => '告警渠道类型列表', 'type' => 'array', 'items' => [ 'title' => '告警渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'description' => '告警渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'type' => 'string', 'example' => 'SMS', ], ], 'CustomAlertChannelIdList' => [ 'title' => '自定义告警渠道id列表', 'description' => '自定义告警渠道id列表', 'type' => 'array', 'items' => [ 'title' => '自定义告警渠道id', 'description' => '自定义告警渠道id', 'type' => 'string', 'example' => '12345', ], ], 'UserList' => [ 'title' => '告警用户列表', 'description' => '告警用户列表', 'type' => 'array', 'items' => [ 'title' => '用户信息', 'description' => '用户信息', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'ADMIN', ], ], ], ], 'OnCallTableName' => [ 'title' => '值班表名称', 'description' => '值班表名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'AlertReason' => [ 'title' => '告警原因', 'description' => '告警原因', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'description' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2024-11-25 10:02:47', ], 'UniqueKey' => [ 'title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => 't_6340134343289405440_20241124_639873707610', ], 'AlertReasonParamList' => [ 'title' => '告警原因参数列表', 'description' => '告警原因参数列表', 'type' => 'array', 'items' => [ 'title' => '告警原因参数', 'description' => '告警原因参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '告警原因参数名', 'description' => '告警原因参数名', 'type' => 'string', 'example' => 'biz_date', ], 'Value' => [ 'title' => '告警原因参数值', 'description' => '告警原因参数值', 'type' => 'string', 'example' => '2024-11-24 00:00:00', ], ], ], ], ], ], 'BelongProject' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'string', 'example' => 'project_1', ], 'BizName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'biz_1', ], ], ], 'Status' => [ 'title' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'description' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'type' => 'string', 'example' => 'FINISH', ], 'AlertFrequency' => [ 'title' => '告警频率', 'description' => '告警频率：'."\n" .'- ONCE：即时告警'."\n" .'- PERIOD：周期告警，格式：1HOUR,1MINUTE,1SECOND', 'type' => 'string', 'example' => 'ONCE', ], 'TotalAlertTimes' => [ 'title' => '告警次数', 'description' => '告警次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DoNotDisturbEndTime' => [ 'title' => '消息免打扰到期时间', 'description' => '消息免打扰到期时间', 'type' => 'string', 'example' => '2024-11-25 00:00:00', ], 'UrlConfig' => [ 'title' => 'Url信息', 'description' => 'Url信息', 'type' => 'object', 'properties' => [ 'ObjectUrl' => [ 'title' => '告警对象页面url', 'description' => '告警对象页面url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test1', ], 'LogUrl' => [ 'title' => '日志页面url', 'description' => '日志页面url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test2', ], 'AlertConfigUrl' => [ 'title' => '告警配置页面url', 'description' => '告警配置页面url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test3', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"ListResult\\": {\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"12345\\",\\n \\"AlertObject\\": {\\n \\"SourceSystemType\\": \\"VDM_BATCH\\",\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"STREAM_TASK\\"\\n },\\n \\"LatestAlertTime\\": \\"2024-11-25 10:02:47\\",\\n \\"FirstAlertTime\\": \\"2024-11-25 10:02:47\\",\\n \\"AlertReceiverList\\": [\\n {\\n \\"Type\\": \\"OWNER\\",\\n \\"AlertChannelTypeList\\": [\\n \\"SMS\\"\\n ],\\n \\"CustomAlertChannelIdList\\": [\\n \\"12345\\"\\n ],\\n \\"UserList\\": [\\n {\\n \\"Name\\": \\"ADMIN\\"\\n }\\n ],\\n \\"OnCallTableName\\": \\"test\\"\\n }\\n ],\\n \\"AlertReason\\": {\\n \\"Type\\": \\"VDM_BATCH_FINISH\\",\\n \\"BizDate\\": \\"2024-11-25 10:02:47\\",\\n \\"UniqueKey\\": \\"t_6340134343289405440_20241124_639873707610\\",\\n \\"AlertReasonParamList\\": [\\n {\\n \\"Key\\": \\"biz_date\\",\\n \\"Value\\": \\"2024-11-24 00:00:00\\"\\n }\\n ]\\n },\\n \\"BelongProject\\": {\\n \\"ProjectName\\": \\"project_1\\",\\n \\"BizName\\": \\"biz_1\\"\\n },\\n \\"Status\\": \\"FINISH\\",\\n \\"AlertFrequency\\": \\"ONCE\\",\\n \\"TotalAlertTimes\\": 1,\\n \\"DoNotDisturbEndTime\\": \\"2024-11-25 00:00:00\\",\\n \\"UrlConfig\\": {\\n \\"ObjectUrl\\": \\"https://dataphin.com/ops/test1\\",\\n \\"LogUrl\\": \\"https://dataphin.com/ops/test2\\",\\n \\"AlertConfigUrl\\": \\"https://dataphin.com/ops/test3\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询告警事件列表', ], 'GetAlertEvent' => [ 'summary' => '获取告警事件详情。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => '告警事件Id', 'description' => '告警事件Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID', 'description' => '请求标识ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'True', ], 'HttpStatusCode' => [ 'title' => '后端响应HttpCode', 'description' => '后端响应HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码, OK表示请求正常', 'description' => '请求错误码, OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => 'successful', ], 'AlertEventInfo' => [ 'title' => '请求结果', 'description' => '请求结果', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '告警事件id', 'description' => '告警事件id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'AlertObject' => [ 'title' => '告警对象', 'description' => '告警对象', 'type' => 'object', 'properties' => [ 'SourceSystemType' => [ 'title' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'description' => '来源系统：'."\n" ."\n" .'- ALL：所有'."\n" .'- DQE：数据质量'."\n" .'- OS：数据服务'."\n" .'- STREAM：实时计算'."\n" .'- VDM_BATCH：离线计算'."\n" .'- SOP：运维平台'."\n" .'- REAL_TIME_PIPELINE：实时集成'."\n" .'- KGB：基线监控'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'ALL', ], 'Name' => [ 'title' => '告警对象名称', 'description' => '告警对象名称', 'type' => 'string', 'example' => 'test', ], 'Type' => [ 'title' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'description' => '告警对象类型:'."\n" .'- OS_API：API接口'."\n" .'- OS_APPLICATION_SERVICE：服务应用'."\n" .'- STREAM_TASK：实时计算'."\n" .'- REAL_TIME_PIPELINE_TASK：实时集成'."\n" .'- VDM_BATCH_SHELL：SHELL'."\n" .'- VDM_BATCH_PYTHON：PYTHON'."\n" .'- VDM_BATCH_DATAX：DATAX'."\n" .'- VDM_BATCH_DLINK：DLINK'."\n" .'- VDM_BATCH_VIRTUAL：VIRTUAL'."\n" .'- VDM_BATCH_PYTHON37：PYTHON37'."\n" .'- VDM_BATCH_PYTHON311：PYTHON311'."\n" .'- VDM_BATCH_MAX_COMPUTE_SQL：MAXCOMPUTE_SQL'."\n" .'- VDM_BATCH_MAX_COMPUTE_MR：MAXCOMPUTE_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_MAX_COMPUTE：SPARK_JAR_ON_MAX_COMPUTE'."\n" .'- VDM_BATCH_HIVE_SQL：HIVE_SQL'."\n" .'- VDM_BATCH_HADOOP_MR：HADOOP_MR'."\n" .'- VDM_BATCH_SPARK_JAR_ON_HIVE：SPARK_JAR_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL_ON_HIVE：SPARK_SQL_ON_HIVE'."\n" .'- VDM_BATCH_SPARK_SQL：VDM_BATCH_SPARK_SQL'."\n" .'- DQE_LOGICAL_TABLE：逻辑表'."\n" .'- DQE_PHYSICAL_TABLE：物理表'."\n" .'- DQE_REALTIME_TABLE：实时元表'."\n" .'- DQE_DATA_SOURCE：数据源'."\n" .'- DQE_INDEX：指标'."\n" .'- QD_DECISION_INVOKE：QD决策调用'."\n" .'- BASELINE：基线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH_PYTHON37', ], ], ], 'LatestAlertTime' => [ 'title' => '最新告警时间', 'description' => '最新告警时间', 'type' => 'string', 'example' => '2024-11-05 16:19:33', ], 'FirstAlertTime' => [ 'title' => '首次告警时间', 'description' => '首次告警时间', 'type' => 'string', 'example' => '2024-11-05 16:19:33', ], 'AlertReceiverList' => [ 'title' => '告警接收人列表', 'description' => '告警接收人列表', 'type' => 'array', 'items' => [ 'title' => '告警接收人', 'description' => '告警接收人', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'description' => '告警接收人类型：'."\n" .'- ON_CALL_TABLE：值班表'."\n" .'- USER_DEFINED：自定义用户'."\n" .'- OWNER：负责人', 'type' => 'string', 'example' => 'OWNER', ], 'AlertChannelTypeList' => [ 'title' => '告警渠道类型列表', 'description' => '告警渠道类型列表', 'type' => 'array', 'items' => [ 'title' => '告警渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'description' => '告警渠道类型：'."\n" .'- VOICE：电话'."\n" .'- SMS：短信'."\n" .'- MAIL：邮件'."\n" .'- DINGTALK_ROBOT：邮件'."\n" .'- DINGDING：钉钉工作通知'."\n" .'- CUSTOM：自定义消息渠道'."\n" .'- WECHAT：企业微信'."\n" .'- FEISHU：飞书'."\n" .'- SILENCE：不发送', 'type' => 'string', 'example' => 'SMS', ], ], 'CustomAlertChannelIdList' => [ 'title' => '自定义告警渠道id列表', 'description' => '自定义告警渠道id列表', 'type' => 'array', 'items' => [ 'title' => '自定义告警渠道id', 'description' => '自定义告警渠道id', 'type' => 'string', 'example' => '12345', ], ], 'UserList' => [ 'title' => '告警用户列表', 'description' => '告警用户列表', 'type' => 'array', 'items' => [ 'title' => '用户信息', 'description' => '用户信息', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'Admin', ], ], ], ], 'OnCallTableName' => [ 'title' => '值班表名称', 'description' => '值班表名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'AlertReason' => [ 'title' => '告警原因', 'description' => '告警原因', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'description' => '告警原因类型：'."\n" .'- DQE_COLUMN：字段规则异'."\n" .'- DQE_DATA_SOURCE：数据源规则异常'."\n" .'- DQE_CUSTOMIZE：自定义规则异常'."\n" .'- DQE_TABLE：表规则异常'."\n" .'- DQE_REALTIME_TABLE：实时表规则异常'."\n" .'- DQE_INDEX：指标规则异常'."\n" .'- OS_AVG_RESPONSE：平均响应时间异常'."\n" .'- OS_CALL_TIMES：调用次数异常'."\n" .'- OS_ERROR_RATE：错误率异常'."\n" .'- OS_OFFLINE：Offline百分比异常'."\n" .'- STREAM_BIZ_DELAY：业务延迟过高'."\n" .'- STREAM_DATA_RETENTION：数据滞留超过配置'."\n" .'- STREAM_MORE_THAN_FAILURE：失败频率超过配置'."\n" .'- STREAM_TPS_OUT_RANGE：TPS超过范围'."\n" .'- STREAM_CHECKPOINT_FAILURE：checkpoint失败超过配置'."\n" .'- STREAM_BACKPRESSURE：反压持续时间超过配置'."\n" .'- STREAM_JOB_FAILURE：运行失败'."\n" .'- VDM_BATCH_ERROR：出错'."\n" .'- VDM_BATCH_FINISH：完成'."\n" .'- VDM_BATCH_TIME_OUT：运行超时'."\n" .'- VDM_BATCH_UNDONE：未完成'."\n" .'- VDM_BATCH_LOGIC_DATA_DELAY：数据延迟'."\n" .'- QD_DECISION_CALL_TIMES：决策调用次数异常'."\n" .'- QD_DECISION_MAX_RESPONSE：最大响应时间异常'."\n" .'- QD_DECISION_ERROR_RATE：错误率异常'."\n" .'- QD_DECISION_PARAM_COUNT：决策参数统计次数异常'."\n" .'- QD_DECISION_PARAM_PERCENTAGE：决策参数统计百分比异常'."\n" .'- QD_DECISION_PARAM_SUM：决策参数求和异常'."\n" .'- QD_DECISION_PARAM_AVG：决策参数平均值异常'."\n" .'- LOGICAL_INSTANCE_GENERATION：逻辑实例生成监控'."\n" .'- KGB_TASK_ERROR：基线任务出错'."\n" .'- KGB_TASK_SLOW_DOWN：基线任务变慢'."\n" .'- KGB_EARLY_WARNING：基线预警'."\n" .'- KGB_BROKEN_LINE：基线破线'."\n" ."\n" .'等', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH', ], 'BizDate' => [ 'title' => '业务日期', 'description' => '业务日期', 'type' => 'string', 'example' => '2024-11-05 16:19:32', ], 'UniqueKey' => [ 'title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => 't_6340131422711644160_20241104_6340142', ], 'AlertReasonParamList' => [ 'title' => '告警原因参数列表', 'description' => '告警原因参数列表', 'type' => 'array', 'items' => [ 'title' => '告警原因参数', 'description' => '告警原因参数', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '告警原因参数名', 'description' => '告警原因参数名', 'type' => 'string', 'example' => 'biz_date', ], 'Value' => [ 'title' => '告警原因参数值', 'description' => '告警原因参数值', 'type' => 'string', 'example' => '2024-11-04 00:00:00', ], ], ], ], ], ], 'BelongProject' => [ 'title' => '所属项目', 'description' => '所属项目', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '所属项目名称', 'description' => '所属项目名称', 'type' => 'string', 'example' => 'project_1', ], 'BizName' => [ 'title' => '业务板块名称', 'description' => '业务板块名称', 'type' => 'string', 'example' => 'biz_1', ], ], ], 'Status' => [ 'title' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'description' => '告警状态：'."\n" .'- ALERTING：告警中'."\n" .'- DO_NOT_DISTURB：免打扰'."\n" .'- SILENCING：告警中(静默期)'."\n" .'- FINISH：告警完成', 'type' => 'string', 'example' => 'FINISH', ], 'AlertFrequency' => [ 'title' => '告警频率：'."\n" .'- ONCE：即时告警'."\n" .'- PERIOD：周期告警，格式：1HOUR,1MINUTE,1SECOND', 'description' => '告警频率：'."\n" .'- ONCE：即时告警'."\n" .'- PERIOD：周期告警，格式：1HOUR,1MINUTE,1SECOND', 'type' => 'string', 'example' => 'ONCE', ], 'TotalAlertTimes' => [ 'title' => '告警次数', 'description' => '告警次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DoNotDisturbEndTime' => [ 'title' => '消息免打扰到期时间', 'description' => '消息免打扰到期时间', 'type' => 'string', 'example' => '2024-11-05 00:00:00', ], 'UrlConfig' => [ 'title' => 'Url信息', 'description' => 'Url信息', 'type' => 'object', 'properties' => [ 'ObjectUrl' => [ 'title' => '告警对象页面Url', 'description' => '告警对象页面Url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test1', ], 'LogUrl' => [ 'title' => '日志页面Url', 'description' => '日志页面Url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test2', ], 'AlertConfigUrl' => [ 'title' => '告警配置页面url', 'description' => '告警配置页面url', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test3', ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"AlertEventInfo\\": {\\n \\"Id\\": 12345,\\n \\"AlertObject\\": {\\n \\"SourceSystemType\\": \\"ALL\\",\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"VDM_BATCH_PYTHON37\\"\\n },\\n \\"LatestAlertTime\\": \\"2024-11-05 16:19:33\\",\\n \\"FirstAlertTime\\": \\"2024-11-05 16:19:33\\",\\n \\"AlertReceiverList\\": [\\n {\\n \\"Type\\": \\"OWNER\\",\\n \\"AlertChannelTypeList\\": [\\n \\"SMS\\"\\n ],\\n \\"CustomAlertChannelIdList\\": [\\n \\"12345\\"\\n ],\\n \\"UserList\\": [\\n {\\n \\"Name\\": \\"Admin\\"\\n }\\n ],\\n \\"OnCallTableName\\": \\"test\\"\\n }\\n ],\\n \\"AlertReason\\": {\\n \\"Type\\": \\"VDM_BATCH_FINISH\\",\\n \\"BizDate\\": \\"2024-11-05 16:19:32\\",\\n \\"UniqueKey\\": \\"t_6340131422711644160_20241104_6340142\\",\\n \\"AlertReasonParamList\\": [\\n {\\n \\"Key\\": \\"biz_date\\",\\n \\"Value\\": \\"2024-11-04 00:00:00\\"\\n }\\n ]\\n },\\n \\"BelongProject\\": {\\n \\"ProjectName\\": \\"project_1\\",\\n \\"BizName\\": \\"biz_1\\"\\n },\\n \\"Status\\": \\"FINISH\\",\\n \\"AlertFrequency\\": \\"ONCE\\",\\n \\"TotalAlertTimes\\": 1,\\n \\"DoNotDisturbEndTime\\": \\"2024-11-05 00:00:00\\",\\n \\"UrlConfig\\": {\\n \\"ObjectUrl\\": \\"https://dataphin.com/ops/test1\\",\\n \\"LogUrl\\": \\"https://dataphin.com/ops/test2\\",\\n \\"AlertConfigUrl\\": \\"https://dataphin.com/ops/test3\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '获取告警事件详情', ], 'RevokeDataServiceApi' => [ 'summary' => '回收API授权。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'RevokeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '授权指令', 'description' => '授权指令', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => 'App的ID', 'description' => 'App的ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1203', ], 'ApiId' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021', ], 'Reason' => [ 'title' => '申请原因', 'description' => '申请原因', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '回收数据服务API授权', ], 'PublishDataServiceApi' => [ 'summary' => '发布数据服务API到生产环境。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ApiId', 'in' => 'query', 'schema' => [ 'title' => 'Api编码', 'description' => 'Api编码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => 'Api 版本号', 'description' => 'Api 版本号', 'type' => 'string', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '发布数据服务API', ], 'ListDataServicePublishedApis' => [ 'summary' => '分页查询已发布的API列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'GroupId' => [ 'title' => '分组Id', 'description' => '分组Id', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '102113', ], 'ApiName' => [ 'title' => 'Api名称', 'description' => 'Api名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'ApiList' => [ 'title' => '分页API列表', 'description' => '分页API列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'title' => 'api分组名', 'description' => 'api分组名', 'type' => 'string', 'example' => 'test', ], 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '30012011', ], 'Description' => [ 'title' => 'api描述', 'description' => 'api描述', 'type' => 'string', 'example' => 'test xx', ], 'UpdateRate' => [ 'title' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', 'description' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ApiName' => [ 'title' => 'api名称', 'description' => 'api名称', 'type' => 'string', 'example' => 'test', ], 'ProjectName' => [ 'title' => '服务项目名称', 'description' => '服务项目名称', 'type' => 'string', 'example' => 'test', ], 'AppCount' => [ 'title' => '绑定的应用数', 'description' => '绑定的应用数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Mode' => [ 'title' => '模式：0 basic，1 dev_prod', 'description' => '模式：0 basic，1 dev_prod', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ApplyStatus' => [ 'title' => '申请状态：0 未全部申请：1 已申请、2 无app、需要先申请app', 'description' => '申请状态：0 未全部申请：1 已申请、2 无app、需要先申请app', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ProjectId' => [ 'title' => '数据服务项目ID', 'description' => '数据服务项目ID', 'type' => 'integer', 'format' => 'int32', 'example' => '102101', ], 'GroupId' => [ 'title' => '分组id', 'description' => '分组id', 'type' => 'integer', 'format' => 'int32', 'example' => '102131', ], 'CustomUpdateRate' => [ 'title' => '更新频率自定义内容', 'description' => '更新频率自定义内容', 'type' => 'string', 'example' => '0 0 0/1 * * *', ], 'DeployTime' => [ 'title' => '发布时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '发布时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'Version' => [ 'title' => 'api版本', 'description' => 'api版本', 'type' => 'string', 'example' => '1.0', ], 'LogicUnitNo' => [ 'title' => '服务单元编号', 'description' => '服务单元编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1022', ], 'AppInfoList' => [ 'title' => '所引用的app信息列表', 'description' => '所引用的app信息列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'integer', 'format' => 'int32', 'example' => '10211', ], 'AppKey' => [ 'title' => 'appKey', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'example' => '1201', ], 'AppName' => [ 'title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'example' => 'test', ], ], ], ], 'UpdateTime' => [ 'title' => '修改时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '修改时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'CreateType' => [ 'title' => '创建类型:0自定义模式，1.向导模式，2-直连API', 'description' => '创建类型:0自定义模式，1.向导模式，2-直连API', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'OwnerUserName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => '张三', ], 'CallCount' => [ 'title' => '调用次数', 'description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], 'ExecuteMode' => [ 'title' => '调用类型 1-同步 2-异步', 'description' => '调用类型 1-同步 2-异步', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ApiId' => [ 'title' => 'api编码', 'description' => 'api编码', 'type' => 'integer', 'format' => 'int64', 'example' => '1022', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"ApiList\\": [\\n {\\n \\"GroupName\\": \\"test\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"Description\\": \\"test xx\\",\\n \\"UpdateRate\\": 1,\\n \\"ApiName\\": \\"test\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"AppCount\\": 1,\\n \\"Mode\\": 1,\\n \\"ApplyStatus\\": 1,\\n \\"ProjectId\\": 102101,\\n \\"GroupId\\": 102131,\\n \\"CustomUpdateRate\\": \\"0 0 0/1 * * *\\",\\n \\"DeployTime\\": \\"2025-06-30 08:00:00\\",\\n \\"Version\\": \\"1.0\\",\\n \\"LogicUnitNo\\": 1022,\\n \\"AppInfoList\\": [\\n {\\n \\"AppId\\": 10211,\\n \\"AppKey\\": 1201,\\n \\"AppName\\": \\"test\\"\\n }\\n ],\\n \\"UpdateTime\\": \\"2025-06-30 08:00:00\\",\\n \\"CreateType\\": 1,\\n \\"OwnerUserName\\": \\"张三\\",\\n \\"CallCount\\": 21,\\n \\"ExecuteMode\\": 1,\\n \\"ApiId\\": 1022\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询数据服务已发布API列表', ], 'ListDataServiceMyAppPermissions' => [ 'summary' => '查询当前用户有权限的应用。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'PermissionList' => [ 'title' => '分页权限列表', 'description' => '分页权限列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '1121', ], 'ProjectName' => [ 'title' => '项目名', 'description' => '项目名', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int32', 'example' => '112101', ], 'Creator' => [ 'title' => '创建人ID', 'description' => '创建人ID', 'type' => 'string', 'example' => '1121', ], 'CreateUserName' => [ 'title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => 'test', ], 'AppName' => [ 'title' => 'App名称', 'description' => 'App名称', 'type' => 'string', 'example' => 'test', ], 'Role' => [ 'title' => '角色: 0 负责人', 'description' => '角色: 0 负责人', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'PrivilegeBelongTo' => [ 'title' => '权限归属人', 'description' => '权限归属人', 'type' => 'string', 'example' => '1121', ], 'AppId' => [ 'title' => 'AppId', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021', ], 'PrivilegeFrom' => [ 'title' => '授权来源：0 负责人', 'description' => '授权来源：0 负责人', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OwnerUserName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => 'test', ], 'CurrentUserRole' => [ 'title' => '当前登录用户相对于这条记录的角色: SuperAdmin 当前用户是超管，ProjMan 当前用户对于这条数据是项管，NormalUser 当前用户对于这条数据是普通用户(即非超管且非项管)', 'description' => '当前登录用户相对于这条记录的角色: SuperAdmin 当前用户是超管，ProjMan 当前用户对于这条数据是项管，NormalUser 当前用户对于这条数据是普通用户(即非超管且非项管)', 'type' => 'string', 'example' => 'NormalUser', ], 'RemarkForDebugList' => [ 'title' => '描述，用于排查问题', 'description' => '描述，用于排查问题', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'v1', ], 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'example' => 'k1', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"PermissionList\\": [\\n {\\n \\"Owner\\": \\"1121\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 112101,\\n \\"Creator\\": \\"1121\\",\\n \\"CreateUserName\\": \\"test\\",\\n \\"AppName\\": \\"test\\",\\n \\"Role\\": 0,\\n \\"PrivilegeBelongTo\\": \\"1121\\",\\n \\"AppId\\": 1021,\\n \\"PrivilegeFrom\\": 0,\\n \\"OwnerUserName\\": \\"test\\",\\n \\"CurrentUserRole\\": \\"NormalUser\\",\\n \\"RemarkForDebugList\\": [\\n {\\n \\"Value\\": \\"v1\\",\\n \\"Key\\": \\"k1\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询当前用户有权限数据服务应用列表', ], 'ListDataServiceMyApiPermissions' => [ 'summary' => '获取我管理的API权限列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'PermissionList' => [ 'title' => '分页权限列表', 'description' => '分页权限列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '角色: 0 负责人', 'description' => '角色: 0 负责人', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '1121', ], 'PrivilegeBelongTo' => [ 'title' => '权限归属人', 'description' => '权限归属人', 'type' => 'string', 'example' => '1121', ], 'ApiName' => [ 'title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'teset', ], 'PrivilegeFrom' => [ 'title' => '授权来源：0 负责人', 'description' => '授权来源：0 负责人', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ProjectName' => [ 'title' => '项目名', 'description' => '项目名', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int32', 'example' => '102122', ], 'OwnerUserName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => 'test', ], 'Creator' => [ 'title' => '创建人ID', 'description' => '创建人ID', 'type' => 'string', 'example' => '1121', ], 'ApiId' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1322', ], 'CreateUserName' => [ 'title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"PermissionList\\": [\\n {\\n \\"Role\\": 0,\\n \\"Owner\\": \\"1121\\",\\n \\"PrivilegeBelongTo\\": \\"1121\\",\\n \\"ApiName\\": \\"teset\\",\\n \\"PrivilegeFrom\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 102122,\\n \\"OwnerUserName\\": \\"test\\",\\n \\"Creator\\": \\"1121\\",\\n \\"ApiId\\": 1322,\\n \\"CreateUserName\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询我管理的数据服务API权限列表', ], 'ListDataServiceAuthorizedApps' => [ 'summary' => '查询当前用户有权限的应用列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'AuthorizedAppList' => [ 'title' => '分页App授权列表', 'description' => '分页App授权列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Owner' => [ 'title' => '负责人ID', 'description' => '负责人ID', 'type' => 'string', 'example' => '1121', ], 'RealHasOwnerPrivilege' => [ 'title' => '是否真的有这个app负责人权限（可能因为过期了或者其他情况而无权限）', 'description' => '是否真的有这个app负责人权限（可能因为过期了或者其他情况而无权限）', 'type' => 'boolean', ], 'ExpireDate' => [ 'title' => '有效期，日期格式：yyyy-MM-dd', 'description' => '有效期，日期格式：yyyy-MM-dd', 'type' => 'string', 'example' => '2025-06-30', ], 'ProjectName' => [ 'title' => '项目名', 'description' => '项目名', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int32', 'example' => '102122', ], 'RevocableDetail' => [ 'title' => '这个按钮详细的状态：-1 超管不可交还，-2 负责人无法交还，-3 项管且无实际权限置灰，-4 普通用户没权限不可交还，1 项管且有实际权限可以交还，2 普通用户有权限可以交还', 'description' => '这个按钮详细的状态：-1 超管不可交还，-2 负责人无法交还，-3 项管且无实际权限置灰，-4 普通用户没权限不可交还，1 项管且有实际权限可以交还，2 普通用户有权限可以交还', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', ], 'AppName' => [ 'title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'example' => 'test', ], 'ApplyUserId' => [ 'title' => '权限账号ID（即申请人ID）', 'description' => '权限账号ID（即申请人ID）', 'type' => 'string', 'enumValueTitles' => [], 'example' => '30012101', ], 'ApplyUserName' => [ 'title' => '权限账号（即申请人）', 'description' => '权限账号（即申请人）', 'type' => 'string', 'example' => '测试', ], 'AppId' => [ 'title' => '应用主键id', 'description' => '应用主键id', 'type' => 'integer', 'format' => 'int32', 'example' => '1022', ], 'RealHasPrivilege' => [ 'title' => '是否实际有权限', 'description' => '是否实际有权限', 'type' => 'boolean', ], 'PrivilegeAccount' => [ 'title' => '权限账号：0 个人账号', 'description' => '权限账号：0 个人账号', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OwnerUserName' => [ 'title' => '负责人', 'description' => '负责人', 'type' => 'string', 'example' => 'test', ], 'IsProjectManager' => [ 'title' => '当前用户是否项管', 'description' => '当前用户是否项管', 'type' => 'boolean', ], 'Id' => [ 'title' => '申请ID', 'description' => '申请ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1121', ], 'RemarkForDebugList' => [ 'title' => '描述，用于排查问题', 'description' => '描述，用于排查问题', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Value' => [ 'title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'example' => 'v1', ], 'Key' => [ 'title' => '配置项', 'description' => '配置项', 'type' => 'string', 'example' => 'k1', ], ], ], ], 'Revocable' => [ 'title' => '是否可以交还/回收', 'description' => '是否可以交还/回收', 'type' => 'boolean', ], 'PrivilegeType' => [ 'title' => '权限类型：0 使用权限、1 开发权限', 'description' => '权限类型：0 使用权限、1 开发权限', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"AuthorizedAppList\\": [\\n {\\n \\"Owner\\": \\"1121\\",\\n \\"RealHasOwnerPrivilege\\": true,\\n \\"ExpireDate\\": \\"2025-06-30\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 102122,\\n \\"RevocableDetail\\": -1,\\n \\"AppName\\": \\"test\\",\\n \\"ApplyUserId\\": \\"30012101\\",\\n \\"ApplyUserName\\": \\"测试\\",\\n \\"AppId\\": 1022,\\n \\"RealHasPrivilege\\": true,\\n \\"PrivilegeAccount\\": 0,\\n \\"OwnerUserName\\": \\"test\\",\\n \\"IsProjectManager\\": true,\\n \\"Id\\": 1121,\\n \\"RemarkForDebugList\\": [\\n {\\n \\"Value\\": \\"v1\\",\\n \\"Key\\": \\"k1\\"\\n }\\n ],\\n \\"Revocable\\": true,\\n \\"PrivilegeType\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询当前用户有权限数据服务应用列表', ], 'ListDataServiceApiImpacts' => [ 'summary' => '运维分析：API调用异常影响分析。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'StartTime' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], 'EndTime' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], 'ApiId' => [ 'title' => '调用的apiId', 'description' => '调用的apiId', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021', ], 'OrderColumn' => [ 'title' => '排序列：CALL_COUNT 调用次数、ERROR_COUNT 异常次数、ERROR_RATE 错误率; 默认：CALL_COUNT', 'description' => '排序列：CALL_COUNT 调用次数、ERROR_COUNT 异常次数、ERROR_RATE 错误率; 默认：CALL_COUNT', 'type' => 'string', 'required' => false, 'example' => 'CALL_COUNT', ], 'OrderType' => [ 'title' => '排序方式：1 顺序、2 倒序；默认：1', 'description' => '排序方式：1 顺序、2 倒序；默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'AppName' => [ 'title' => 'app名称', 'description' => 'app名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'ImpactList' => [ 'title' => 'API影响分析列表', 'description' => 'API影响分析列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ClientFailCount' => [ 'title' => '客户端失败数', 'description' => '客户端失败数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalTimeCost' => [ 'title' => '接口总耗时(包括失败的)', 'description' => '接口总耗时(包括失败的)', 'type' => 'string', 'example' => '231', ], 'SuccessTimeCost' => [ 'title' => '成功调用的总耗时', 'description' => '成功调用的总耗时', 'type' => 'string', 'example' => '99', ], 'ErrorCount' => [ 'title' => '异常次数', 'description' => '异常次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ClientIp' => [ 'title' => '访问来源IP', 'description' => '访问来源IP', 'type' => 'string', 'example' => '192.168.1.1', ], 'AppName' => [ 'title' => 'app名称', 'description' => 'app名称', 'type' => 'string', 'example' => 'test', ], 'ErrorApiCount' => [ 'title' => 'api调用异常数', 'description' => 'api调用异常数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalCount' => [ 'title' => '调用总数', 'description' => '调用总数', 'type' => 'integer', 'format' => 'int64', 'example' => '88', ], 'LastCallTime' => [ 'title' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'Minute' => [ 'title' => '网关统计时间: yyyy_MMdd_HHmm', 'description' => '网关统计时间: yyyy_MMdd_HHmm', 'type' => 'string', 'example' => '2025_0611_1011', ], 'OfflineCount' => [ 'title' => '离线数', 'description' => '离线数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'AppKey' => [ 'title' => 'appKey', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'example' => '1101', ], 'CallCount' => [ 'title' => '调用次数', 'description' => '调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '11', ], 'ApiId' => [ 'title' => 'apiNo', 'description' => 'apiNo', 'type' => 'integer', 'format' => 'int64', 'example' => '2011', ], 'ErrorRate' => [ 'title' => '错误率', 'description' => '错误率', 'type' => 'string', 'example' => '10.0', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"ImpactList\\": [\\n {\\n \\"ClientFailCount\\": 2,\\n \\"TotalTimeCost\\": \\"231\\",\\n \\"SuccessTimeCost\\": \\"99\\",\\n \\"ErrorCount\\": 1,\\n \\"ClientIp\\": \\"192.168.1.1\\",\\n \\"AppName\\": \\"test\\",\\n \\"ErrorApiCount\\": 1,\\n \\"TotalCount\\": 88,\\n \\"LastCallTime\\": \\"2025-06-30 08:00:00\\",\\n \\"Minute\\": \\"2025_0611_1011\\",\\n \\"OfflineCount\\": 1,\\n \\"AppKey\\": 1101,\\n \\"CallCount\\": 11,\\n \\"ApiId\\": 2011,\\n \\"ErrorRate\\": \\"10.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询数据服务API异常调用影响', ], 'ListDataServiceApiCalls' => [ 'summary' => '分页查询数据服务调用日志。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'AppKey' => [ 'title' => 'appKey', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1021', ], 'ApiName' => [ 'title' => 'api名称', 'description' => 'api名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'ApiId' => [ 'title' => 'api编码', 'description' => 'api编码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20122', ], 'StartTime' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], 'EndTime' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], 'ClientIp' => [ 'title' => 'IP地址', 'description' => 'IP地址', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1', ], 'Successful' => [ 'title' => '成功/失败', 'description' => '成功/失败', 'type' => 'boolean', 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '68', ], 'CallLogList' => [ 'title' => '分页API调用列表', 'description' => '分页API调用列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'title' => '请求结束时间, 格式：yyyy-MM-dd HH:mm:ss.SSS', 'description' => '请求结束时间, 格式：yyyy-MM-dd HH:mm:ss.SSS', 'type' => 'string', 'example' => '2024-11-01 01:01:03.000', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ResultCount' => [ 'title' => '返回数据条数', 'description' => '返回数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Env' => [ 'title' => '环境：0 dev，1 prod', 'description' => '环境：0 dev，1 prod', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ClientIp' => [ 'title' => '请求IP', 'description' => '请求IP', 'type' => 'string', 'example' => '192.168.1.1', ], 'AppName' => [ 'title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'example' => 'test', ], 'CostTime' => [ 'title' => '请求耗时(ms)', 'description' => '请求耗时(ms)', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'ResponseSize' => [ 'title' => '响应大小', 'description' => '响应大小', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'ResponseParameter' => [ 'title' => '返回参数', 'description' => '返回参数', 'type' => 'string', 'example' => '{"code":"200","message":"success"}', ], 'AppKey' => [ 'title' => '应用Key', 'description' => '应用Key', 'type' => 'integer', 'format' => 'int64', 'example' => '201211', ], 'HttpStatusCode' => [ 'title' => 'http 状态码', 'description' => 'http 状态码', 'type' => 'string', 'example' => '200', ], 'BizCodeDescription' => [ 'title' => '业务状态码描述', 'description' => '业务状态码描述', 'type' => 'string', 'example' => 'OK', ], 'ExecuteMode' => [ 'title' => '执行模式 1-同步 2-异步', 'description' => '执行模式 1-同步 2-异步', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'JobId' => [ 'title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '102356', ], 'HttpStatusDescription' => [ 'title' => '状态码描述', 'description' => '状态码描述', 'type' => 'string', 'example' => 'OK', ], 'BizCode' => [ 'title' => '业务状态码', 'description' => '业务状态码', 'type' => 'string', 'example' => 'OK', ], 'Status' => [ 'title' => '任务调用状态', 'description' => '任务调用状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '1234567890-232sds-3e232-ae2e232', ], 'ApiName' => [ 'title' => 'api名称', 'description' => 'api名称', 'type' => 'string', 'example' => 'test', ], 'RequestParameter' => [ 'title' => '请求参数', 'description' => '请求参数', 'type' => 'string', 'example' => '{"name":"test"}', ], 'RequestSize' => [ 'title' => '请求大小', 'description' => '请求大小', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'StartTime' => [ 'title' => '请求开始时间, 格式：yyyy-MM-dd HH:mm:ss.SSS', 'description' => '请求开始时间, 格式：yyyy-MM-dd HH:mm:ss.SSS', 'type' => 'string', 'example' => '2024-11-01 01:01:01.000', ], 'ProjectId' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int32', 'example' => '102356', ], 'Successful' => [ 'title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', ], 'Sql' => [ 'title' => 'sql语句', 'description' => 'sql语句', 'type' => 'string', 'example' => 'select col1 from t_test1 limit 100;', ], 'ExecuteCostTime' => [ 'title' => '执行耗时', 'description' => '执行耗时', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'ApiId' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'example' => '102112', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"CallLogList\\": [\\n {\\n \\"EndTime\\": \\"2024-11-01 01:01:03.000\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"ResultCount\\": 1,\\n \\"Env\\": 1,\\n \\"ClientIp\\": \\"192.168.1.1\\",\\n \\"AppName\\": \\"test\\",\\n \\"CostTime\\": 2000,\\n \\"ResponseSize\\": 1024,\\n \\"ResponseParameter\\": \\"{\\\\\\"code\\\\\\":\\\\\\"200\\\\\\",\\\\\\"message\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"AppKey\\": 201211,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"BizCodeDescription\\": \\"OK\\",\\n \\"ExecuteMode\\": 1,\\n \\"JobId\\": \\"102356\\",\\n \\"HttpStatusDescription\\": \\"OK\\",\\n \\"BizCode\\": \\"OK\\",\\n \\"Status\\": 1,\\n \\"RequestId\\": \\"1234567890-232sds-3e232-ae2e232\\",\\n \\"ApiName\\": \\"test\\",\\n \\"RequestParameter\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RequestSize\\": 1024,\\n \\"StartTime\\": \\"2024-11-01 01:01:01.000\\",\\n \\"ProjectId\\": 102356,\\n \\"Successful\\": true,\\n \\"Sql\\": \\"select col1 from t_test1 limit 100;\\",\\n \\"ExecuteCostTime\\": 1000,\\n \\"ApiId\\": 102112\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询数据服务调用日志', ], 'ListDataServiceApiCallStatistics' => [ 'summary' => '运维分析：API调用统计信息。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '检索条件', 'description' => '检索条件', 'type' => 'object', 'properties' => [ 'OrderColumn' => [ 'title' => '排序列：CALL_COUNT 调用次数、ERROR_COUNT 异常次数、ERROR_RATE 错误率, AVG_RESPONSE_TIME 平均响应时长、OFFLINE_RATE offline百分比; 默认：CALL_COUNT', 'description' => '排序列：CALL_COUNT 调用次数、ERROR_COUNT 异常次数、ERROR_RATE 错误率, AVG_RESPONSE_TIME 平均响应时长、OFFLINE_RATE offline百分比; 默认：CALL_COUNT', 'type' => 'string', 'required' => false, 'example' => 'CALL_COUNT', ], 'OrderType' => [ 'title' => '排序方式：1 顺序、2 倒序；默认：1', 'description' => '排序方式：1 顺序、2 倒序；默认：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Keyword' => [ 'title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'StartTime' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], 'EndTime' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], 'PageNo' => [ 'title' => '页码, 默认1', 'description' => '页码, 默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'PageSize' => [ 'title' => '分页记录数, 默认20', 'description' => '分页记录数, 默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'PageResult' => [ 'title' => '分页查询结果', 'description' => '分页查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '68', ], 'CallStatisticsList' => [ 'title' => 'API调用统计分析列表', 'description' => 'API调用统计分析列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ApiName' => [ 'title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'test', ], 'ProjectName' => [ 'title' => '数据服务项目', 'description' => '数据服务项目', 'type' => 'string', 'example' => 'test', ], 'AppNameList' => [ 'title' => '', 'description' => '授权应用名称', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '授权应用名称', 'type' => 'string', 'example' => '授权应用名称', ], ], 'ProjectId' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'example' => '101201', ], 'Creator' => [ 'title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '30012011', ], 'ErrorCount' => [ 'title' => '调用异常次数', 'description' => '调用异常次数', 'type' => 'string', 'example' => '22', ], 'AuthorizedAppCount' => [ 'title' => '授权应用数', 'description' => '授权应用数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SqlId' => [ 'title' => 'sql表主键', 'description' => 'sql表主键', 'type' => 'integer', 'format' => 'int32', 'example' => '1121', ], 'OfflineRate' => [ 'title' => 'offline百分比', 'description' => 'offline百分比', 'type' => 'string', 'example' => '23.2%', ], 'LastCallTime' => [ 'title' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-06-30 08:00:00', ], 'CallCount' => [ 'title' => '调用次数', 'description' => '调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'AvgResponseTime' => [ 'title' => '平均响应时长, 单位毫秒', 'description' => '平均响应时长, 单位毫秒', 'type' => 'number', 'format' => 'double', 'example' => '11', ], 'ApiId' => [ 'title' => 'api编码', 'description' => 'api编码', 'type' => 'integer', 'format' => 'int64', 'example' => '1003', ], 'ErrorRate' => [ 'title' => '错误率', 'description' => '错误率', 'type' => 'string', 'example' => '23.2%', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"CallStatisticsList\\": [\\n {\\n \\"ApiName\\": \\"test\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"AppNameList\\": [\\n \\"授权应用名称\\"\\n ],\\n \\"ProjectId\\": 101201,\\n \\"Creator\\": \\"30012011\\",\\n \\"ErrorCount\\": \\"22\\",\\n \\"AuthorizedAppCount\\": 1,\\n \\"SqlId\\": 1121,\\n \\"OfflineRate\\": \\"23.2%\\",\\n \\"LastCallTime\\": \\"2025-06-30 08:00:00\\",\\n \\"CallCount\\": 100,\\n \\"AvgResponseTime\\": 11,\\n \\"ApiId\\": 1003,\\n \\"ErrorRate\\": \\"23.2%\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页查询API调用统计', ], 'GrantDataServiceApi' => [ 'summary' => 'API授权。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'GrantCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '授权指令', 'description' => '授权指令', 'type' => 'object', 'properties' => [ 'ExpireDate' => [ 'title' => '有效期，日期格式：yyyy-MM-dd', 'description' => '有效期，日期格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-30', ], 'Reason' => [ 'title' => '申请原因', 'description' => '申请原因', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'ApiId' => [ 'title' => 'API编号', 'description' => 'API编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021', ], 'AppId' => [ 'title' => 'AppID', 'description' => 'AppID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1201', ], 'ProdFieldList' => [ 'title' => 'PROD权限字段列表，basic模式下查询类API必填，操作类API无需填写', 'description' => 'PROD权限字段列表，basic模式下查询类API必填，操作类API无需填写', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Api权限字段id', 'description' => 'Api权限字段id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], 'DevFieldList' => [ 'title' => 'DEV权限字段列表，dev-prod模式下才需要填，查询类API devFieldList、prodFieldList至少填写1个，操作类API无需填写', 'description' => 'DEV权限字段列表，dev-prod模式下才需要填，查询类API devFieldList、prodFieldList至少填写1个，操作类API无需填写', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Api权限字段id', 'description' => 'Api权限字段id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], 'ApplyDev' => [ 'title' => '是否申请操作类API的开发环境权限', 'description' => '是否申请操作类API的开发环境权限', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'ApplyProd' => [ 'title' => '是否申请操作类API的生产环境权限', 'description' => '是否申请操作类API的生产环境权限', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '数据服务API授权', ], 'GetDataServiceProjectAddableUsers' => [ 'summary' => '获取可添加到项目成员的用户列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'UserList' => [ 'title' => '项目成员列表', 'description' => '项目成员列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30012011', ], 'DisplayName' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'test', ], 'AccountName' => [ 'title' => '用户账号', 'description' => '用户账号', 'type' => 'string', 'example' => 'xx@aliyuncs.com', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"UserList\\": [\\n {\\n \\"UserId\\": \\"30012011\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"AccountName\\": \\"xx@aliyuncs.com\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据服务可添加到项目成员用户列表', ], 'GetDataServiceMyProjects' => [ 'summary' => '获取当前用户作为负责人的项目列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ProjectList' => [ 'title' => '数据服务项目列表', 'description' => '数据服务项目列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '角色：1 超管,2 开发用户,3 应用成员,4 服务项目管理员，5.运维用户', 'description' => '角色：1 超管,2 开发用户,3 应用成员,4 服务项目管理员，5.运维用户', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'example' => '102011', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ProjectList\\": [\\n {\\n \\"Role\\": 1,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 102011\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取当前用户作为负责人数据服务项目列表', ], 'GetDataServiceAuthorizedProjects' => [ 'summary' => '查询有权限的项目列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ProjectList' => [ 'title' => '项目列表', 'description' => '项目列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '用户角色: 2 开发用户,3 应用成员,4 服务项目管理员，5 运维用户', 'description' => '用户角色: 1 超管,2 开发用户,3 应用成员,4 服务项目管理员，5.运维用户', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test', ], 'ProjectId' => [ 'title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int32', 'example' => '1011', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ProjectList\\": [\\n {\\n \\"Role\\": 2,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 1011\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取当前用户有权限数据服务项目列表', ], 'GetDataServiceAuthorizedAppsByGroupId' => [ 'summary' => '根据App分组Id查询账号有权限的应用列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'title' => 'App分组Id', 'description' => 'App分组Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '202102', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'AppInfoList' => [ 'title' => 'Api分组列表', 'description' => 'Api分组列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AppKey' => [ 'title' => 'AppKey', 'description' => 'AppKey', 'type' => 'integer', 'format' => 'int64', 'example' => '202212', ], 'Id' => [ 'title' => 'AppId', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021', ], 'Name' => [ 'title' => 'App名称', 'description' => 'App名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"AppInfoList\\": [\\n {\\n \\"AppKey\\": 202212,\\n \\"Id\\": 1021,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取账号有权限的数据服务应用列表', ], 'GetDataServiceAppsByGroupId' => [ 'summary' => '查询分组下应用列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'title' => 'App分组Id', 'description' => 'App分组Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '202102', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'AppInfoList' => [ 'title' => 'Api分组列表', 'description' => 'Api分组列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'AppId', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021', ], 'Name' => [ 'title' => 'App名称', 'description' => 'App名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"AppInfoList\\": [\\n {\\n \\"Id\\": 1021,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '根据应用分组Id获取数据服务应用列表', ], 'GetDataServiceAppGroups' => [ 'summary' => '查询数据服务项目的应用分组列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'AppGroupList' => [ 'title' => 'App分组列表', 'description' => 'App分组列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '分组ID', 'description' => '分组ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1022', ], 'Name' => [ 'title' => '分组名字', 'description' => '分组名字', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"AppGroupList\\": [\\n {\\n \\"Id\\": 1022,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据服务应用分组列表', ], 'GetDataServiceAppAuthorizedUsers' => [ 'summary' => '获取应用有权限的用户列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => 'AppId', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1022', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'UserList' => [ 'title' => '用户列表', 'description' => '用户列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => [ 'title' => '展示名', 'description' => '展示名', 'type' => 'string', 'example' => 'test', ], 'Id' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '30002101', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"UserList\\": [\\n {\\n \\"DisplayName\\": \\"test\\",\\n \\"Id\\": \\"30002101\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取有数据服务应用权限的用户列表', ], 'GetDataServiceApiGroups' => [ 'summary' => '查询数据服务API分组列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ApiGroupList' => [ 'title' => 'Api分组列表', 'description' => 'Api分组列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '分组ID', 'description' => '分组ID', 'type' => 'integer', 'format' => 'int32', 'example' => '101231', ], 'Name' => [ 'title' => '分组名', 'description' => '分组名', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ApiGroupList\\": [\\n {\\n \\"Id\\": 101231,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据服务API分组列表', ], 'GetDataServiceApiErrorImpact' => [ 'summary' => '获取API异常影响汇总。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '调用异常影响汇总', 'description' => '调用异常影响汇总', 'type' => 'object', 'properties' => [ 'ErrorAppList' => [ 'title' => '异常影响的APP', 'description' => '异常影响的APP', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => 'appId', 'description' => 'appId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021', ], 'AppKey' => [ 'title' => 'appKey', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'example' => '100211', ], 'ErrorCount' => [ 'title' => 'app异常数', 'description' => 'app异常数', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'AppName' => [ 'title' => 'app名称', 'description' => 'app名称', 'type' => 'string', 'example' => 'app1', ], ], ], ], 'ErrorApiList' => [ 'title' => '异常影响API', 'description' => '异常影响API', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => 'api编码', 'description' => 'api编码', 'type' => 'integer', 'format' => 'int64', 'example' => '2012', ], 'ApiName' => [ 'title' => 'api名称', 'description' => 'api名称', 'type' => 'string', 'example' => 'test', ], 'ErrorCount' => [ 'title' => 'api异常数', 'description' => 'api异常数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"ErrorAppList\\": [\\n {\\n \\"AppId\\": 1021,\\n \\"AppKey\\": 100211,\\n \\"ErrorCount\\": 10,\\n \\"AppName\\": \\"app1\\"\\n }\\n ],\\n \\"ErrorApiList\\": [\\n {\\n \\"AppId\\": 2012,\\n \\"ApiName\\": \\"test\\",\\n \\"ErrorCount\\": 100\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取数据服务API异常影响', ], 'GetDataServiceApiDocument' => [ 'summary' => '获取API文档。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102101', ], ], [ 'name' => 'VersionId', 'in' => 'query', 'schema' => [ 'title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => 'Api文档', 'description' => 'Api文档', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'api名称', 'description' => 'api名称', 'type' => 'string', 'example' => '测试', ], 'GroupId' => [ 'title' => 'api分组Id', 'description' => 'api分组Id', 'type' => 'integer', 'format' => 'int32', 'example' => '1011', ], 'GroupName' => [ 'title' => 'api分组名称', 'description' => 'api分组名称', 'type' => 'string', 'example' => '1011', ], 'RequestMethod' => [ 'title' => '请求方法: 1 get、2 list', 'description' => '请求方法: 1 get、2 list', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UpdateRate' => [ 'title' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', 'description' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test', ], 'ReturnType' => [ 'title' => '返回数据类型: 1 JSON', 'description' => '返回数据类型: 1 JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Protocol' => [ 'title' => '协议: 1 https、2 http、3 http和https两者', 'description' => '协议: 1 https、2 http、3 http和https两者', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Sql' => [ 'title' => 'sql语句', 'description' => 'sql语句', 'type' => 'string', 'example' => 'select col1 from table1;', ], 'RequestParamList' => [ 'title' => '请求参数列表', 'description' => '请求参数列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => '1', ], 'Type' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'string', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '测试', ], 'IsRequired' => [ 'title' => '请求参数是否必填：1、是， 0、选填', 'description' => '请求参数是否必填：1、是， 0、选填', 'type' => 'boolean', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'col1', ], ], ], ], 'ResponseParamList' => [ 'title' => '响应参数列表', 'description' => '响应参数列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'string', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '测试', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'col1', ], ], ], ], 'PublicParamList' => [ 'title' => '公共参数列表', 'description' => '公共参数列表', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'string', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '测试', ], 'IsRequired' => [ 'title' => '请求参数是否必填：1、是， 0、选填', 'description' => '请求参数是否必填：1、是， 0、选填', 'type' => 'boolean', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'col1', ], ], ], ], 'IsSpecialSql' => [ 'title' => '特殊sql: 0 不是、1 是', 'description' => '特殊sql: 0 不是、1 是', 'type' => 'boolean', ], 'CreateType' => [ 'title' => '创建类型: 0 自定义模式、1 向导模式、2-直连API', 'description' => '创建类型: 0 自定义模式、1 向导模式、2-直连API', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ApiId' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'example' => '102101', ], 'Mode' => [ 'title' => '模式：0 basic、1 dev_prod', 'description' => '模式：0 basic、1 dev_prod', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Env' => [ 'title' => '环境：0 dev，1 prod', 'description' => '环境：0 dev，1 prod', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ResultSample' => [ 'title' => '调用结果样例', 'description' => '调用结果样例', 'type' => 'string', 'example' => '{"count": 88}', ], 'BizUnitName' => [ 'title' => '业务板块名(仅逻辑表时有值)', 'description' => '业务板块名(仅逻辑表时有值)', 'type' => 'string', 'example' => 'bizUnit_test', ], 'TableName' => [ 'title' => '逻辑表名(仅逻辑表时有值)', 'description' => '逻辑表名(仅逻辑表时有值)', 'type' => 'string', 'example' => 't_logical_test1', ], 'IsLogicalTable' => [ 'title' => '是否逻辑表', 'description' => '是否逻辑表', 'type' => 'boolean', ], 'DirectDatasourceId' => [ 'title' => '直连API的数据源ID', 'description' => '直连API的数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DirectDatasourceName' => [ 'title' => '直连API的数据源名称', 'description' => '直连API的数据源名称', 'type' => 'string', 'example' => 'test', ], 'ApiTimeout' => [ 'title' => '直连Api超时时长(s)', 'description' => '直连Api超时时长(s)', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'ReturnLimit' => [ 'title' => '直连Api最大返回记录数', 'description' => '直连Api最大返回记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ProjectId' => [ 'title' => '数据服务项目id', 'description' => '数据服务项目id', 'type' => 'integer', 'format' => 'int32', 'example' => '10201', ], 'ProjectName' => [ 'title' => '数据服务项目名称', 'description' => '数据服务项目名称', 'type' => 'string', 'example' => 'test', ], 'ResourceGroupId' => [ 'title' => '资源组Id', 'description' => '资源组Id', 'type' => 'string', 'example' => '10021', ], 'ResourceGroupName' => [ 'title' => '资源组名', 'description' => '资源组名', 'type' => 'string', 'example' => 'test', ], 'OpenCache' => [ 'title' => '缓存开关：0 关，1 开', 'description' => '缓存开关：0 关，1 开', 'type' => 'boolean', ], 'CacheTime' => [ 'title' => '缓存时长（秒）', 'description' => '缓存时长（秒）', 'type' => 'string', 'example' => '600', ], 'Timeout' => [ 'title' => '超时时长（秒）', 'description' => '超时时长（秒）', 'type' => 'string', 'example' => '60', ], 'ScriptType' => [ 'title' => '脚本类型: NORMAL_SQL 基础SQL、MYBATIS_SQL 高级SQL、AVIATOR aviator表达式', 'description' => '脚本类型: NORMAL_SQL 基础SQL、MYBATIS_SQL 高级SQL、AVIATOR aviator表达式', 'type' => 'string', 'example' => 'NORMAL_SQL', ], 'ApiRegisterInfo' => [ 'title' => 'Api注册信息', 'description' => 'Api注册信息', 'type' => 'object', 'properties' => [ 'Mode' => [ 'title' => '模式：0 basic、1 dev_prod', 'description' => '模式：0 basic、1 dev_prod', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HttpMethod' => [ 'title' => '注册API请求方式：1 get、2 post', 'description' => '注册API请求方式：1 get、2 post', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'DatasourceId' => [ 'title' => 'API数据源ID', 'description' => 'API数据源ID', 'type' => 'string', 'example' => '102311', ], 'DatasourceName' => [ 'title' => 'API数据源名称', 'description' => 'API数据源名称', 'type' => 'string', 'example' => 'test', ], 'Url' => [ 'title' => 'API数据源URL地址', 'description' => 'API数据源URL地址', 'type' => 'string', 'example' => 'http://192.168.1.1:8080', ], 'AuthType' => [ 'title' => 'API数据源认证方式: 1 BearToken、2 ApiKey、3 None、4 AppKeyAuth、5 BasicAuth', 'description' => 'API数据源认证方式: 1 BearToken、2 ApiKey、3 None、4 AppKeyAuth、5 BasicAuth', 'type' => 'string', 'example' => '3', ], 'Protocol' => [ 'title' => 'API数据源请求协议', 'description' => 'API数据源请求协议', 'type' => 'string', 'example' => 'https', ], 'Path' => [ 'title' => '服务path', 'description' => '服务path', 'type' => 'string', 'example' => '/api/test', ], 'Timeout' => [ 'title' => '超时时长(秒)', 'description' => '超时时长(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], ], ], 'Version' => [ 'title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1.0', ], 'IsPagedQuery' => [ 'title' => '是否是分页查询: 1 是、0 否', 'description' => '是否是分页查询: 1 是、0 否', 'type' => 'boolean', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"Name\\": \\"测试\\",\\n \\"GroupId\\": 1011,\\n \\"GroupName\\": \\"1011\\",\\n \\"RequestMethod\\": 1,\\n \\"UpdateRate\\": 1,\\n \\"Description\\": \\"test\\",\\n \\"ReturnType\\": 1,\\n \\"Protocol\\": 1,\\n \\"Sql\\": \\"select col1 from table1;\\",\\n \\"RequestParamList\\": [\\n {\\n \\"DefaultValue\\": \\"1\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"测试\\",\\n \\"IsRequired\\": true,\\n \\"Sample\\": \\"test\\",\\n \\"Name\\": \\"col1\\"\\n }\\n ],\\n \\"ResponseParamList\\": [\\n {\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"测试\\",\\n \\"Sample\\": \\"test\\",\\n \\"Name\\": \\"col1\\"\\n }\\n ],\\n \\"PublicParamList\\": [\\n {\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"测试\\",\\n \\"IsRequired\\": true,\\n \\"Sample\\": \\"test\\",\\n \\"Name\\": \\"col1\\"\\n }\\n ],\\n \\"IsSpecialSql\\": true,\\n \\"CreateType\\": 1,\\n \\"ApiId\\": 102101,\\n \\"Mode\\": 1,\\n \\"Env\\": 1,\\n \\"ResultSample\\": \\"{\\\\\\"count\\\\\\": 88}\\",\\n \\"BizUnitName\\": \\"bizUnit_test\\",\\n \\"TableName\\": \\"t_logical_test1\\",\\n \\"IsLogicalTable\\": true,\\n \\"DirectDatasourceId\\": 1,\\n \\"DirectDatasourceName\\": \\"test\\",\\n \\"ApiTimeout\\": 60,\\n \\"ReturnLimit\\": 100,\\n \\"ProjectId\\": 10201,\\n \\"ProjectName\\": \\"test\\",\\n \\"ResourceGroupId\\": \\"10021\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"OpenCache\\": true,\\n \\"CacheTime\\": \\"600\\",\\n \\"Timeout\\": \\"60\\",\\n \\"ScriptType\\": \\"NORMAL_SQL\\",\\n \\"ApiRegisterInfo\\": {\\n \\"Mode\\": 1,\\n \\"HttpMethod\\": 2,\\n \\"DatasourceId\\": \\"102311\\",\\n \\"DatasourceName\\": \\"test\\",\\n \\"Url\\": \\"http://192.168.1.1:8080\\",\\n \\"AuthType\\": \\"3\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Path\\": \\"/api/test\\",\\n \\"Timeout\\": 60\\n },\\n \\"Version\\": \\"1.0\\",\\n \\"IsPagedQuery\\": true\\n }\\n}","type":"json"}]', 'title' => '获取API文档详情', ], 'GetDataServiceApiCallTrend' => [ 'summary' => '运维监控：Api访问趋势分析。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '访问趋势', 'description' => '访问趋势', 'type' => 'object', 'properties' => [ 'CallErrorTrendList' => [ 'title' => '调用异常趋势，按分钟升序', 'description' => '调用异常趋势，按分钟升序', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Minute' => [ 'title' => '分钟，格式：yyyy_MMdd_HHmm', 'description' => '分钟，格式：yyyy_MMdd_HHmm', 'type' => 'string', 'example' => '3', ], 'CallCount' => [ 'title' => '调用次数', 'description' => '调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1021', ], 'ErrorCount' => [ 'title' => '调用异常次数', 'description' => '调用异常次数', 'type' => 'integer', 'format' => 'int64', 'example' => '102', ], ], ], ], 'CallErrorImpactTrendList' => [ 'title' => '调用异常影响趋势，按分钟升序', 'description' => '调用异常影响趋势，按分钟升序', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'ErrorApiCount' => [ 'title' => '调用异常API数', 'description' => '调用异常API数', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Minute' => [ 'title' => '时间刻度，分钟：yyyy-MM-dd HH:mm', 'description' => '时间刻度，分钟：yyyy-MM-dd HH:mm', 'type' => 'string', 'example' => '2025-06-30 08:00', ], 'ErrorAppCount' => [ 'title' => '影响APP数', 'description' => '影响APP数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ApiIdList' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'array', 'items' => [ 'title' => 'Api编号', 'description' => 'Api编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1203', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"CallErrorTrendList\\": [\\n {\\n \\"Minute\\": \\"3\\",\\n \\"CallCount\\": 1021,\\n \\"ErrorCount\\": 102\\n }\\n ],\\n \\"CallErrorImpactTrendList\\": [\\n {\\n \\"ErrorApiCount\\": 5,\\n \\"Minute\\": \\"2025-06-30 08:00\\",\\n \\"ErrorAppCount\\": 1,\\n \\"ApiIdList\\": [\\n 1203\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取数据服务Api访问趋势分析', ], 'GetDataServiceApiCallSummary' => [ 'summary' => '运维监控：获取Api调用汇总统计。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'description' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'Data' => [ 'title' => '调用汇总', 'description' => '调用汇总', 'type' => 'object', 'properties' => [ 'CallCount' => [ 'title' => 'API调用次数', 'description' => 'API调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1021', ], 'ErrorCount' => [ 'title' => '调用异常次数', 'description' => '调用异常次数', 'type' => 'integer', 'format' => 'int64', 'example' => '102', ], 'ErrorRate' => [ 'title' => '错误率', 'description' => '错误率', 'type' => 'number', 'format' => 'double', 'example' => '10.01', ], 'OfflineRate' => [ 'title' => 'offline百分比', 'description' => 'offline百分比', 'type' => 'number', 'format' => 'double', 'example' => '2.03', ], 'ErrorApiCount' => [ 'title' => '调用异常API数', 'description' => '调用异常API数', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'ErrorAppCount' => [ 'title' => '异常影响APP数', 'description' => '异常影响APP数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"CallCount\\": 1021,\\n \\"ErrorCount\\": 102,\\n \\"ErrorRate\\": 10.01,\\n \\"OfflineRate\\": 2.03,\\n \\"ErrorApiCount\\": 8,\\n \\"ErrorAppCount\\": 2\\n }\\n}","type":"json"}]', 'title' => '获取数据服务Api调用汇总', ], 'ApplyDataServiceApp' => [ 'summary' => '申请应用权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ApplyCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '申请指令', 'description' => '申请指令', 'type' => 'object', 'properties' => [ 'ExpireDate' => [ 'title' => '有效期，日期格式：yyyy-MM-dd', 'description' => '有效期，日期格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-30', ], 'Reason' => [ 'title' => '申请原因', 'description' => '申请原因', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'AppId' => [ 'title' => 'appId', 'description' => 'appId', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2011', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '申请数据服务应用权限', ], 'ApplyDataServiceApi' => [ 'summary' => '申请API权限。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'ApplyCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '申请指令', 'description' => '申请指令', 'type' => 'object', 'properties' => [ 'ExpireDate' => [ 'title' => '有效期，日期格式：yyyy-MM-dd', 'description' => '有效期，日期格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-30', ], 'Reason' => [ 'title' => '申请原因', 'description' => '申请原因', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'ApiId' => [ 'title' => 'API编号', 'description' => 'API编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021', ], 'AppId' => [ 'title' => 'AppId', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1203', ], 'ProdFieldList' => [ 'title' => 'PROD权限字段列表,basic模式下必填', 'description' => 'PROD权限字段列表,basic模式下必填', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Api权限字段id', 'description' => 'Api权限字段id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '22', ], ], 'required' => false, ], 'required' => false, ], 'DevFieldList' => [ 'title' => 'DEV权限字段列表，dev-prod模式下才需要填且devFieldList、prodFieldList至少填写1个', 'description' => 'DEV权限字段列表，dev-prod模式下才需要填且devFieldList、prodFieldList至少填写1个', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Api权限字段id', 'description' => 'Api权限字段id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '22', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '申请数据服务API权限', ], 'AddDataServiceProjectMember' => [ 'summary' => '添加数据服务项目用户并设置角色。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '数据服务项目Id', 'description' => '数据服务项目Id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102', ], ], [ 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '新增项目成员指令', 'description' => '新增项目成员指令', 'type' => 'object', 'properties' => [ 'ProjectMemberList' => [ 'title' => '新增项目成员列表', 'description' => '新增项目成员列表', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '用户角色: 2 开发用户,3 应用成员,4 服务项目管理员，5 运维用户', 'description' => '用户角色: 2 开发用户,3 应用成员,4 服务项目管理员，5 运维用户', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], 'UserId' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'required' => true, 'example' => '30012011', ], 'DisplayName' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'AccountName' => [ 'title' => '用户账号', 'description' => '用户账号', 'type' => 'string', 'required' => true, 'example' => 'xx@aliyuncs.com', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', 'title' => '新增数据服务项目成员', ], 'CreateDataServiceApi' => [ 'summary' => '创建新的数据服务API并提交。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => 'API信息', 'description' => '新建API请求', 'type' => 'object', 'properties' => [ 'ApiName' => [ 'title' => 'Api的名称', 'description' => 'Api的名称', 'type' => 'string', 'required' => true, 'example' => 'API_01', ], 'Version' => [ 'title' => 'api初始版本名称', 'description' => 'Api的版本', 'type' => 'string', 'required' => true, 'example' => 'V1', ], 'ApiType' => [ 'title' => 'Api的类型：'."\n" .'- 3：数据源SQL模式', 'description' => 'Api的类型：'."\n" ."\n" .'- 3：数据源SQL模式', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'enumValueTitles' => [], 'example' => '3', ], 'Mode' => [ 'title' => 'Api的开发模式：'."\n" .'- 0：Basic模式 '."\n" .'- 1：Dev-Prod模式', 'description' => 'Api的开发模式：'."\n" ."\n" .'- 0：Basic模式 '."\n" .'- 1：Dev-Prod模式', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'ProjectId' => [ 'title' => '数据服务项目ID', 'description' => '数据服务项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], 'ApiGroupId' => [ 'title' => 'Api分组ID', 'description' => 'Api的分组ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101', ], 'ApiGroupName' => [ 'title' => 'Api分组名称', 'description' => 'Api的分组名称', 'type' => 'string', 'required' => true, 'example' => '默认API分组', ], 'Description' => [ 'title' => 'Api的描述信息', 'description' => 'Api的描述信息', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'RequestType' => [ 'title' => 'api的请求方式，可选枚举值包括 ：'."\n" .'0（GET）：仅返回单条，查询结果唯一 '."\n" .'1（LIST）：返回多条'."\n" .'2（CREATE）：创建对象，可支持单条或批量创建'."\n" .'3（UPDATE）：更新对象，可支持单条或批量更新'."\n" .'4（DELETE）：删除对象，可支持单条或批量删除', 'description' => 'Api的请求方式：'."\n" ."\n" .'- 0（GET）：仅返回单条，查询结果唯一 '."\n" .'- 1（LIST）：返回多条'."\n" .'- 2（CREATE）：创建对象，可支持单条或批量创建'."\n" .'- 3（UPDATE）：更新对象，可支持单条或批量更新'."\n" .'- 4（DELETE）：删除对象，可支持单条或批量删除', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'BizProtocol' => [ 'title' => '协议，不同的网关类型可支持的协议不同，请查看帮助文档，枚举值：0：HTTP 1：HTTPS', 'description' => '协议，不同的网关类型可支持的协议不同，请查看帮助文档，枚举值：'."\n" .'- 0：HTTP '."\n" .'- 1：HTTPS', 'type' => 'array', 'items' => [ 'title' => '0：HTTP 1：HTTPS', 'description' => '0：HTTP 1：HTTPS', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], 'required' => true, ], 'Timeout' => [ 'title' => '超时时间，单位为秒', 'description' => '超时时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', ], 'CacheTimeout' => [ 'title' => '缓存超时时间，单位为秒', 'description' => '缓存超时时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '600', ], 'UpdateRate' => [ 'title' => '更新频次（默认值为1）:'."\n" .'0: 自定义'."\n" .'1:天'."\n" .'2:小时'."\n" .'3:分钟', 'description' => '更新频次（默认值为1）:'."\n" ."\n" .'- 0: 自定义'."\n" .'- 1: 天'."\n" .'- 2: 小时'."\n" .'- 3: 分钟', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'CustomUpdateRate' => [ 'title' => '自定义更新频率，当更新频率（update_rate）为自定义时为必填', 'description' => '自定义更新频率，当更新频率为自定义时为必填', 'type' => 'string', 'required' => false, 'example' => '每天8点', ], 'CallMode' => [ 'title' => 'API的调用模式，可枚举值包括（默认值为1）：'."\n" .'1：同步调用'."\n" .'2：异步调用', 'description' => 'API的调用模式（默认值为1）：'."\n" ."\n" .'- 1：同步调用'."\n" .'- 2：异步调用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'ExecutionTimeout' => [ 'title' => 'API执行超时时间，仅对API异步调用API生效，异步调用时必填', 'description' => '异步调用API执行超时时间，仅对异步调用API生效，异步调用时必填', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], 'ScriptDetails' => [ 'title' => '脚本API的详情', 'description' => '脚本API的详情', 'type' => 'object', 'properties' => [ 'Script' => [ 'title' => 'sql脚本', 'description' => 'SQL脚本', 'type' => 'string', 'required' => true, 'example' => 'select a,b,c from table1 where d = ${d}', ], 'IsPaginated' => [ 'title' => '结果是否分页，仅当RequestType模式为List时才需要（默认为false）', 'description' => '结果是否分页，仅当RequestType模式为List时才需要（默认为false），且异步调用模式不支持', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'SqlMode' => [ 'title' => 'SQL模式，枚举值：'."\n" .'1：基础模式'."\n" .'2：高级模式', 'description' => 'SQL模式：'."\n" ."\n" .'- 1：基础模式'."\n" .'- 2：高级模式', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'SortPriority' => [ 'title' => '排序的优先级，仅SQL模式为基础模式时生效（默认值2），枚举值：'."\n" .'1：SQL脚本 '."\n" .'2：OrderByList请求参数', 'description' => '排序的优先级，仅SQL模式为基础模式时生效（默认值2）：'."\n" ."\n" .'- 1：SQL脚本 '."\n" .'- 2：OrderByList请求参数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'DatasourceType' => [ 'title' => '基于的数据源或数据服务单元的类型，枚举值：'."\n" .'0：数据服务单元 '."\n" .'1：数据源', 'description' => 'API基于的数据类型 ：'."\n" .'- 1：数据源', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'DatasourceID' => [ 'title' => '数据源的ID，API模式为直连数据源时必填', 'description' => '数据源的ID，API模式为直连数据源时必填', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6668888888888812345L', ], 'ScriptRequestParameters' => [ 'title' => '脚本 API 的请求参数列表', 'description' => '脚本 API 的请求参数列表', 'type' => 'array', 'items' => [ 'description' => '请求参数', 'type' => 'object', 'properties' => [ 'ParameterName' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => true, 'example' => 'd', ], 'ParameterDescription' => [ 'title' => '描述', 'description' => '参数描述', 'type' => 'string', 'required' => false, 'example' => '字段d', ], 'ParameterValueType' => [ 'title' => '参数值的类型：'."\n" .'1-单值：固定值，用于=、>=、<=、>、<、!=、between等操作符 '."\n" .'2-多值：输入参数为多值，用逗号“,”分隔。用于In、Not In操作符', 'description' => '参数值的类型：'."\n" ."\n" .'- 1单值：固定值，用于=、>=、<=、>、<、!=、between等操作符 '."\n" .'- 2多值：输入参数为多值，用逗号“,”分隔。用于In、Not In操作符', 'type' => 'string', 'required' => true, 'example' => '=', ], 'ParameterDataType' => [ 'title' => '数据类型 "STRING", "DOUBLE", "INT", "DATE", "LONG", "FLOAT", "BOOLEAN", "SHORT", "BYTE", "BIGDECIMAL", "BINARY", "ARRAY", "Array(int)", "Array(string)"', 'description' => '数据类型：'."\n" .'- "STRING"'."\n" .'- "DOUBLE"'."\n" .'- "INT"'."\n" .'- "DATE"'."\n" .'- "LONG"'."\n" .'- "FLOAT"'."\n" .'- "BOOLEAN"'."\n" .'- "SHORT"'."\n" .'- "BYTE"'."\n" .'- "BIGDECIMAL"'."\n" .'- "BINARY"'."\n" .'- "ARRAY"'."\n" .'- "Array(int)"'."\n" .'- "Array(string)"', 'type' => 'string', 'required' => true, 'example' => 'STRING', ], 'ExampleValue' => [ 'title' => '示例值', 'description' => '示例值', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'IsRequiredParameter' => [ 'title' => '是否必填', 'description' => '是否必填', 'type' => 'boolean', 'required' => true, 'example' => 'false', ], ], 'required' => true, ], 'required' => true, ], 'ScriptResponseParameters' => [ 'title' => '脚本 API 的返回参数列表', 'description' => '脚本 API 的返回参数列表', 'type' => 'array', 'items' => [ 'description' => '返回参数', 'type' => 'object', 'properties' => [ 'ParameterName' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => true, 'example' => 'a', ], 'ParameterDescription' => [ 'title' => '描述', 'description' => '参数描述', 'type' => 'string', 'required' => false, 'example' => '字段a', ], 'ParameterDataType' => [ 'title' => '数据类型 "STRING", "DOUBLE", "INT", "DATE", "LONG", "FLOAT", "BOOLEAN", "SHORT", "BYTE", "BIGDECIMAL", "BINARY", "ARRAY", "Array(int)", "Array(string)"', 'description' => '数据类型：'."\n" .'- "STRING"'."\n" .'- "DOUBLE"'."\n" .'- "INT"'."\n" .'- "DATE"'."\n" .'- "LONG"'."\n" .'- "FLOAT"'."\n" .'- "BOOLEAN"'."\n" .'- "SHORT"'."\n" .'- "BYTE"'."\n" .'- "BIGDECIMAL"'."\n" .'- "BINARY"'."\n" .'- "ARRAY"'."\n" .'- "Array(int)"'."\n" .'- "Array(string)"', 'type' => 'string', 'required' => true, 'example' => 'STRING', ], 'ExampleValue' => [ 'title' => '示例值', 'description' => '示例值', 'type' => 'string', 'required' => false, 'example' => 'amazing', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => true, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ApiId' => [ 'title' => '创建的API编号', 'description' => '创建的API编号', 'type' => 'integer', 'format' => 'int64', 'example' => '10086', ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ApiId\\": 10086\\n}","type":"json"}]', 'title' => '创建新的数据服务API并提交', 'extraInfo' => '接口上线版本：v5.1.0', ], 'ListApiByApp' => [ 'summary' => '根据app查询api列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'PageQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '分页查询参数', 'description' => '分页查询参数', 'type' => 'object', 'properties' => [ 'Keyword' => [ 'title' => '关键字', 'description' => '关键字', 'type' => 'string', 'required' => false, 'example' => 'apiName', ], 'PageSize' => [ 'title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'PageNum' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'AppKey' => [ 'title' => 'appKey', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', ], 'Success' => [ 'title' => '请求成功与否', 'description' => '请求成功与否', 'type' => 'boolean', 'example' => 'true', ], 'HttpStatusCode' => [ 'title' => 'HTTP响应码', 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '后端响应码', 'description' => '后端响应码', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '后端相应异常详情', 'description' => '后端相应异常详情', 'type' => 'string', 'example' => 'internal error', ], 'ListResult' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Data' => [ 'title' => 'api列表', 'description' => 'api列表', 'type' => 'array', 'items' => [ 'title' => 'API详情', 'description' => 'API详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'API的id', 'description' => 'API的id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'Name' => [ 'title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'exampleApi', ], 'GroupId' => [ 'title' => 'API分组id', 'description' => 'API分组id', 'type' => 'integer', 'format' => 'int64', 'example' => '67890', ], 'GroupName' => [ 'title' => 'API分组名', 'description' => 'API分组名', 'type' => 'string', 'example' => 'exampleGroup', ], 'RequestMethod' => [ 'title' => '请求方法', 'description' => '请求方法', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestMethodName' => [ 'title' => '请求方法名', 'description' => '请求方法名', 'type' => 'string', 'example' => 'GET', ], 'UpdateRate' => [ 'title' => '更新频率', 'description' => '更新频率', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'UpdateRateName' => [ 'title' => '更新频率名', 'description' => '更新频率名', 'type' => 'string', 'example' => '每日更新', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '这是一个示例API', ], 'ReturnType' => [ 'title' => '返回类型', 'description' => '返回类型', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ReturnTypeName' => [ 'title' => '返回类型名', 'description' => '返回类型名', 'type' => 'string', 'example' => 'JSON', ], 'Protocol' => [ 'title' => '协议', 'description' => '协议', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ProtocolName' => [ 'title' => '协议名', 'description' => '协议名', 'type' => 'string', 'example' => 'HTTP和HTTPS', ], 'SqlStatement' => [ 'title' => 'SQL语句', 'description' => 'SQL语句', 'type' => 'string', 'example' => 'SELECT * FROM example_table', ], 'RequestParamList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '请求参数响应DTO', 'description' => '请求参数响应DTO', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1001', ], 'ParamName' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'param1', ], 'MappingColumn' => [ 'title' => '前端绑定字段', 'description' => '前端绑定字段', 'type' => 'string', 'example' => 'column1', ], 'ParamType' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'String', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'value1', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '这是一个示例参数', ], 'DescriptionCode' => [ 'title' => '参数描述码', 'description' => '参数描述码', 'type' => 'string', 'example' => 'CODE_001', ], 'Must' => [ 'title' => '请求参数是否必填', 'description' => '请求参数是否必填', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Optional' => [ 'title' => '是否可以编辑', 'description' => '是否可以编辑', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DateFormat' => [ 'title' => '日期格式', 'description' => '日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Operator' => [ 'title' => '操作符', 'description' => '操作符', 'type' => 'string', 'example' => '=', ], 'OriginalColumn' => [ 'title' => '原字段名', 'description' => '原字段名', 'type' => 'string', 'example' => 'original_column', ], 'InitialValue' => [ 'title' => '初始化值', 'description' => '初始化值', 'type' => 'string', 'example' => 'app_key_value', ], 'TableAndDsList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '数据源简单DTO', 'description' => '数据源简单DTO', 'type' => 'object', 'properties' => [ 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => 'ds12345', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'exampleDatasource', ], 'DatasourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DatasourceUrl' => [ 'title' => '数据源URL', 'description' => '数据源URL', 'type' => 'string', 'example' => 'https://example.com/datasource', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 'example_table', ], ], ], ], 'ParameterLocation' => [ 'title' => '注册API-请求参数位置｜返回参数取值路径', 'description' => '注册API-请求参数位置｜返回参数取值路径', 'type' => 'string', 'example' => '/path/to/param', ], 'DefaultValue' => [ 'title' => '注册API-默认值', 'description' => '注册API-默认值', 'type' => 'string', 'example' => 'default_value', ], ], ], ], 'ResponseParamList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '响应参数响应DTO', 'description' => '响应参数响应DTO', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2001', ], 'ParamName' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'responseParam1', ], 'MappingColumn' => [ 'title' => '前端绑定字段', 'description' => '前端绑定字段', 'type' => 'string', 'example' => 'responseColumn1', ], 'ParamType' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'String', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'responseValue1', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '这是一个示例响应参数', ], 'DescriptionCode' => [ 'title' => '参数描述码', 'description' => '参数描述码', 'type' => 'string', 'example' => 'CODE_002', ], 'Must' => [ 'title' => '请求参数是否必填', 'description' => '请求参数是否必填', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Optional' => [ 'title' => '是否可以编辑', 'description' => '是否可以编辑', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DateFormat' => [ 'title' => '日期格式', 'description' => '日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Operator' => [ 'title' => '操作符', 'description' => '操作符', 'type' => 'string', 'example' => '=', ], 'OriginalColumn' => [ 'title' => '原字段名', 'description' => '原字段名', 'type' => 'string', 'example' => 'original_response_column', ], 'InitialValue' => [ 'title' => '初始化值', 'description' => '初始化值', 'type' => 'string', 'example' => 'app_key_value', ], 'TableAndDsList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '数据源简单DTO', 'description' => '数据源简单DTO', 'type' => 'object', 'properties' => [ 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => 'ds67890', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'responseDatasource', ], 'DatasourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'DatasourceUrl' => [ 'title' => '数据源URL', 'description' => '数据源URL', 'type' => 'string', 'example' => 'https://example.com/response_datasource', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 'response_table', ], ], ], ], 'ParameterLocation' => [ 'title' => '注册API-请求参数位置｜返回参数取值路径', 'description' => '注册API-请求参数位置｜返回参数取值路径', 'type' => 'string', 'example' => '/path/to/response_param', ], 'DefaultValue' => [ 'title' => '注册API-默认值', 'description' => '注册API-默认值', 'type' => 'string', 'example' => 'default_response_value', ], ], ], ], 'PublicParamList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '公共参数响应DTO', 'description' => '公共参数响应DTO', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3001', ], 'ParamName' => [ 'title' => '前端参数名称', 'description' => '前端参数名称', 'type' => 'string', 'example' => 'publicParam1', ], 'MappingColumn' => [ 'title' => '前端绑定字段', 'description' => '前端绑定字段', 'type' => 'string', 'example' => 'publicColumn1', ], 'ParamType' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'String', ], 'Sample' => [ 'title' => '参数示例', 'description' => '参数示例', 'type' => 'string', 'example' => 'publicValue1', ], 'Description' => [ 'title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => '这是一个示例公共参数', ], 'DescriptionCode' => [ 'title' => '参数描述码', 'description' => '参数描述码', 'type' => 'string', 'example' => 'CODE_003', ], 'Must' => [ 'title' => '请求参数是否必填', 'description' => '请求参数是否必填', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Optional' => [ 'title' => '是否可以编辑', 'description' => '是否可以编辑', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DateFormat' => [ 'title' => '日期格式', 'description' => '日期格式', 'type' => 'string', 'example' => 'yyyy-MM-dd', ], 'Operator' => [ 'title' => '操作符', 'description' => '操作符', 'type' => 'string', 'example' => '=', ], 'OriginalColumn' => [ 'title' => '原字段名', 'description' => '原字段名', 'type' => 'string', 'example' => 'original_public_column', ], 'InitialValue' => [ 'title' => '初始化值', 'description' => '初始化值', 'type' => 'string', 'example' => 'app_key_value', ], 'TableAndDsList' => [ 'title' => '-', 'description' => '-', 'type' => 'array', 'items' => [ 'title' => '数据源简单DTO', 'description' => '数据源简单DTO', 'type' => 'object', 'properties' => [ 'DatasourceId' => [ 'title' => '数据源ID', 'description' => '数据源ID', 'type' => 'string', 'example' => 'ds54321', ], 'DatasourceName' => [ 'title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'example' => 'publicDatasource', ], 'DatasourceType' => [ 'title' => '数据源类型', 'description' => '数据源类型', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'DatasourceUrl' => [ 'title' => '数据源URL', 'description' => '数据源URL', 'type' => 'string', 'example' => 'https://example.com/public_datasource', ], 'TableName' => [ 'title' => '表名', 'description' => '表名', 'type' => 'string', 'example' => 'public_table', ], ], ], ], 'ParameterLocation' => [ 'title' => '注册API-请求参数位置｜返回参数取值路径', 'description' => '注册API-请求参数位置｜返回参数取值路径', 'type' => 'string', 'example' => '/path/to/public_param', ], 'DefaultValue' => [ 'title' => '注册API-默认值', 'description' => '注册API-默认值', 'type' => 'string', 'example' => 'default_public_value', ], ], ], ], 'SpecialSql' => [ 'title' => '特殊SQL标志', 'description' => '特殊SQL标志', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'CreateType' => [ 'title' => '创建类型', 'description' => '创建类型'."\n" .'SQL_MODE(0, "逻辑表API-SQL模式"),'."\n" .'WIZARD_MODE(1, "逻辑表API-向导模式"),'."\n" .'DIRECT_API_MODE(2, "直连数据源-SQL模式"),'."\n" .'REGISTER_API_MODE(3, "注册API模式"),'."\n" .'COMPOSITE_API_MODE(4, "组合API模式");', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ApiNo' => [ 'title' => 'API编号', 'description' => 'API编号', 'type' => 'integer', 'format' => 'int64', 'example' => '987654321', ], 'ModelType' => [ 'title' => '模式', 'description' => '模式', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DbEnv' => [ 'title' => '数据环境', 'description' => '数据环境', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ResultSample' => [ 'title' => '调用结果样例', 'description' => '调用结果样例', 'type' => 'string', 'example' => '{"status":"success","data":[]}', ], 'BizModuleEnName' => [ 'title' => '业务板块名', 'description' => '业务板块名', 'type' => 'string', 'example' => 'exampleModule', ], 'TableName' => [ 'title' => '逻辑表名', 'description' => '逻辑表名', 'type' => 'string', 'example' => 'exampleTable', ], 'IsLogicalTable' => [ 'title' => '是否逻辑表', 'description' => '是否逻辑表', 'type' => 'boolean', ], 'DirectDatasourceId' => [ 'title' => '直连API的数据源ID', 'description' => '直连API的数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '54321', ], 'DirectDatasourceName' => [ 'title' => '直连API的数据源名称', 'description' => '直连API的数据源名称', 'type' => 'string', 'example' => 'directDatasource', ], 'ApiTimeout' => [ 'title' => 'API超时', 'description' => 'API超时', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'MaxReturnNum' => [ 'title' => '最大返回条数', 'description' => '最大返回条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'ProjId' => [ 'title' => '服务项目ID', 'description' => '服务项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '112233', ], 'ProjName' => [ 'title' => '服务项目名称', 'description' => '服务项目名称', 'type' => 'string', 'example' => 'exampleProject', ], 'AppName' => [ 'title' => '我的应用', 'description' => '我的应用', 'type' => 'string', 'example' => 'exampleApp', ], 'RsGrpId' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'grp12345', ], 'ResourceGroupName' => [ 'title' => '资源组名称', 'description' => '资源组名称', 'type' => 'string', 'example' => 'exampleResourceGroup', ], 'CacheSwitch' => [ 'title' => 'API缓存开关', 'description' => 'API缓存开关', 'type' => 'string', 'example' => '1', ], 'CacheTime' => [ 'title' => '缓存时长（秒）', 'description' => '缓存时长（秒）', 'type' => 'string', 'example' => '60', ], 'Timeout' => [ 'title' => '超时时长（秒）', 'description' => '超时时长（秒）', 'type' => 'string', 'example' => '10', ], 'ScriptType' => [ 'title' => '脚本类型', 'description' => '脚本类型', 'type' => 'string', 'example' => 'SQL', ], 'RegisterApi' => [ 'title' => '注册API信息', 'description' => '注册API信息', 'type' => 'object', 'properties' => [ 'ApiId' => [ 'title' => 'data_api主键', 'description' => 'data_api主键', 'type' => 'integer', 'format' => 'int64', 'example' => '67890', ], 'ModelType' => [ 'title' => '模式', 'description' => '模式', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'HttpMethod' => [ 'title' => '注册API请求方式', 'description' => '注册API请求方式', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'DatasourceId' => [ 'title' => 'API数据源ID', 'description' => 'API数据源ID', 'type' => 'string', 'example' => 'ds67890', ], 'DatasourceName' => [ 'title' => 'API数据源名称', 'description' => 'API数据源名称', 'type' => 'string', 'example' => 'registerDatasource', ], 'Url' => [ 'title' => 'API数据源URL地址', 'description' => 'API数据源URL地址', 'type' => 'string', 'example' => 'https://example.com/register_api', ], 'AuthenticationMode' => [ 'title' => 'API数据源认证方式', 'description' => 'API数据源认证方式', 'type' => 'string', 'example' => 'OAuth2', ], 'Protocol' => [ 'title' => 'API数据源请求协议', 'description' => 'API数据源请求协议', 'type' => 'string', 'example' => 'HTTPS', ], 'Path' => [ 'title' => '服务path', 'description' => '服务path', 'type' => 'string', 'example' => '/api/v1/register', ], 'Timeout' => [ 'title' => '超时时间', 'description' => '超时时间', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'SuccessExample' => [ 'title' => '成功示例', 'description' => '成功示例', 'type' => 'string', 'example' => '{"status":"success","data":[]}', ], 'FailExample' => [ 'title' => '失败示例', 'description' => '失败示例', 'type' => 'string', 'example' => '{"status":"error","message":"Invalid request"}', ], ], ], 'Version' => [ 'title' => 'API版本', 'description' => 'API版本', 'type' => 'string', 'example' => 'v1.0', ], 'IsPagedQuery' => [ 'title' => '是否是分页查询', 'description' => '是否是分页查询', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ListResult\\": {\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"exampleApi\\",\\n \\"GroupId\\": 67890,\\n \\"GroupName\\": \\"exampleGroup\\",\\n \\"RequestMethod\\": 1,\\n \\"RequestMethodName\\": \\"GET\\",\\n \\"UpdateRate\\": 2,\\n \\"UpdateRateName\\": \\"每日更新\\",\\n \\"Description\\": \\"这是一个示例API\\",\\n \\"ReturnType\\": 3,\\n \\"ReturnTypeName\\": \\"JSON\\",\\n \\"Protocol\\": 3,\\n \\"ProtocolName\\": \\"HTTP和HTTPS\\",\\n \\"SqlStatement\\": \\"SELECT * FROM example_table\\",\\n \\"RequestParamList\\": [\\n {\\n \\"Id\\": 1001,\\n \\"ParamName\\": \\"param1\\",\\n \\"MappingColumn\\": \\"column1\\",\\n \\"ParamType\\": \\"String\\",\\n \\"Sample\\": \\"value1\\",\\n \\"Description\\": \\"这是一个示例参数\\",\\n \\"DescriptionCode\\": \\"CODE_001\\",\\n \\"Must\\": 1,\\n \\"Optional\\": 1,\\n \\"DateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Operator\\": \\"=\\",\\n \\"OriginalColumn\\": \\"original_column\\",\\n \\"InitialValue\\": \\"app_key_value\\",\\n \\"TableAndDsList\\": [\\n {\\n \\"DatasourceId\\": \\"ds12345\\",\\n \\"DatasourceName\\": \\"exampleDatasource\\",\\n \\"DatasourceType\\": 1,\\n \\"DatasourceUrl\\": \\"https://example.com/datasource\\",\\n \\"TableName\\": \\"example_table\\"\\n }\\n ],\\n \\"ParameterLocation\\": \\"/path/to/param\\",\\n \\"DefaultValue\\": \\"default_value\\"\\n }\\n ],\\n \\"ResponseParamList\\": [\\n {\\n \\"Id\\": 2001,\\n \\"ParamName\\": \\"responseParam1\\",\\n \\"MappingColumn\\": \\"responseColumn1\\",\\n \\"ParamType\\": \\"String\\",\\n \\"Sample\\": \\"responseValue1\\",\\n \\"Description\\": \\"这是一个示例响应参数\\",\\n \\"DescriptionCode\\": \\"CODE_002\\",\\n \\"Must\\": 1,\\n \\"Optional\\": 1,\\n \\"DateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Operator\\": \\"=\\",\\n \\"OriginalColumn\\": \\"original_response_column\\",\\n \\"InitialValue\\": \\"app_key_value\\",\\n \\"TableAndDsList\\": [\\n {\\n \\"DatasourceId\\": \\"ds67890\\",\\n \\"DatasourceName\\": \\"responseDatasource\\",\\n \\"DatasourceType\\": 2,\\n \\"DatasourceUrl\\": \\"https://example.com/response_datasource\\",\\n \\"TableName\\": \\"response_table\\"\\n }\\n ],\\n \\"ParameterLocation\\": \\"/path/to/response_param\\",\\n \\"DefaultValue\\": \\"default_response_value\\"\\n }\\n ],\\n \\"PublicParamList\\": [\\n {\\n \\"Id\\": 3001,\\n \\"ParamName\\": \\"publicParam1\\",\\n \\"MappingColumn\\": \\"publicColumn1\\",\\n \\"ParamType\\": \\"String\\",\\n \\"Sample\\": \\"publicValue1\\",\\n \\"Description\\": \\"这是一个示例公共参数\\",\\n \\"DescriptionCode\\": \\"CODE_003\\",\\n \\"Must\\": 1,\\n \\"Optional\\": 1,\\n \\"DateFormat\\": \\"yyyy-MM-dd\\",\\n \\"Operator\\": \\"=\\",\\n \\"OriginalColumn\\": \\"original_public_column\\",\\n \\"InitialValue\\": \\"app_key_value\\",\\n \\"TableAndDsList\\": [\\n {\\n \\"DatasourceId\\": \\"ds54321\\",\\n \\"DatasourceName\\": \\"publicDatasource\\",\\n \\"DatasourceType\\": 3,\\n \\"DatasourceUrl\\": \\"https://example.com/public_datasource\\",\\n \\"TableName\\": \\"public_table\\"\\n }\\n ],\\n \\"ParameterLocation\\": \\"/path/to/public_param\\",\\n \\"DefaultValue\\": \\"default_public_value\\"\\n }\\n ],\\n \\"SpecialSql\\": 0,\\n \\"CreateType\\": 1,\\n \\"ApiNo\\": 987654321,\\n \\"ModelType\\": 0,\\n \\"DbEnv\\": 0,\\n \\"ResultSample\\": \\"{\\\\\\"status\\\\\\":\\\\\\"success\\\\\\",\\\\\\"data\\\\\\":[]}\\",\\n \\"BizModuleEnName\\": \\"exampleModule\\",\\n \\"TableName\\": \\"exampleTable\\",\\n \\"IsLogicalTable\\": true,\\n \\"DirectDatasourceId\\": 54321,\\n \\"DirectDatasourceName\\": \\"directDatasource\\",\\n \\"ApiTimeout\\": 30,\\n \\"MaxReturnNum\\": 100,\\n \\"ProjId\\": 112233,\\n \\"ProjName\\": \\"exampleProject\\",\\n \\"AppName\\": \\"exampleApp\\",\\n \\"RsGrpId\\": \\"grp12345\\",\\n \\"ResourceGroupName\\": \\"exampleResourceGroup\\",\\n \\"CacheSwitch\\": \\"1\\",\\n \\"CacheTime\\": \\"60\\",\\n \\"Timeout\\": \\"10\\",\\n \\"ScriptType\\": \\"SQL\\",\\n \\"RegisterApi\\": {\\n \\"ApiId\\": 67890,\\n \\"ModelType\\": 0,\\n \\"HttpMethod\\": 1,\\n \\"DatasourceId\\": \\"ds67890\\",\\n \\"DatasourceName\\": \\"registerDatasource\\",\\n \\"Url\\": \\"https://example.com/register_api\\",\\n \\"AuthenticationMode\\": \\"OAuth2\\",\\n \\"Protocol\\": \\"HTTPS\\",\\n \\"Path\\": \\"/api/v1/register\\",\\n \\"Timeout\\": 30,\\n \\"SuccessExample\\": \\"{\\\\\\"status\\\\\\":\\\\\\"success\\\\\\",\\\\\\"data\\\\\\":[]}\\",\\n \\"FailExample\\": \\"{\\\\\\"status\\\\\\":\\\\\\"error\\\\\\",\\\\\\"message\\\\\\":\\\\\\"Invalid request\\\\\\"}\\"\\n },\\n \\"Version\\": \\"v1.0\\",\\n \\"IsPagedQuery\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询应用下api详情列表', 'description' => '可以根据appKey查询已发布接口的详细信息', ], 'ListAuthorizedDataServiceApiDetails' => [ 'summary' => '查询应用已申请的API的具体的字段列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', ], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', 'schema' => [ 'title' => '租户ID', 'description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', ], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '查询请求', 'description' => '查询请求', 'type' => 'object', 'properties' => [ 'AppKey' => [ 'title' => 'AppKey', 'description' => 'AppKey', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200000000', ], 'Page' => [ 'title' => '页码，从1开始', 'description' => '页码，从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], 'PageSize' => [ 'title' => '每页显示的条数，最大100条', 'description' => '每页显示的条数，最大100条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '20', ], ], 'required' => true, 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结果', 'description' => '响应结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求标识ID，一次请求的唯一标识', 'description' => '请求标识ID，一次请求的唯一标识', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', ], 'Success' => [ 'title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', ], 'HttpStatusCode' => [ 'title' => 'HTTP 状态码', 'description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => '请求错误码，OK表示请求正常', 'description' => '请求错误码，OK表示请求正常', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'title' => '请求错误信息', 'description' => '请求错误信息', 'type' => 'string', 'example' => '非法入参', ], 'Result' => [ 'title' => '查询结果', 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '返回总数', 'description' => '返回总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Data' => [ 'title' => '返回授权的API详情列表', 'description' => '返回授权的API详情列表', 'type' => 'array', 'items' => [ 'title' => '授权的API详情', 'description' => '授权的API详情', 'type' => 'object', 'properties' => [ 'ApiId' => [ 'title' => 'API_ID', 'description' => 'API_ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'ApiName' => [ 'title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'GetData', ], 'AppId' => [ 'title' => '应用 ID', 'description' => '应用 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', ], 'ProjectId' => [ 'title' => '数据服务项目ID', 'description' => '数据服务项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'Description' => [ 'title' => 'API描述信息', 'description' => 'API描述信息', 'type' => 'string', 'example' => 'Description1', ], 'DevAuthPeriod' => [ 'title' => '开发环境API权限有效期', 'description' => '开发环境API权限有效期', 'type' => 'string', 'example' => '2035-12-31', ], 'ProdAuthPeriod' => [ 'title' => '生产环境API权限有效期', 'description' => '生产环境API权限有效期', 'type' => 'string', 'example' => '2035-12-31', ], 'AuthType' => [ 'title' => '权限类型', 'description' => '权限类型', 'type' => 'string', 'example' => '使用权限', ], 'AuthorizedDevReturnParameters' => [ 'title' => 'API开发环境授权的字段列表', 'description' => 'API开发环境授权的字段列表', 'type' => 'array', 'items' => [ 'title' => '字段对象', 'description' => '字段对象', 'type' => 'object', 'properties' => [ 'ParameterName' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'param1', ], 'ParameterDataType' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'enum' => [ '0：String', '1：Int', '2：Short', '3：Long', '4：Float', '5：Double', '6：Byte', '7：Boolean', '8：Binary', '9：Bigdecimal', '10：DATE(yyy-MM-dd HH:mm:ss)', '11：Array', '12：Array(int)', '13：Array(string)', ], ], 'ParameterDescription' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'description1', ], 'ExampleValue' => [ 'title' => '示例值', 'description' => '示例值', 'type' => 'string', 'example' => 'example1', ], 'IsAuthorized' => [ 'title' => '字段授权情况', 'description' => '字段授权情况', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0：未授权', '1：已授权', ], ], ], ], ], 'AuthorizedProdReturnParameters' => [ 'title' => 'API生产环境授权的字段列表', 'description' => 'API生产环境授权的字段列表', 'type' => 'array', 'items' => [ 'title' => '字段对象', 'description' => '字段对象', 'type' => 'object', 'properties' => [ 'ParameterName' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'param1', ], 'ParameterDataType' => [ 'title' => '参数类型', 'description' => '参数类型', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'enum' => [ '0：String', '1：Int', '2：Short', '3：Long', '4：Float', '5：Double', '6：Byte', '7：Boolean', '8：Binary', '9：Bigdecimal', '10：DATE(yyy-MM-dd HH:mm:ss)', '11：Array', '12：Array(int)', '13：Array(string)', ], ], 'ParameterDescription' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'description1', ], 'ExampleValue' => [ 'title' => '示例值', 'description' => '示例值', 'type' => 'string', 'example' => 'example1', ], 'IsAuthorized' => [ 'title' => '字段授权情况', 'description' => '字段授权情况', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => [ '0：未授权', '1：已授权', ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 401 => [ [ 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', ], ], 403 => [ [ 'errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', ], ], 406 => [ [ 'errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"非法入参\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"ApiId\\": 12345,\\n \\"ApiName\\": \\"GetData\\",\\n \\"AppId\\": 12345,\\n \\"ProjectId\\": 10000,\\n \\"Description\\": \\"Description1\\",\\n \\"DevAuthPeriod\\": \\"2035-12-31\\",\\n \\"ProdAuthPeriod\\": \\"2035-12-31\\",\\n \\"AuthType\\": \\"使用权限\\",\\n \\"AuthorizedDevReturnParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterDataType\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsAuthorized\\": 1\\n }\\n ],\\n \\"AuthorizedProdReturnParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterDataType\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsAuthorized\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询应用已申请的API的具体的字段列表', ], ], 'endpoints' => [ [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'dataphin-public.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'dataphin-public.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'dataphin-public.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'dataphin-public.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'dataphin-public.cn-chengdu.aliyuncs.com', ], ], ];