From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/dataphin-public/2023-06-30/api-docs.php | 89955 +++++++------------ 1 file changed, 31951 insertions(+), 58004 deletions(-) (limited to 'data/en_us/dataphin-public/2023-06-30') diff --git a/data/en_us/dataphin-public/2023-06-30/api-docs.php b/data/en_us/dataphin-public/2023-06-30/api-docs.php index 759b4f0..600953f 100644 --- a/data/en_us/dataphin-public/2023-06-30/api-docs.php +++ b/data/en_us/dataphin-public/2023-06-30/api-docs.php @@ -1,356 +1,112 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'dataphin-public', - 'version' => '2023-06-30', - ], + 'info' => ['style' => 'RPC', 'product' => 'dataphin-public', 'version' => '2023-06-30'], 'directories' => [ [ - 'id' => 198270, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 243566, - 'title' => null, + 'children' => ['CheckProjectHasDependency', 'GetProject', 'GetProjectByName', 'AddProjectMember', 'GetProjectWhiteLists', 'ListProjectMembers', 'ListProjects', 'RemoveProjectMember', 'ReplaceProjectWhiteLists', 'UpdateProjectMember', 'UpdateTenantComputeEngine'], 'type' => 'directory', - 'children' => [ - 'CheckProjectHasDependency', - 'GetProject', - 'GetProjectByName', - 'AddProjectMember', - 'GetProjectWhiteLists', - 'ListProjectMembers', - 'ListProjects', - 'RemoveProjectMember', - 'ReplaceProjectWhiteLists', - 'UpdateProjectMember', - 'UpdateTenantComputeEngine', - ], - ], - [ - 'id' => 198271, - 'title' => null, + 'title' => 'Projects', + ], + [ + 'children' => ['GetCheckConnectivityJobs', 'GetDataSourceDependencies', 'CreateDataSource', 'DeleteDataSource', 'UpdateDataSourceBasicInfo', 'UpdateDataSourceConfig', 'ListDataSourceWithConfig', 'CheckDataSourceConnectivity', 'CheckDataSourceConnectivityById'], 'type' => 'directory', - 'children' => [ - 'GetCheckConnectivityJobs', - 'GetDataSourceDependencies', - 'CreateDataSource', - 'DeleteDataSource', - 'UpdateDataSourceBasicInfo', - 'UpdateDataSourceConfig', - 'ListDataSourceWithConfig', - 'CheckDataSourceConnectivity', - 'CheckDataSourceConnectivityById', - ], + 'title' => 'Data sources', ], [ - 'id' => 201914, - 'title' => null, + 'children' => ['CheckComputeSourceConnectivity', 'CheckComputeSourceConnectivityById', 'ListComputeSources', 'UpdateComputeSource', 'GetComputeSource', 'DeleteComputeSource', 'CreateComputeSource', 'GetSparkLocalClientInfo'], 'type' => 'directory', + 'title' => 'Compute sources', + ], + [ 'children' => [ - 'CheckComputeSourceConnectivity', - 'CheckComputeSourceConnectivityById', - 'ListComputeSources', - 'UpdateComputeSource', - 'GetComputeSource', - 'DeleteComputeSource', - 'CreateComputeSource', - 'GetSparkLocalClientInfo', + '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', ], + 'type' => 'directory', + 'title' => 'Users and authorization', ], [ - 'id' => 198279, - 'title' => null, - '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' => null, + 'children' => ['GetRowPermissionByTableGuids', 'DeleteRowPermission', 'GetAccountByRowPermissionId', 'ListRowPermission', 'ListRowPermissionByUserId', 'UpdateRowPermission', 'CreateRowPermission'], 'type' => 'directory', - 'children' => [ - 'DeleteRowPermission', - 'GetAccountByRowPermissionId', - 'ListRowPermission', - 'ListRowPermissionByUserId', - 'UpdateRowPermission', - 'CreateRowPermission', - ], + 'title' => 'Row-level permissions', ], ], + 'type' => 'directory', + 'title' => 'Platform management', ], [ - 'id' => 198307, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 200872, - 'title' => null, + 'children' => ['CreateDirectory', 'DeleteDirectory', 'UpdateFileName', 'UpdateFileDirectory', 'GetDirectoryTree', 'ListFiles'], 'type' => 'directory', - 'children' => [ - 'CreateDirectory', - 'DeleteDirectory', - 'UpdateFileName', - 'UpdateFileDirectory', - 'GetDirectoryTree', - 'ListFiles', - ], + 'title' => 'Directory tree', ], [ - 'id' => 200804, - 'title' => null, + 'children' => ['GetBizEntityInfoByVersion', 'GetBizEntityInfo', 'UpdateBizUnit', 'ListBizUnits', 'GetBizUnitInfo', 'DeleteBizUnit', 'CreateBizUnit', 'UpdateBizEntity', 'OnlineBizEntity', 'OfflineBizEntity', 'ListBizEntities', 'CreateBizEntity', 'UpdateDataDomain', 'ListDataDomains', 'GetDataDomainInfo', 'DeleteDataDomain', 'CreateDataDomain', 'DeleteBizEntity'], 'type' => 'directory', - 'children' => [ - 'GetBizEntityInfoByVersion', - 'GetBizEntityInfo', - 'UpdateBizUnit', - 'ListBizUnits', - 'GetBizUnitInfo', - 'DeleteBizUnit', - 'CreateBizUnit', - 'UpdateBizEntity', - 'OnlineBizEntity', - 'OfflineBizEntity', - 'ListBizEntities', - 'CreateBizEntity', - 'UpdateDataDomain', - 'ListDataDomains', - 'GetDataDomainInfo', - 'DeleteDataDomain', - 'CreateDataDomain', - 'DeleteBizEntity', - ], - ], - [ - 'id' => 198308, - 'title' => null, + 'title' => 'Data architecture', + ], + [ + 'children' => ['CreateAdHocFile', 'DeleteAdHocFile', 'UpdateAdHocFile', 'GetAdHocFile', 'StopAdHocTask', 'GetAdHocTaskResult', 'ExecuteAdHocTask', 'GetAdHocTaskLog'], 'type' => 'directory', - 'children' => [ - 'CreateAdHocFile', - 'DeleteAdHocFile', - 'UpdateAdHocFile', - 'GetAdHocFile', - 'StopAdHocTask', - 'GetAdHocTaskResult', - 'ExecuteAdHocTask', - 'GetAdHocTaskLog', - ], + 'title' => 'Ad hoc queries', ], [ - 'id' => 201111, - 'title' => null, + 'children' => ['UpdatePipelineByAsync', 'OfflinePipelineByAsync', 'GetPipelineById', 'OfflinePipeline', 'CreatePipeline', 'GetPipelineAsyncResult', 'CreatePipelineByAsync', 'UpdatePipeline', 'CreatePipelineNode', 'UpdateBatchTaskUdfLineages', 'UpdateBatchTask', 'SubmitBatchTask', 'ParseBatchTaskDependency', 'OfflineBatchTask', 'GetBatchTaskUdfLineages', 'GetBatchTaskVersions', 'GetBatchTaskInfoByVersion', 'GetBatchTaskInfo', 'DeleteBatchTask', 'CreateBatchTask'], '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' => null, + 'title' => 'Batch tasks', + ], + [ + 'children' => ['GetStreamJobs', 'GetQueueEngineVersionByEnv', 'GetClusterQueueInfoByEnv', 'CreateStreamBatchJobMapping'], 'type' => 'directory', - 'children' => [ - 'GetStreamJobs', - 'GetQueueEngineVersionByEnv', - 'GetClusterQueueInfoByEnv', - 'CreateStreamBatchJobMapping', - ], + 'title' => 'Real-time development tasks', ], [ - 'id' => 243553, - 'title' => null, + 'children' => ['GetResource', 'GetResourceByVersion', 'UpdateResource', 'GetFileStorageCredential', 'DeleteResource', 'CreateResource'], 'type' => 'directory', - 'children' => [ - 'GetResource', - 'GetResourceByVersion', - 'UpdateResource', - 'GetFileStorageCredential', - 'DeleteResource', - 'CreateResource', - ], + 'title' => 'Resources', ], [ - 'id' => 243557, - 'title' => null, + 'children' => ['GetUdf', 'GetUdfByVersion', 'UpdateUdf', 'DeleteUdf', 'CreateUdf'], 'type' => 'directory', - 'children' => [ - 'GetUdf', - 'GetUdfByVersion', - 'UpdateUdf', - 'DeleteUdf', - 'CreateUdf', - ], + 'title' => 'Functions', ], [ - 'id' => 201062, - 'title' => null, + 'children' => ['ListSubmitRecords', 'GetLatestSubmitDetail', 'PublishObjectList', 'ListPublishRecords'], 'type' => 'directory', - 'children' => [ - 'ListSubmitRecords', - 'GetLatestSubmitDetail', - 'PublishObjectList', - 'ListPublishRecords', - ], + 'title' => 'Publishing', ], ], + 'type' => 'directory', + 'title' => 'Development', ], [ - 'id' => 205628, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 376092, - 'title' => null, - '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' => null, - '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' => null, + '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', + ], 'type' => 'directory', + 'title' => 'Data standards', + ], + [ 'children' => [ - 'UpdateSecurityLevel', - 'UpdateSecurityIdentifyResultStatus', - 'UpdateSecurityClassifyCatalog', - 'UpdateSecurityClassify', - 'ListSecurityIdentifyResults', - 'ListSecurityIdentifyRecords', - 'GetSecuritySecretKey', - 'GetSecurityLevel', - 'GetSecurityIdentifyResult', - 'GetSecurityClassify', - 'DeleteSecurityLevel', - 'DeleteSecurityIdentifyResults', - 'DeleteSecurityClassifyCatalog', - 'DeleteSecurityClassify', - 'CreateSecurityLevel', - 'CreateSecurityIdentifyResult', - 'CreateSecurityClassifyCatalog', - 'CreateSecurityClassify', + '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', ], + 'type' => 'directory', + 'title' => 'Data quality', + ], + [ + 'children' => ['UpdateSecurityLevel', 'UpdateSecurityIdentifyResultStatus', 'UpdateSecurityClassifyCatalog', 'UpdateSecurityClassify', 'ListSecurityIdentifyResults', 'ListSecurityIdentifyRecords', 'GetSecuritySecretKey', 'GetSecurityLevel', 'GetSecurityIdentifyResult', 'GetSecurityClassify', 'DeleteSecurityLevel', 'DeleteSecurityIdentifyResults', 'DeleteSecurityClassifyCatalog', 'DeleteSecurityClassify', 'CreateSecurityLevel', 'CreateSecurityIdentifyResult', 'CreateSecurityClassifyCatalog', 'CreateSecurityClassify'], + 'type' => 'directory', + 'title' => 'Data security', ], + 'ListCatalogAssets', + 'GetCatalogAssetDetails', 'GetTableLineages', 'GetBelongAssetMapping', 'GetAssetMappingRelations', @@ -366,745 +122,337 @@ 'GetTableLineageByTaskId', 'GetTableColumnLineageByTaskId', ], + 'type' => 'directory', + 'title' => 'Assets', ], [ - 'id' => 198318, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 198319, - 'title' => null, + 'children' => ['GetInstanceUpDownStream', 'GetInstanceDownStream', 'GetSupplementDagrunInstance', 'GetPhysicalInstance', 'ListInstances', 'OperateInstance', 'FixData'], 'type' => 'directory', - 'children' => [ - 'GetInstanceUpDownStream', - 'GetInstanceDownStream', - 'GetSupplementDagrunInstance', - 'GetPhysicalInstance', - 'ListInstances', - 'OperateInstance', - 'FixData', - ], + 'title' => 'Instance O&M', ], [ - 'id' => 198327, - 'title' => null, + 'children' => ['ExecuteTriggerNode', 'CreateNodeSupplement', 'PausePhysicalNode', 'GetOperationSubmitStatus', 'GetPhysicalInstanceLog', 'GetSupplementDagrun', 'GetPhysicalNode', 'GetPhysicalNodeContent', 'GetNodeUpDownStream', 'ListNodes', 'GetPhysicalNodeOperationLog', 'ListNodeDownStream', 'GetPhysicalNodeByOutputName', 'GetDevObjectDependency', 'ResumePhysicalNode', 'ExecuteManualNode'], 'type' => 'directory', - 'children' => [ - 'ExecuteTriggerNode', - 'CreateNodeSupplement', - 'PausePhysicalNode', - 'GetOperationSubmitStatus', - 'GetPhysicalInstanceLog', - 'GetSupplementDagrun', - 'GetPhysicalNode', - 'GetPhysicalNodeContent', - 'GetNodeUpDownStream', - 'ListNodes', - 'GetPhysicalNodeOperationLog', - 'ListNodeDownStream', - 'GetPhysicalNodeByOutputName', - 'GetDevObjectDependency', - 'ResumePhysicalNode', - 'ExecuteManualNode', - ], + 'title' => 'Node O&M', ], ], + 'type' => 'directory', + 'title' => 'O&M', ], [ - 'id' => 201065, - 'title' => null, + 'children' => ['ListAlertNotifications', 'ListAlertEvents', 'GetAlertEvent'], 'type' => 'directory', - 'children' => [ - 'ListAlertNotifications', - 'ListAlertEvents', - 'GetAlertEvent', - ], + 'title' => 'Alert messages', ], [ - 'id' => 201918, - 'title' => null, - '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', + 'UpdateDataServiceApp', 'UpdateDataServiceAppGroup', 'UpdateDataServiceAppMember', 'ResetDataServiceAppSecret', 'RemoveDataServiceAppMember', 'ListDataServiceApps', 'GetDataServiceAppMembers', 'GetDataServiceApp', 'DeleteDataServiceAppGroup', 'DeleteDataServiceApp', 'CreateDataServiceAppGroup', 'CreateDataServiceApp', 'AddDataServiceAppMember', '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', ], + 'type' => 'directory', + 'title' => 'Data services', + ], + [ + 'children' => ['CreateDataset', 'CreateWorkFlowByJson', 'DeleteDataset', 'GetBatchTemplateVersions', 'GetDataset', 'GetOperationRecordById', 'GetOperationRecordDetail', 'GetOperationRecordRunCode', 'ListBatchTemplates', 'ListDatasets', 'ListOperationRecord', 'UpdateDataset'], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CheckProjectHasDependency' => [ - 'summary' => '检查项目是否存在依赖。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddDataServiceAppMember' => [ + 'summary' => 'Adds a regular member to a data service application. Only the application owner can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'AddCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The regular member to add to the data service application.', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200000000'], + 'MemberList' => [ + 'title' => '', + 'description' => 'The list of members.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The member information.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'EffectiveEnd' => ['title' => '', 'description' => 'The authorization expiration time.', 'type' => 'string', 'required' => true, 'example' => '2026-12-12'], + ], + 'required' => true, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => '12356', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Add a regular member to a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetProject' => [ - 'summary' => '获取项目详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddDataServiceProjectMember' => [ + 'summary' => 'Adds users to a data service project and assigns roles to them.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12356', - ], + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], [ - 'name' => 'Env', - 'in' => 'query', + 'name' => 'AddCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '环境标识, 默认：PROD', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV', + 'title' => '', + 'description' => 'The command to add project members.', + 'type' => 'object', + 'properties' => [ + 'ProjectMemberList' => [ + 'title' => '', + 'description' => 'The list of project members to add.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '', 'description' => 'The role of the user. Valid values:'."\n" + .'- 2: development user'."\n" + .'- 3: application member'."\n" + .'- 4: service project administrator'."\n" + .'- 5: O&M user.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '30012011'], + 'DisplayName' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'AccountName' => ['title' => '', 'description' => 'The username of the user.', 'type' => 'string', 'required' => true, 'example' => 'xx@aliyuncs.com'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ProjectInfo' => [ - 'title' => '项目详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BizUnitId' => [ - 'title' => '所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101131', - ], - 'BizUnitDisplayName' => [ - 'title' => '所属业务板块展示名', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'ComputeSourceId' => [ - 'title' => '绑定计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101711', - ], - 'ComputeSourceName' => [ - 'title' => '绑定计算源名', - 'description' => '', - 'type' => 'string', - 'example' => 'ds1', - ], - 'StreamComputeSourceId' => [ - 'title' => '绑定实时计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201711', - ], - 'StreamComputeSourceName' => [ - 'title' => '绑定实时计算源名', - 'description' => '', - 'type' => 'string', - 'example' => 'ds2', - ], - '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' => '', - 'type' => 'string', - 'example' => 'BASIC', - ], - 'Type' => [ - 'title' => '项目类型: DISTILL 萃取项目、GENERAL 一般类型项目', - 'description' => '', - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'Id' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12356', - ], - 'Name' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'dp_test', - ], - 'DisplayName' => [ - 'title' => '项目展示名', - 'description' => '', - 'type' => 'string', - 'example' => 'xx test', - ], - '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' => '', - 'type' => 'string', - 'example' => '101111', - ], - 'OwnerName' => [ - 'title' => '项目责任人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Add data service project members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetProjectByName' => [ - 'summary' => '通过项目名获取项目详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddProjectMember' => [ + 'summary' => 'Adds members to a project.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + ], + [ + 'name' => 'AddCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '项目名', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The command to add members.', + 'type' => 'object', + 'properties' => [ + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values: DEV and PROD.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of user members.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '30012011'], + 'RoleList' => [ + 'title' => '', + 'description' => 'The member role. Valid values: 1: project administrator. 2: developer. 3: visitor. 4: analyst. 5: O&M engineer.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The member role. Valid values: 1: project administrator. 2: developer. 3: visitor. 4: analyst. 5: O&M engineer.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'test', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101131', - ], - 'BizUnitDisplayName' => [ - 'title' => '所属业务板块展示名', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'ComputeSourceId' => [ - 'title' => '绑定计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101711', - ], - 'ComputeSourceName' => [ - 'title' => '绑定计算源名', - 'description' => '', - 'type' => 'string', - 'example' => 'ds1', - ], - 'StreamComputeSourceId' => [ - 'title' => '绑定实时计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201711', - ], - 'StreamComputeSourceName' => [ - 'title' => '绑定实时计算源名', - 'description' => '', - 'type' => 'string', - 'example' => 'ds2', - ], - 'NameSpaceTag' => [ - 'title' => '名称空间：PUBLIC 公共类型、APPLICATION 应用类型、BASE 基础类型', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'Id' => [ - 'title' => '项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'Owner' => [ - 'title' => '项目责任人', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '项目责任人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Add project members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'AddProjectMember' => [ - 'summary' => '增加项目成员。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddRegisterLineage' => [ + 'summary' => 'Registers data lineage. Available since version v5.4.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -1113,806 +461,479 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AddCommand', + 'name' => 'AddRegisterLineageCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '新增成员命令', - 'description' => '', + 'title' => '', + 'description' => 'The command for registering and adding data lineage.', 'type' => 'object', 'properties' => [ - 'Env' => [ - 'title' => '环境标识: DEV、PROD', - 'description' => '', - 'type' => 'string', + 'Source' => [ + 'title' => '', + 'description' => 'The source asset.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID and BY_PROPERTY.', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'MetadataSubType' => ['title' => '', 'description' => 'The asset subtype. Specify this parameter only when metadataType is set to TABLE and referenceType is not set to BY_GUID.', 'type' => 'string', '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', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog property of the asset. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema property of the asset. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'table1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], 'required' => true, - 'example' => 'DEV', + 'example' => '', ], - 'UserList' => [ - 'title' => '用户成员', - 'description' => '', + 'Target' => [ + 'title' => '', + 'description' => 'The target asset.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID and BY_PROPERTY.', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'MetadataSubType' => ['title' => '', 'description' => 'The asset subtype. Specify this parameter only when metadataType is set to TABLE and referenceType is not set to BY_GUID.', 'type' => 'string', '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', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog property of the asset. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema property of the asset. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'table1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + 'DetailedLineages' => [ + 'title' => '', + 'description' => 'The detailed lineage relationships. For tables, these are field-level lineage relationships. If you do not want to add field-level lineage, leave this parameter empty.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => 'The child object lineage relationship.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', + 'Source' => [ + 'title' => '', + 'description' => 'The source asset reference.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID and BY_PROPERTY.', 'type' => 'string', 'example' => 'BY_GUID, BY_PROPERTY', 'required' => false], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1.column1'], + 'ParentGuid' => ['title' => '', 'description' => 'The GUID of the parent asset. If the current object is a field, parentGuid is the GUID of the table to which the field belongs.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'example' => 'COLUMN', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog property of the asset. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema property of the asset. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], 'required' => true, - 'example' => '30012011', + 'example' => '', ], - 'RoleList' => [ - 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'Target' => [ + 'title' => '', + 'description' => 'The target asset reference.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID and BY_PROPERTY.', 'type' => 'string', 'example' => 'BY_GUID, BY_PROPERTY', 'required' => false], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1.column1'], + 'ParentGuid' => ['title' => '', 'description' => 'The GUID of the parent asset. If the current object is a field, parentGuid is the GUID of the table to which the field belongs.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'example' => 'COLUMN', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog property of the asset. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema property of the asset. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], ], 'required' => true, + 'example' => '', ], + 'IsDirect' => ['title' => '', 'description' => 'Specifies whether this is a direct lineage relationship. Default value: true.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => ''], ], 'required' => false, + 'example' => '', ], - 'required' => true, + 'required' => false, + 'example' => '', ], + 'CheckAssetExist' => ['title' => '', 'description' => 'Specifies whether to check the existence of the asset. By default, the existence is not checked.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'RelationProperties' => ['title' => '', 'description' => 'The lineage relationship properties.', 'type' => 'object', 'required' => false, 'example' => ''], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300001234'], + 'UserId' => ['title' => '', 'description' => 'The ID of the current user.', 'type' => 'string', 'required' => false, 'example' => '300004567'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Register data lineage', + 'extraInfo' => 'Released version: v5.4.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetProjectWhiteLists' => [ - 'summary' => '获取项目白名单。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'AddTenantMembers' => [ + 'summary' => 'Adds users to a tenant in batches. Only super administrators (SuperAdmin) and system administrators can invoke this API operation.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'AddCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The request command.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'WhiteLists' => [ - 'title' => '项目白名单', - 'description' => '', + 'UserList' => [ + 'title' => '', + 'description' => 'The list of members.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => '', + 'description' => 'The member object.', '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', + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '1323241', 'title' => ''], + 'RoleList' => [ + 'title' => '', + 'description' => 'The list of roles. Valid values:'."\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' => 'The role.', 'type' => 'string', 'required' => false, 'example' => 'SECURITY_ADMIN'], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], + 'required' => true, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of adding members to the tenant.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Add users to a tenant', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListProjectMembers' => [ - 'summary' => '获取项目成员列表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddTenantMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'AddTenantMembersBySourceUser' => [ + 'summary' => 'Adds tenant members by using original user identities.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'description' => 'The add request.', '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', + 'SourceUserList' => [ + 'description' => 'The list of source users.', + 'type' => 'array', + 'items' => [ + 'description' => 'The source user.', + 'type' => 'object', + 'properties' => [ + 'SourceId' => ['title' => '', 'description' => 'The original ID of the user.', 'type' => 'string', 'required' => false, 'example' => '2323131'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'required' => false, 'example' => '123@xx.com'], + 'MobilePhone' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13888888888'], + 'Mail' => ['title' => '', 'description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '123@xx.com'], + 'DingNumber' => ['title' => '', 'description' => 'The DingTalk number.', 'type' => 'string', 'required' => false, 'example' => '123@dingding'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - 'required' => true, - 'example' => '1030111021', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '101111', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '101111', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '1721720955000', - ], - 'Id' => [ - 'title' => '用户成员ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12356', - ], - 'LastModifierName' => [ - 'title' => '最后编辑用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of the add operation.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Add users to a tenant by source user ID from the authentication system', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListProjects' => [ - 'summary' => '获取项目列表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddTenantMembersBySourceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'AddUserGroupMember' => [ + 'summary' => 'Adds members to a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'AddCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'title' => '', + 'description' => 'The command to add user group members.', 'type' => 'object', 'properties' => [ - 'Keyword' => [ - 'title' => '关键字模糊匹配', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'TagList' => [ - 'title' => '项目标签', - 'description' => '', + 'UserGroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => '132331'], + 'UserIdList' => [ + 'title' => '', + 'description' => 'The list of user IDs.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '342313'], 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认：20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'example' => '', ], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '162112', - ], - 'Type' => [ - 'title' => '项目类型', - 'description' => '', - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'GmtCreate' => [ - 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1030111021', - ], - 'DataSourceId' => [ - 'title' => '计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'RealtimeDataSourceId' => [ - 'title' => '实时计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1122', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of the add operation.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Add user group members', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'RemoveProjectMember' => [ - 'summary' => '删除项目成员。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddUserGroupMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ApplyDataServiceApi' => [ + 'summary' => 'Applies for API permissions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -1921,292 +942,209 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], [ - 'name' => 'RemoveCommand', + 'name' => 'ApplyCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除成员命令', - 'description' => '', + 'title' => '', + 'description' => 'The apply command.', 'type' => 'object', 'properties' => [ - 'Env' => [ - 'title' => '环境标识: DEV、PROD', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], - 'UserIdList' => [ - 'title' => '用户Id', - 'description' => '', + 'ExpireDate' => ['title' => '', 'description' => 'The expiration date in the format of yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30'], + 'Reason' => ['title' => '', 'description' => 'The reason for the application.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'ApiId' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021'], + 'ApplyType' => ['title' => '', 'description' => 'The application type. Valid values:'."\n" + ."\n" + .'- APP: application.'."\n" + .'- USER: individual account.', 'type' => 'string', 'required' => false, 'example' => 'APP', 'default' => 'APP'], + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1203'], + 'ProdFieldList' => [ + 'title' => '', + 'description' => 'The list of permission fields for query-type APIs in the production environment. This parameter is required in basic mode.', 'type' => 'array', 'items' => [ - 'title' => '用户Id', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The API permission field ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'], + ], + 'required' => false, 'description' => '', - 'type' => 'string', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'DevFieldList' => [ + 'title' => '', + 'description' => 'The list of permission fields for query-type APIs in the development environment. This parameter is required in dev-prod mode. DevFieldList and ProdFieldList cannot both be empty.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The API permission field ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'], + ], 'required' => false, - 'example' => '30012011', + 'description' => '', + 'example' => '', ], 'required' => false, + 'example' => '', + ], + 'ApplyDev' => ['title' => '', 'description' => 'Specifies whether to apply for permissions on operation-type APIs in the development environment.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ApplyProd' => ['title' => '', 'description' => 'Specifies whether to apply for permissions on operation-type APIs in the production environment.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AuthTypes' => [ + 'title' => '', + 'description' => 'The list of permission types.'."\n" + ."\n" + .'- When the principal is an application, the following permission types are supported. To apply for delegation permissions, you must also apply for usage permissions.'."\n" + ."\n" + .' - USE: usage permission.'."\n" + .' - DELEGATION: delegation permission.'."\n" + .'- When the principal is an individual, only USE (usage) permission is supported.'."\n" + .'- If this parameter is not specified, the default value is USE (usage) permission.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The permission type.', 'type' => 'string', 'example' => 'USE', 'default' => 'USE', 'required' => false], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', - ], - 'ReplaceProjectWhiteLists' => [ - 'summary' => '更新项目白名单。', - 'methods' => [ - 'post', + 'title' => 'Apply for data service API permissions', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ApplyDataServiceApp' => [ + 'summary' => 'Applies for application permissions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], [ - 'name' => 'ReplaceCommand', + 'name' => 'ApplyCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑命令', - 'description' => '', + 'title' => '', + 'description' => 'The apply command.', '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, - ], + 'ExpireDate' => ['title' => '', 'description' => 'The expiration date in the format of yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30'], + 'Reason' => ['title' => '', 'description' => 'The reason for the application.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'AppId' => ['title' => '', 'description' => 'appId', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2011'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Apply for data service application permissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateProjectMember' => [ - 'summary' => '增加项目成员。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AssignQualityRuleOfAllRuleScopeSchedules' => [ + 'summary' => 'Binds specified quality rules to schedule settings.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -2215,294 +1153,172 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'AssignCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑命令', - 'description' => '', + 'title' => '', + 'description' => 'The assignment binding instruction.', 'type' => 'object', 'properties' => [ - 'Env' => [ - 'title' => '环境标识', - 'description' => '', - 'type' => 'string', + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '平均值'], + 'RuleIdList' => [ + 'title' => '', + 'description' => 'The rule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], 'required' => true, - 'example' => 'DEV', + 'example' => '', ], - 'UserList' => [ - 'title' => '用户成员', - 'description' => '', + 'ScheduleIdList' => [ + 'title' => '', + 'description' => 'The schedule IDs.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30012011', - ], - 'RoleList' => [ - 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '成员角色: 1 项目管理员、2 开发者、3 访客、4 分析师、5 运维', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'required' => true, - ], - ], - 'required' => false, - ], + 'items' => ['title' => '', 'description' => 'The schedule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": false\\n}","type":"json"}]', + 'title' => 'Bind quality rules to schedule settings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateTenantComputeEngine' => [ - 'summary' => '修改租户计算设置。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CheckComputeSourceConnectivity' => [ + 'summary' => 'Checks the connectivity of a compute source.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'CheckCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑指令', - 'description' => '', + 'title' => '', + 'description' => 'The check command.', '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' => ['title' => '', 'description' => 'The compute source type.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], + 'ConfigList' => [ + 'title' => '', + 'description' => 'The connection configuration items.', 'type' => 'array', 'items' => [ - 'title' => '集群节点连接列表', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + ], + 'required' => false, 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10.1.11.2', + 'example' => '', ], 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Check compute source connectivity', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetCheckConnectivityJobs' => [ - 'summary' => '查询数据源连通性检查任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CheckComputeSourceConnectivityById' => [ + 'summary' => 'Checks the connectivity of an existing compute source by compute source ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -2511,161 +1327,170 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DataSourceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '462935472785', - ], + 'schema' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + '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\\": false\\n}","type":"json"}]', + 'title' => 'Check connectivity by compute source ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CheckDataSourceConnectivity' => [ + 'summary' => 'Checks the connectivity of a data source.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CheckCommand', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The object to check.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The data source type. For supported data source types, see the documentation for creating a data source.', 'type' => 'string', - 'example' => 'internal error', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'required' => true, + 'example' => 'MAX_COMPUTE', + 'enum' => [], ], - 'Data' => [ - 'title' => 'result', - 'description' => 'result', + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'The connection configuration items.', 'type' => 'array', 'items' => [ - 'title' => 'CheckConnectivityJobDTO', - 'description' => 'CheckConnectivityJobDTO', + 'title' => '', + 'description' => 'The connection configuration items.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '任务状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'TenantId' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30001011', - ], - 'JobType' => [ - 'title' => '任务类型（应用级别或集群级别）', - 'description' => '', - 'type' => 'string', - 'example' => 'application/cluster', - ], - 'ErrorMsg' => [ - 'title' => '错误信息（任务失败时的详细错误描述）', - 'description' => '', - 'type' => 'string', - 'example' => 'notFoundIp', - ], - 'VoldemortTaskId' => [ - 'title' => 'Voldemort任务ID（用于关联底层执行任务）', - 'description' => '', - 'type' => 'string', - 'example' => 't_7572319950395080706_20251225_7572319950395080707', - ], - 'DataSourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => '192', - ], - 'JobId' => [ - 'title' => '任务ID', - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], + 'required' => true, + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The connectivity check result of the data source.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Check data source connectivity', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetDataSourceDependencies' => [ - 'summary' => '查询数据源变更影响的集成任务及数据库SQL任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckDataSourceConnectivity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'CheckDataSourceConnectivityById' => [ + 'summary' => 'Checks the connectivity of a data source.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2673,562 +1498,289 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1023211', - ], + 'schema' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The 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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'pipeline', - ], - 'Id' => [ - 'title' => '依赖记录id', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '依赖记录名称', - 'description' => '', - 'type' => 'string', - 'example' => 'jytest', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The connectivity check result of the data source.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Check connectivity by data source ID', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateDataSource' => [ - 'summary' => '新建数据源', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckDataSourceConnectivityById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CheckProjectHasDependency' => [ + 'summary' => 'Checks whether a project has data dependencies such as tasks.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant 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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => '配置值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'DevDataSourceCreate' => [ - 'title' => '新建开发环境数据源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProdDataSourceId' => [ - 'title' => '关联生产环境数据源ID，如果只新建开发环境计算源时不能为空', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => '配置值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '数据源新建结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DevDataSourceId' => [ - 'title' => '开发环境数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'ProdDataSourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], - 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\\": false\\n}","type":"json"}]', + 'title' => 'Check whether a project is depended on', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckProjectHasDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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"}]', ], - 'DeleteDataSource' => [ - 'summary' => '删除数据源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CheckResourcePermission' => [ + 'summary' => 'Checks whether a user has the permission on a specified resource.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'CheckCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除数据源请求', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '删除模式：'."\n" - .'DEV：只删除开发环境数据源'."\n" - .'DEV_PROD：同时删除开发和生产环境数据源', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'DEV', - 'enum' => [ - 'DEV', - 'DEV_PROD', + 'title' => '', + 'description' => 'Check user resource permission', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'required' => true, 'example' => '323231'], + 'ResourceType' => ['title' => '', 'description' => 'Resource type'."\n" + .'- PHYSICAL_TABLE: Physical table'."\n" + .'- PHYSICAL_FIELD: Physical table field'."\n" + .'- LOGICAL_TABLE: Fact logical table'."\n" + .'- LOGICAL_FIELD: Fact logical table field'."\n" + .'- LABEL_TABLE: Label logical table'."\n" + .'- LABEL_FIELD: Label logical table field'."\n" + .'- DATASOURCE: Data source'."\n" + .'- GLOBAL_PARAM: Global parameter'."\n" + .'- REALTIME_LOGICAL_TABLE: Real-time meta table'."\n" + .'- REALTIME_LOGICAL_FIELD: Real-time meta table field'."\n" + .'- REALTIME_MIRROR_TABLE: Mirror table'."\n" + .'- REALTIME_MIRROR_FIELD: Real-time mirror table field'."\n" + .'- FUNCTION: Function'."\n" + .'- FEATURE: Feature permission'."\n" + .'- PHYSICAL_VIEW: Physical view'."\n" + .'- LOGICAL_VIEW: Logical view'."\n" + .'- QD_SERVICE_FEATURE: Service tag'."\n" + .'- QD_ADVANCED_FEATURE: Advanced tag'."\n" + .'- QD_CLUSTER: Group'."\n" + .'- QD_EVENT: Event'."\n" + .'- QD_OFFLINE_SERVICE: Tag offline service task'."\n" + .'- PHYSICAL_MATERIALIZED_VIEW: Materialized view', 'type' => 'string', 'required' => true, 'example' => 'PHYSICAL_TABLE'], + 'ResourceList' => [ + 'title' => '', + 'description' => 'Permission resource list', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Permission resource', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '', 'description' => 'Resource ID', 'type' => 'string', 'required' => true, 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01'], + ], + 'required' => false, + 'example' => '', ], - ], - 'ProdDataSourceId' => [ - 'title' => '生成环境数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '13121', + 'example' => '', ], + 'Operate' => ['title' => '', 'description' => 'Operation type', 'type' => 'string', 'required' => true, 'example' => 'UPDATE'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '删除结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a successful request', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'ResourcePermissionList' => [ + 'title' => '', + 'description' => 'Resource permission list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '', 'description' => 'Resource ID', 'type' => 'string', 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01'."\n"], + 'HasPermission' => ['title' => '', 'description' => 'Indicates whether the user has the permission on the specified resource', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Check whether a user has the permission on a specified resource', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateDataSourceBasicInfo' => [ - 'summary' => '编辑数据源基本信息', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateAdHocFile' => [ + 'summary' => 'Creates an ad hoc query file.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3236,140 +1788,88 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '数据源基础信息编辑', - 'description' => '', + 'title' => '', + 'description' => 'The request for creating an ad hoc query file.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '23231', - ], - 'Name' => [ - 'title' => '数据源名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Description' => [ - 'title' => '数据源描述', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xx', - ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11212133'], + 'Name' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'test_xx'], + 'Directory' => ['title' => '', 'description' => 'The directory where the file is located.', 'type' => 'string', 'required' => true, 'example' => '/xx1/xx2/'], + 'Content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'required' => true, 'example' => 'select 1;'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '数据源基础信息编辑结果.', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1212313222'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Create an ad hoc query file', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateDataSourceConfig' => [ - 'summary' => '编辑数据源连接配置项', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateBatchTask' => [ + 'summary' => 'Creates a batch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3377,1364 +1877,1227 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The create command.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The folder path in the menu tree to which the node belongs.', 'type' => 'string', 'required' => true, 'example' => '/a/b'], + 'Name' => ['title' => '', 'description' => 'The name of the batch task.', 'type' => 'string', 'required' => true, 'example' => 'test111'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => true, 'example' => 'xx test.'], + 'ScheduleType' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" + .'- 1: periodic node.'."\n" + .'- 3: manual node.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], + 'TaskType' => ['title' => '', 'description' => 'The node type. Valid values:'."\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' => '', 'description' => 'The execution engine for the node, such as a Python node. Valid values:'."\n" + .'- 1: PYTHON2_7'."\n" + .'- 2: PYTHON3_7'."\n" + .'- 3: PYTHON3_11.', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for a database SQL node.', 'type' => 'string', 'required' => false, 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for a database SQL node. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for a database SQL node. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'required' => false, 'example' => 'erp'], + 'PythonModuleList' => [ + 'title' => '', + 'description' => 'The list of third-party Python packages that the node depends on.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The third-party Python package.', 'type' => 'string', 'required' => true, 'example' => 'numpy'], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['title' => '', 'description' => 'The node ID in the node directory tree.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"FileId\\": 12113111\\n }\\n}","type":"json"}]', + 'title' => 'Create a batch task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'UpdateCommand', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateBizEntity' => [ + 'summary' => 'Creates a business entity.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '数据源配置项变更', - 'description' => '', + 'title' => '', + 'description' => 'The create request.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '13231313', + 'BizObject' => [ + 'title' => '', + 'description' => 'The business object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The code name of the business object. The name can be up to 64 characters in length and can contain only letters, digits, and underscores. For ADB_PG engines, the code name can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business object. The name can be up to 64 characters in length and can contain only Chinese characters, letters, digits, underscores, and hyphens.', 'type' => 'string', 'required' => true, 'example' => 'create_object_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the business object owner.', 'type' => 'string', 'required' => false, 'example' => '30010010'], + 'Type' => ['title' => '', 'description' => 'The object type of the business object. Valid values:'."\n" + .'- NORMAL: common object.'."\n" + .'- ENUM: enumeration object.'."\n" + .'- VIRTUAL: virtual object.'."\n" + .'- HIERARCHY: hierarchy object.', 'type' => 'string', 'required' => true, 'example' => 'NORMAL'], + 'ParentId' => ['title' => '', 'description' => 'The parent entity from which the business object inherits. Only common business objects support inheritance, and the parent entity must be an online business object.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '116306'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of an associated online business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', ], - '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', - ], + 'BizProcess' => [ + 'title' => '', + 'description' => 'The business activity.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The code name of the business activity. The name can be up to 64 characters in length and can contain only letters, digits, and underscores. For ADB_PG engines, the code name can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'create_process_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business activity. The name can be up to 64 characters in length and can contain only Chinese characters, letters, digits, underscores, and hyphens.', 'type' => 'string', 'required' => true, 'example' => 'create_process_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business activity. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the business activity owner.', 'type' => 'string', 'required' => false, 'example' => '30010010'], + 'Type' => ['title' => '', 'description' => 'The type of the business activity. Valid values:'."\n" + .'- BIZ_EVENT: business event.'."\n" + .'- BIZ_SNAPSHOT: business snapshot.'."\n" + .'- BIZ_PROCESS: business process.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_EVENT'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of an associated online business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106'], + 'required' => false, + 'example' => '', + ], + 'BizEventEntityIdList' => [ + 'title' => '', + 'description' => 'The list of business event activity IDs included in the business process activity. This parameter takes effect only when the current activity is a business process activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of a business event activity included in the business process activity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106'], + 'required' => false, + 'example' => '', + ], + 'PreBizProcessIdList' => [ + 'title' => '', + 'description' => 'The list of preceding business process activity IDs for the business process activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of preceding business process activity IDs for the business process activity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106'], + 'required' => false, + 'example' => '', ], - 'required' => true, ], - 'required' => true, + 'required' => false, + 'example' => '', ], + 'Type' => ['title' => '', 'description' => 'The business type. Valid values: '."\n" + .'- BIZ_OBJECT: business object.'."\n" + .'- BIZ_PROCESS: business activity.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain to which the business activity belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20101011'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the business activity belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '数据源连接配置项编辑结果.', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'BizEntityId' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"BizEntityId\\": 12113111\\n }\\n}","type":"json"}]', + 'title' => 'Create a business entity', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:15:09.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListDataSourceWithConfig' => [ - 'summary' => '搜索数据源，所属结果包含数据源配置项', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CreateBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateBizMetric' => [ + 'summary' => 'Creates a business metric.'."\n" + .'Release version: v5.5.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'CreateBizMetricCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询', - 'description' => '', + 'title' => '', + 'description' => 'The create request.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '数据源名字', - 'description' => '', - 'type' => 'string', + 'Name' => ['title' => '', 'description' => 'The name of the business metric. The name must be unique within the tenant. The name can contain letters, digits, and the following special characters: -_/\\·#$^&*()%+=. The name can be up to 256 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'example' => 'Metric1'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'maxLength' => 256, 'required' => false, 'example' => 'MetricDisplayName'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'MetricDesc'], + 'Labels' => [ + 'title' => '', + 'description' => 'The asset labels.', + 'type' => 'array', + 'items' => ['description' => 'The asset labels.', 'type' => 'string', 'required' => false, 'example' => 'Label1', 'title' => ''], 'required' => false, - 'example' => 'vcns-test', + 'example' => '', ], - 'TypeList' => [ - 'title' => '数据源类型', - 'description' => '', + 'CatalogIds' => [ + 'title' => '', + 'description' => 'The IDs of the folders to which the metric belongs.', + 'type' => 'array', + 'items' => ['description' => 'The IDs of the folders to which the metric belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567890', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'BizOwnerName' => ['title' => '', 'description' => 'The name of the business owner. Enter the username of the owner account.', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin'], + 'MetricDefinition' => ['title' => '', 'description' => 'The metric definition. To reference other business metrics, enclose the metric name in square brackets [ ].', 'type' => 'string', 'maxLength' => 2000, 'required' => false, 'example' => '[Metric1]+[Metric2]'], + 'RelatedBizMetrics' => [ + 'title' => '', + 'description' => 'The list of related business metrics. Enter the names of related business metrics and their relationships.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'Metric2'], + 'RelationType' => [ + 'title' => '', + 'description' => 'The relationship type. Valid values:'."\n" + .'- POSITIVE: positive correlation.'."\n" + .'- NEGATIVE: negative correlation.'."\n" + .'- OTHER: other.', + 'type' => 'string', + 'required' => false, + 'enum' => ['POSITIVE', 'NEGATIVE', 'OTHER'], + 'example' => 'POSITIVE', + ], + ], 'required' => false, - 'example' => 'MAX_COMPUTE', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'ScopeList' => [ - 'title' => '数据源使用范围，支持如下：'."\n" - .'STREAMING 实时'."\n" - .'OFFLINE 离线'."\n" - .'DIP_META_SYNC 元仓初始化'."\n" - .'DATA_DISTILL 数据萃取'."\n" - .'CUMPUTE_SOURCE_SHADOW 影子计算源'."\n" - .'LABEL 标签'."\n" - .'ALL 离线+实时', - 'description' => '', + 'AssociatedTechMetricFullNames' => [ + 'title' => '', + 'description' => 'The list of full names of associated technical metrics. Enter the full name in the format of "OwnerTableFullName.MetricName", where "OwnerTableFullName" equals "AssetSource.OwnerTableName". A technical metric can be associated with only one business metric and cannot be associated repeatedly.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', + 'items' => ['description' => 'The full name of the associated technical metric.', 'type' => 'string', 'required' => false, 'example' => 'LD_bizunit.table1.index1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'MetricRelationDiagramSwitchOpen' => ['title' => '', 'description' => 'Specifies whether to enable the metric relationship diagram. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.'."\n" + ."\n" + .'This parameter can be set to true only when at least one related business metric exists. Otherwise, the diagram is automatically disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MetricRelationDiagramExpression' => ['title' => '', 'description' => 'This parameter is read only when the metric relationship diagram is enabled. Enter a calculation expression composed of metric names selected from the related business metrics. Supported operators include +, -, *, /, (, ), %, and ∑. Each metric name must be enclosed in square brackets [ ]. If no operator is specified between two metrics, the system automatically inserts a padding placeholder. If no metric relational expression is configured, the metric relationship diagram switch is automatically shutdown.', 'type' => 'string', 'required' => false, 'example' => '[Metric1]+[Metric2]'], + 'OperateInstructionEnabled' => ['title' => '', 'description' => 'Specifies whether to enable the operation instructions. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'OperateInstructionContent' => ['title' => '', 'description' => 'The content of the operation instructions. Only text format is supported.', 'type' => 'string', 'required' => false, 'example' => 'content'], + 'ViewScope' => [ + 'title' => '', + 'description' => 'The visibility scope.', + 'type' => 'object', + 'properties' => [ + 'ScopeType' => [ + 'title' => '', + 'description' => 'The visibility scope type. Valid values:'."\n" + .'- ALL_USERS_CAN_VIEW: visible to all users.'."\n" + .'- PART_USERS_CAN_VIEW: visible to specified users.'."\n" + .'- PART_USERS_CAN_NOT_VIEW: not visible to specified users.', + 'type' => 'string', + 'required' => false, + 'enum' => ['ALL_USERS_CAN_VIEW', 'PART_USERS_CAN_VIEW', 'PART_USERS_CAN_NOT_VIEW'], + 'example' => 'PART_USERS_CAN_VIEW', + ], + 'UserNames' => [ + 'title' => '', + 'description' => 'The usernames of individual accounts. This parameter takes effect only when the visibility scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW.', + 'type' => 'array', + 'items' => ['description' => 'The username of an individual account.', 'type' => 'string', 'required' => false, 'example' => 'SuperAdmin', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'UserGroupNames' => [ + 'title' => '', + 'description' => 'The names of user groups. This parameter is read only when the visibility scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW.', + 'type' => 'array', + 'items' => ['description' => 'The name of a user group.', 'type' => 'string', 'required' => false, 'example' => 'UserGroup1', 'title' => ''], + 'required' => false, + 'example' => '', + ], ], 'required' => false, + 'example' => '', ], - 'OwnerList' => [ - 'title' => '数据源负责人', - 'description' => '', + 'CustomAttribute' => [ + 'title' => '', + 'description' => 'The custom attributes.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of custom attributes. Enter the code and values for each attribute.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The code of the custom attribute.', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeCode'], + 'Values' => [ + 'title' => '', + 'description' => 'The list of attribute values. 1. For custom input and single-select dropdown attributes, only the first value in the list is read. 2. For multi-select dropdown attributes, all values in the list are read. 3. For hyperlink attributes, the first value is used as the display text and the second value is used as the redirect link.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The custom attribute value.', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeValue'], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => '2323131', + 'example' => '', ], 'required' => false, - ], - 'Tag' => [ - 'title' => '创建数据源时标记的tag', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Page' => [ - 'title' => '页码，起始页是1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - 'default' => '20', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'PageResult' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => 'The backend response code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'The error details from the backend.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The operation result.', '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300000028799', - ], - 'Name' => [ - 'title' => '数据源名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '212211111', - ], - 'CreatorName' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Owner' => [ - 'title' => '负责人ID', - 'description' => '', - 'type' => 'string', - 'example' => '212211111', - ], - 'OwnerName' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Env' => [ - 'title' => '数据源所属环境', - 'description' => '', - 'type' => 'string', - 'example' => 'PROD', - ], - 'ConfigItemList' => [ - 'title' => '连接配置项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '连接配置项', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '配置项Id', - 'description' => '', - 'type' => 'string', - 'example' => 'param1', - ], - 'Value' => [ - 'title' => '配置项值', - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], - 'DevDataSourceInfo' => [ - 'description' => '开发环境数据源信息', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12313123131', - ], - 'Name' => [ - 'title' => '数据源名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '212211111', - ], - 'CreatorName' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Owner' => [ - 'title' => '负责人ID', - 'description' => '', - 'type' => 'string', - 'example' => '212211111', - ], - 'OwnerName' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Env' => [ - 'title' => '数据源所属环境', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'ConfigItemList' => [ - 'title' => '连接配置项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '连接配置项', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '配置项Id', - 'description' => '', - 'type' => 'string', - 'example' => 'param1', - ], - 'Value' => [ - 'title' => '配置项值', - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Success' => ['title' => '', 'description' => 'Indicates whether the creation was successful. Valid values:'."\n" + .'- true: Succeeded.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Create a business metric', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CheckDataSourceConnectivity' => [ - 'summary' => '检查数据源连通性', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateBizUnit' => [ + 'summary' => 'Creates a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CheckCommand', + 'name' => 'CreateCommand', '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' => '', + 'title' => '', + 'description' => 'The create request.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The code name of the business object. The name can be up to 64 characters in length and can contain only letters, digits, and underscores. For ADB_PG engines, the code name can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business object. The name can be up to 64 characters in length and can contain only Chinese characters, letters, digits, underscores, and hyphens.', 'type' => 'string', 'required' => true, 'example' => 'create_object_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Icon' => ['title' => '', 'description' => 'The preset icon. Valid values:'."\n" + .'- icon-e-commerce: E-commerce.'."\n" + .'- icon-finance: Finance.'."\n" + .'- con-cloud-computing: Cloud computing.'."\n" + .'- icon-advertisement: Advertising and marketing.'."\n" + .'- icon-logistics: Logistics.'."\n" + .'- icon-entertainment: Entertainment.'."\n" + .'- icon-traffic: Travel.'."\n" + .'- icon-health: Health.'."\n" + .'- icon-social-contact: Social and communication.'."\n" + .'- con-dining: Dining.'."\n" + .'- icon-education: Education.'."\n" + .'- icon-environment: Environment.', 'type' => 'string', 'required' => true, 'example' => 'icon-environment'], + 'Mode' => ['title' => '', 'description' => 'The production mode. Valid values:'."\n" + .'- BASIC: single-environment mode.'."\n" + .'- DEV_PROD: development/production dual-environment mode.', 'type' => 'string', 'required' => false, 'example' => 'DEV_PROD'], + 'BizUnitAccountList' => [ + 'title' => '', + 'description' => 'The list of data domain architects.', 'type' => 'array', 'items' => [ - 'title' => '连接配置项', - 'description' => '', + 'title' => '', + 'description' => 'The list of data domain architects.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '配置项keyId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => '配置值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '20001201'], ], 'required' => true, + 'example' => '', ], 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '数据源连接校验结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the created data domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"BizUnitId\\": 545844456\\n }\\n}","type":"json"}]', + 'title' => 'Create a data domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CheckDataSourceConnectivityById' => [ - 'summary' => '检查已创建的数据源是否正常连通', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateComputeSource' => [ + 'summary' => 'Creates a compute source. Business unit administrators and project administrators have permissions to perform this operation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'Name' => ['title' => '', 'description' => 'The name of the compute source.', 'type' => 'string', 'required' => true, 'example' => 'test1011'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The type of the compute source.', 'type' => 'string', 'required' => true, 'example' => 'MacCompute'], + 'ConfigList' => [ + 'title' => '', + 'description' => 'The connection configuration items.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], - 'Data' => [ - 'title' => '数据源连接校验结果', - 'type' => 'boolean', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the compute source.', 'type' => 'integer', 'format' => 'int64', 'example' => '12356'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Create a compute source', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'CheckComputeSourceConnectivity' => [ - 'summary' => '项目计算源连通性检查。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'CreateDataDomain' => [ + 'summary' => 'Creates a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CheckCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '校验指令', - 'description' => '', + 'title' => '', + 'description' => 'The create request.', '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, - ], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the data unit to which the data domain belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456'], + 'Name' => ['title' => '', 'description' => 'The code of the data domain.', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the data domain.', 'type' => 'string', 'required' => true, 'example' => '主题域测试'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the data domain.', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name'], + 'Description' => ['title' => '', 'description' => 'The description of the data domain.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the parent data domain.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10232311'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"CreateResult\\": {\\n \\"DataDomainId\\": 1241844456\\n }\\n}","type":"json"}]', + 'title' => 'Create a data domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CheckComputeSourceConnectivityById' => [ - 'summary' => '计算源连通性检查。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateDataServiceApi' => [ + 'summary' => 'Creates a data service API and submits it.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request for creating an API.', + 'type' => 'object', + 'properties' => [ + 'ApiName' => ['title' => '', 'description' => 'The name of the API.', 'type' => 'string', 'required' => true, 'example' => 'API_01'], + 'Version' => ['title' => '', 'description' => 'The version of the API.', 'type' => 'string', 'required' => true, 'example' => 'V1'], + 'ApiType' => [ + 'title' => '', + 'description' => 'The type of the API. Valid values:'."\n" + ."\n" + .'- 3: datasource SQL mode.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + 'Mode' => ['title' => '', 'description' => 'The development mode of the API. Valid values:'."\n" + ."\n" + .'- 0: Basic mode '."\n" + .'- 1: Dev-Prod mode.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'ApiGroupId' => ['title' => '', 'description' => 'The group ID of the API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101'], + 'ApiGroupName' => ['title' => '', 'description' => 'The group name of the API.', 'type' => 'string', 'required' => true, 'example' => '默认API分组'], + 'Description' => ['title' => '', 'description' => 'The description of the API.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'RequestType' => ['title' => '', 'description' => 'The request method of the API. Valid values:'."\n" + ."\n" + .'- 0 (GET): Returns a single record. The query result is unique. '."\n" + .'- 1 (LIST): Returns multiple records.'."\n" + .'- 2 (CREATE): Creates objects. Supports single or batch creation.'."\n" + .'- 3 (UPDATE): Updates objects. Supports single or batch updates.'."\n" + .'- 4 (DELETE): Deletes objects. Supports single or batch deletions.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'BizProtocol' => [ + 'title' => '', + 'description' => 'The protocol. Different gateway types support different protocols. For more information, see the documentation. Valid values:'."\n" + .'- 0: HTTP '."\n" + .'- 1: HTTPS.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => '0：HTTP 1：HTTPS', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'required' => true, + 'example' => '', + ], + 'Timeout' => ['title' => '', 'description' => 'The timeout period, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'], + 'CacheTimeout' => ['title' => '', 'description' => 'The cache timeout period, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'], + 'UpdateRate' => ['title' => '', 'description' => 'The update frequency. Default value: 1. Valid values:'."\n" + ."\n" + .'- 0: custom'."\n" + .'- 1: day'."\n" + .'- 2: hour'."\n" + .'- 3: minute.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'CustomUpdateRate' => ['title' => '', 'description' => 'The custom update frequency. This parameter is required when the update frequency is set to custom.', 'type' => 'string', 'required' => false, 'example' => '每天8点'], + 'CallMode' => ['title' => '', 'description' => 'The call mode of the API. Default value: 1. Valid values:'."\n" + ."\n" + .'- 1: synchronous call'."\n" + .'- 2: asynchronous call.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'ExecutionTimeout' => ['title' => '', 'description' => 'The execution timeout period for asynchronous API calls. This parameter takes effect only for asynchronous API calls and is required when the call mode is asynchronous.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'ScriptDetails' => [ + 'title' => '', + 'description' => 'The details of the script API.', + 'type' => 'object', + 'properties' => [ + 'Script' => ['title' => '', 'description' => 'The SQL script.', 'type' => 'string', 'required' => true, 'example' => 'select a,b,c from table1 where d = ${d}'], + 'IsPaginated' => ['title' => '', 'description' => 'Specifies whether to paginate the results. This parameter is required only when RequestType is set to List. Default value: false. Pagination is not supported in asynchronous call mode.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'SqlMode' => ['title' => '', 'description' => 'The SQL mode. Valid values:'."\n" + ."\n" + .'- 1: basic mode'."\n" + .'- 2: advanced mode.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'SortPriority' => ['title' => '', 'description' => 'The sorting priority. This parameter takes effect only when the SQL mode is basic mode. Default value: 2. Valid values:'."\n" + ."\n" + .'- 1: SQL script '."\n" + .'- 2: OrderByList request parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + 'DatasourceType' => ['title' => '', 'description' => 'The data type on which the API is based. Valid values:'."\n" + .'- 1: datasource.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'DatasourceID' => ['title' => '', 'description' => 'The ID of the datasource. This parameter is required when the API mode is direct datasource connection.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6668888888888812345L'], + 'ScriptRequestParameters' => [ + 'title' => '', + 'description' => 'The list of request parameters for the script API.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request parameter.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => true, 'example' => 'd'], + 'ParameterDescription' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'required' => false, 'example' => '字段d'], + 'ParameterValueType' => ['title' => '', 'description' => 'The value type of the parameter. Valid values:'."\n" + ."\n" + .'- 1 (single value): A fixed value used for operators such as =, >=, <=, >, <, !=, and between. '."\n" + .'- 2 (multiple values): The input parameter contains multiple values separated by commas (,). Used for In and Not In operators.', 'type' => 'string', 'required' => true, 'example' => '='], + 'ParameterDataType' => ['title' => '', 'description' => 'The data type. Valid values:'."\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' => 'The example value.', 'type' => 'string', 'example' => 'test', 'required' => false], + 'IsRequiredParameter' => ['title' => '', 'description' => 'Specifies whether the parameter is required.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value of the input parameter for operation-type APIs. This parameter takes effect when the parameter is not required. If not specified, the value is null.', 'type' => 'string', 'example' => 'test', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'ScriptResponseParameters' => [ + 'title' => '', + 'description' => 'The list of response parameters for the script API.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameter.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => true, 'example' => 'a'], + 'ParameterDescription' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'required' => false, 'example' => '字段a'], + 'ParameterDataType' => ['title' => '', 'description' => 'The data type. Valid values:'."\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' => 'The example value.', 'type' => 'string', 'required' => false, 'example' => 'amazing'], + 'ParameterLocation' => ['title' => '', 'description' => 'The location of the response parameter for operation-type APIs. This parameter must be set when the API is an operation-type API with batch data volume. Valid values:'."\n" + .'- success: the response data of a successful operation'."\n" + .'- failed: the response data of a failed operation.', 'type' => 'string', 'example' => 'success', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'RowPermissionIds' => [ + 'title' => '', + 'description' => 'The list of row-level permission IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The row-level permission ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'required' => false], + 'required' => false, + 'example' => '', + ], + 'ReturnSqlSwitch' => ['title' => '', 'description' => 'Specifies whether to return the SQL in the result.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + 'DmlConfig' => [ + 'title' => '', + 'description' => 'The configuration of the operation-type API. This parameter is not required when creating a query-type API.', + 'type' => 'object', + 'properties' => [ + 'DataVolumeType' => ['title' => '', 'description' => 'The data volume type. Valid values:'."\n" + .'- 1: single record'."\n" + .'- 2: batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'required' => false], + 'MaxInputDataSize' => ['title' => '', 'description' => 'The maximum number of input records. Valid values:'."\n" + .'- When the data volume type is single record, this parameter cannot be set.'."\n" + .'- When the data volume type is batch, the value ranges from 1 to 1000000.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'required' => false], + 'ErrorHandlingType' => ['title' => '', 'description' => 'The error handling method. Valid values:'."\n" + .'- 1: partial success allowed'."\n" + .'- 2: all must succeed'."\n" + ."\n" + .'Parameter rules:'."\n" + .'- When the data volume type is single record, this parameter cannot be set.'."\n" + .'- When the data volume type is batch, the value is 1 or 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'TransactionType' => ['title' => '', 'description' => 'The transaction processing mode. Valid values:'."\n" + .'- 0: no transaction'."\n" + .'- 1: no batching'."\n" + .'- 2: batch processing'."\n" + ."\n" + .'Parameter rules:'."\n" + .'- When the data volume type is single record, the transaction processing mode is 0.'."\n" + .'- When the data volume type is batch:'."\n" + .' - If the error handling method is 1, the transaction processing mode is 1 or 2.'."\n" + .' - If the error handling method is 2, the transaction processing mode can only be 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'required' => false], + 'BatchInputDataSize' => ['title' => '', 'description' => 'The data volume per batch. Valid values:'."\n" + .'- When the data volume type is single record, this parameter cannot be set.'."\n" + .'- When the data volume type is batch:'."\n" + .' - If the transaction processing mode is 1, this parameter cannot be set.'."\n" + .' - If the transaction processing mode is 2, the value ranges from 1 to 1000000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'required' => false], + 'ParallelNum' => ['title' => '', 'description' => 'The degree of parallelism. Valid values:'."\n" + .'- When the data volume type is single record, this parameter cannot be set.'."\n" + .'- When the data volume type is batch:'."\n" + .' - If the transaction processing mode is 1, this parameter cannot be set.'."\n" + .' - If the transaction processing mode is 2, the value ranges from 1 to 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - 'example' => '12356', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ApiId' => ['title' => '', 'description' => 'The ID of the created API.', 'type' => 'integer', 'format' => 'int64', 'example' => '10086'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'ListComputeSources' => [ - 'summary' => '查询计算源列表。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"ApiId\\": 10086\\n}","type":"json"}]', + 'title' => 'Create a data service API and submit it', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-30T01:49:47.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateDataServiceApp' => [ + 'summary' => 'Creates a data service application. Only super administrators or system administrators can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'title' => '', + 'description' => 'The command to create a data service application.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'AppGroupId' => ['title' => '', 'description' => 'The application group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200000000'], + 'AppKey' => ['title' => '', 'description' => 'The application key, which must be globally unique and is used when calling APIs.'."\n" + .'The key must be 8 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-).'."\n" + .'This parameter can be customized only when using Alibaba Cloud API Gateway or the built-in gateway. This parameter is ignored when using a dedicated cloud gateway.', 'type' => 'string', 'required' => false, 'example' => '200000001', 'maxLength' => 128, 'minLength' => 8], + 'Scenarios' => ['title' => '', 'description' => 'Common scenarios.', 'type' => 'string', 'required' => true, 'example' => '数据分析'], + 'AppSecret' => ['title' => '', 'description' => 'The app secret.'."\n" + .'If this parameter is not specified, the system automatically generates a new AppSecret value.'."\n" + .'The secret must be 8 to 127 characters in length and can contain letters, digits, underscores (_), and hyphens (-).'."\n" + .'This parameter can be customized only when using Alibaba Cloud API Gateway or the built-in gateway. This parameter is ignored when using a dedicated cloud gateway.', 'type' => 'string', 'required' => false, 'example' => 'abc123456789', 'maxLength' => 127, 'minLength' => 8], + 'OwnerIds' => [ + 'title' => '', + 'description' => 'The list of owner IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The owner ID.', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'required' => true, + 'example' => '', ], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => '默认应用', 'maxLength' => 64, 'minLength' => 4], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102111', - ], - 'BindProjectName' => [ - 'title' => '绑定项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'testPrj', - ], - 'CreatorName' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '-809333788831'], + 'Code' => ['title' => '', 'description' => 'The response code returned by the backend.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": -809333788831,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Create a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateComputeSource' => [ - 'summary' => '修改计算源。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataServiceAppGroup' => [ + 'summary' => 'Creates a data service application group. Only superusers and system administrators can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -4743,364 +3106,674 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'required' => true, 'example' => 'default_app_group', 'maxLength' => 64], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '538893915703'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 538893915703,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a data service application group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateDataSource' => [ + 'summary' => 'Create Data Source: Tenant administrators, data administrators, business unit administrators, project administrators, and operations administrators have permission to perform this operation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'UpdateCommand', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑指令', - 'description' => '', + 'title' => '', + 'description' => 'Request object', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '计算源Id', - 'description' => '', - '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', + 'ProdDataSourceCreate' => [ + 'title' => '', + 'description' => 'Production environment data source', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Data source type:'."\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, etc.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], + 'Name' => ['title' => '', 'description' => 'Data source name', 'type' => 'string', 'required' => true, 'example' => 'dp_test'], + 'Description' => ['title' => '', 'description' => 'Data source description', 'type' => 'string', 'required' => false, 'example' => 'datasource for xx'], + 'CheckActivity' => ['title' => '', 'description' => 'Whether to check connectivity', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'List of connection configuration items', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Connection configuration item', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Configuration item. For the key values required by different databases, see the supplementary description at the bottom of the document.', 'type' => 'string', 'required' => true, 'example' => 'jdbc.username'], + 'Value' => ['title' => '', 'description' => 'Configuration item value', 'type' => 'string', 'required' => true, 'example' => 'username'], + ], 'required' => true, - 'example' => 'v1', + 'example' => '', ], - 'Key' => [ - 'title' => '配置项', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'DevDataSourceCreate' => [ + 'title' => '', + 'description' => 'Development environment data source', + 'type' => 'object', + 'properties' => [ + 'ProdDataSourceId' => ['title' => '', 'description' => 'Associated production environment data source ID. This parameter cannot be empty when only creating a development environment compute source.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011'], + 'DataSourceCreate' => [ + 'title' => '', + 'description' => 'Development environment data source', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Data source type', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], + 'Name' => ['title' => '', 'description' => 'Data source name', 'type' => 'string', 'required' => true, 'example' => 'dp_test_dev'], + 'Description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'required' => false, 'example' => 'datasource for xxx in dev '], + 'CheckActivity' => ['title' => '', 'description' => 'Whether to check connectivity', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'List of connection configuration items', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Connection configuration item', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Configuration item. For the key values required by different databases, see the supplementary description at the bottom of the document.', 'type' => 'string', 'required' => true, 'example' => 'jdbc.username'], + 'Value' => ['title' => '', 'description' => 'Configuration item value', 'type' => 'string', 'required' => true, 'example' => 'username'], + ], + 'required' => true, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], ], + 'required' => false, + 'example' => '', ], - 'required' => false, ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Response result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates that the request is successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'CreateResult' => [ + 'title' => '', + 'description' => 'Data source creation result', + 'type' => 'object', + 'properties' => [ + 'DevDataSourceId' => ['title' => '', 'description' => 'Development environment data source ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'ProdDataSourceId' => ['description' => 'Production environment data source ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - '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"}]', - ], - 'GetComputeSource' => [ - 'summary' => '获取计算源详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => 'CreateDataSource', + 'requestParamsDescription' => '## ConfigItemList Parameter Key Description'."\n" + .'### MAX_COMPUTE'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|maxcompute.endpoint | Yes | |'."\n" + .'|maxcompute.project | Yes | |'."\n" + .'|maxcompute.access.id | Yes | |'."\n" + .'|maxcompute.access.key | Yes | |'."\n" + ."\n\n" + ."\n" + .'### HDFS'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|hadoop.kdc.address | No | Not required if .krb5.config.file is provided|'."\n" + .'|hadoop.kerberos.krb5.config.file | No | Not required if hadoop.kdc.address is provided|'."\n" + .'|hadoop.kerberos.krb5.config.filename | Yes | krb5.config file name|'."\n" + .'|hdfs.kerberos.switch | Yes | String type: TRUE or FALSE. Indicates whether HDFS has Kerberos authentication enabled.|'."\n" + .'|hdfs.kerberos.keytab.file | Required when Kerberos is enabled | HDFS principal authentication file ID. The file must be uploaded through the Dataphin file system.|'."\n" + .'|hdfs.kerberos.keytab.filename | Required when Kerberos is enabled | HDFS principal authentication file name|'."\n" + .'|hdfs.kerberos.principal | Required when Kerberos is enabled | HDFS principal name, for example, xxx/master@DATAPHIN.COM|'."\n" + .'|hdfs.defaultFs | Yes | defaultFs address, for example, namenode:8020|'."\n" + ."\n\n" + ."\n" + .'### LOG_HUB'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|endPoint | Yes | |'."\n" + .'|accessId | Yes | |'."\n" + .'|accessKey | Yes | |'."\n" + .'|projectName | Yes | |'."\n" + ."\n\n" + ."\n" + .'### POLARDB'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|jdbc.url | Yes | |'."\n" + .'|jdbc.username | Yes | |'."\n" + .'|jdbc.password | Yes | |'."\n" + .'|jdbc.database.schema | Yes | |'."\n" + .'|deploy.type | Yes | Deployment type: PUBLIC (public network), RDS (Alibaba Cloud), ECS (self-managed);|'."\n" + .'|For cloud databases, reverse VPC network connectivity must be established. Select the deployment type based on the actual deployment mode. Use PUBLIC for other scenarios.|'."\n" + .'|access.type | Yes | Access method: PUBLIC or VPC. For public cloud environments, reverse VPC connectivity must be established to use VPC. Use PUBLIC for other scenarios.|'."\n" + .'|vpc.id | No | Required in VPC environments|'."\n" + .'|vpc.region.id | No | Required in VPC environments|'."\n" + .'|vpc.instance.id | No | Required in VPC environments|'."\n" + .'|backend.db.type | Yes | Backend database type: MYSQL or POSTGRE_SQL|'."\n" + ."\n\n" + ."\n" + .'### HBASE_0_9_4/HBASE_1_1_X'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|hadoop.kdc.address | No | Not required if .krb5.config.file is provided|'."\n" + .'|hadoop.kerberos.krb5.config.file | No | Not required if hadoop.kdc.address is provided|'."\n" + .'|hbase.kerberos.switch | Yes | String type: TRUE or FALSE. Indicates whether HDFS has Kerberos authentication enabled.|'."\n" + .'|hbase.kerberos.keytab.file | No | HDFS principal authentication file ID. The file must be uploaded through the Dataphin file system.|'."\n" + .'|hbase.kerberos.principal | No | HDFS principal authentication file name|'."\n" + .'|hbase.cluster | Yes | HBase cluster connection string. ZooKeeper is supported.|'."\n" + .'|hbase.connection.param | No | Connection parameters|'."\n" + ."\n\n" + ."\n" + .'### DRDS/POSTGRE_SQL/ORACLE/VERTICA/DRDS/ANALYTICDB/ADB_FOR_MYSQL_V3'."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|jdbc.url | Yes | |'."\n" + .'|jdbc.username | Yes | |'."\n" + .'|jdbc.password | Yes | |'."\n" + .'|jdbc.database.schema | No | If a schema exists, this parameter should be specified, or add the schema parameter to the URL. Otherwise, the metadata service may return an error.|'."\n" + .'|deploy.type | Yes | Deployment type: PUBLIC (public network), RDS (Alibaba Cloud), ECS (self-managed);|'."\n" + .'|For cloud databases, reverse VPC network connectivity must be established. Select the deployment type based on the actual deployment mode. Use PUBLIC for other scenarios.|'."\n" + .'|access.type | Yes | Access method: PUBLIC or VPC. For public cloud environments, reverse VPC connectivity must be established to use VPC. Use PUBLIC for other scenarios.|'."\n" + .'|vpc.id | Yes | Required in VPC environments|'."\n" + .'|vpc.region.id | Yes | Required in VPC environments|'."\n" + .'|vpc.instance.id | Yes | Required in VPC environments|'."\n" + ."\n" + .'### HIVE'."\n" + ."\n" + .'| key | Required | Description |'."\n" + .'|:---------------------------------|:-----|:-------------------------------------------------------------------|'."\n" + .'| hive.version | Yes | Hive version, such as CDH5_HIVE_1_1_0, CDH6_HIVE_2_1_1, CDP7_HIVE_3_1_300, etc. |'."\n" + .'| hadoop.namenode | Yes | NameNode. Supports host and IP. Example: host=192.168.1.1,webUiPort=50070,ipcPort=8020 |'."\n" + .'| hadoop.kerberos.switch | Yes | Whether the Hadoop cluster has Kerberos authentication enabled |'."\n" + .'| kerberos.config | Yes | Kerberos configuration mode: kdc or krb |'."\n" + .'| hadoop.kdc.address | No | Kerberos Server address. Not required if .krb5.config.file is provided. |'."\n" + .'| hadoop.kerberos.krb5.config.file | No | Not required if hadoop.kdc.address is provided |'."\n" + .'| hive.kerberos.switch | Yes | String type: TRUE or FALSE. Indicates whether Hive has Kerberos authentication enabled. |'."\n" + .'| hive.kerberos.keytab.file | No | Hive principal authentication file ID. The file must be uploaded through the Dataphin file system. |'."\n" + .'| hive.kerberos.keytab.filename | No | Hive principal authentication file name |'."\n" + .'| hive.kerberos.principal | No | hive principal |'."\n" + .'| hive.jdbc.url | Yes | Hive connection string. ZooKeeper-based connections are not supported (< v2.9.2). |'."\n" + .'| hive.jdbc.username | No | Not required if Kerberos authentication is used |'."\n" + .'| hive.jdbc.password | No | Not required if Kerberos authentication is used |'."\n" + .'| meta.type | Yes | Metadata type. Valid values: DB and HMS. |'."\n" + .'| hive.meta.db.type | No | Required when meta.type is DB. Hive Metastore database type: MYSQL or POSTGRE_SQL. |'."\n" + .'| hive.meta.jdbc.url | No | Metastore database connection information |'."\n" + .'| hive.meta.jdbc.username | No | Metastore database connection information |'."\n" + .'| hive.meta.jdbc.password | No | Metastore database connection information |'."\n" + .'| hms.kerberos.keytab.file | No | HMS connection information |'."\n" + .'| hms.kerberos.keytab.filename | No | HMS connection information |'."\n" + .'| hms.kerberos.principal | No | HMS connection information |'."\n" + .'| hms.hive.site.file | No | HMS connection information |'."\n" + .'| hms.hive.site.filename | No | HMS connection information |'."\n" + .'| hdfs.kerberos.switch | Yes | String type: TRUE or FALSE. Indicates whether HDFS has Kerberos authentication enabled. |'."\n" + .'| hdfs.kerberos.keytab.file | No | HDFS principal authentication file ID. The file must be uploaded through the Dataphin file system. |'."\n" + .'| hdfs.kerberos.keytab.filename | No | HDFS principal authentication file name |'."\n" + .'| hdfs.kerberos.principal | No | HDFS principal name, for example, xxx/master@DATAPHIN.COM |'."\n" + ."\n\n" + ."\n" + .'### FTP'."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|ftp.protocol | Yes | |'."\n" + .'|ftp.host | Yes | |'."\n" + .'|ftp.port | Yes | |'."\n" + .'|ftp.username | Yes | |'."\n" + .'|ftp.password | Yes | |'."\n" + ."\n\n" + ."\n\n" + .'### ELASTIC_SEARCH'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|url | Yes | |'."\n" + .'|username | Yes | |'."\n" + .'|password | Yes | |'."\n" + ."\n\n" + ."\n" + .'### MONGODB'."\n" + ."\n" + .'|key | Required | Description|'."\n" + .'|:----------------------|:--------|:-------|'."\n" + .'|mongodb.jdbc.url | Yes | |'."\n" + .'|mongodb.jdbc.username | Yes | |'."\n" + .'|mongodb.jdbc.password | Yes | |'."\n" + ."\n" + .'### SQLSERVER'."\n" + ."\n" + .'| key | Required | Description|'."\n" + .'|:--------------------|:--------|:-------|'."\n" + .'| jdbc.url | Yes | |'."\n" + .'| jdbc.username | Yes | |'."\n" + .'| jdbc.password | Yes | |'."\n" + .'|deploy.type | Yes | Deployment type: PUBLIC (public network), RDS (Alibaba Cloud), ECS (self-managed);|'."\n" + .'|For cloud databases, reverse VPC network connectivity must be established. Select the deployment type based on the actual deployment mode. Use PUBLIC for other scenarios.|'."\n" + .'|access.type | Yes | Access method: PUBLIC or VPC. For public cloud environments, reverse VPC connectivity must be established to use VPC. Use PUBLIC for other scenarios.|'."\n" + .'|vpc.id | No | Required in VPC environments|'."\n" + .'|vpc.region.id | No | Required in VPC environments|'."\n" + .'|vpc.instance.id | No | Required in VPC environments|'."\n" + ."\n" + .'### DB2'."\n" + ."\n" + .'| key | Required | Description|'."\n" + .'|:--------------------|:--------|:-------|'."\n" + .'| jdbc.url | Yes | |'."\n" + .'| jdbc.username | Yes | |'."\n" + .'| jdbc.password | Yes | |'."\n" + ."\n" + .'### MYSQL'."\n" + ."\n" + .'| key | Required | Description|'."\n" + .'|:--------------|:--------|:-------|'."\n" + .'| jdbc.url | Yes | |'."\n" + .'| jdbc.username | Yes | |'."\n" + .'| jdbc.password | Yes | |'."\n" + .'|deploy.type | Yes | Deployment type: PUBLIC (public network), RDS (Alibaba Cloud), ECS (self-managed);|'."\n" + .'|For cloud databases, reverse VPC network connectivity must be established. Select the deployment type based on the actual deployment mode. Use PUBLIC for other scenarios.|'."\n" + .'|access.type | Yes | Access method: PUBLIC or VPC. For public cloud environments, reverse VPC connectivity must be established to use VPC. Use PUBLIC for other scenarios.|'."\n" + .'|vpc.id | No | Required in VPC environments|'."\n" + .'|vpc.region.id | No | Required in VPC environments|'."\n" + .'|vpc.instance.id | No | Required in VPC environments|'."\n" + ."\n\n" + .'### OSS'."\n" + ."\n" + .'|key | Required | Description |'."\n" + .'|:----------------------|:-----|:--------------|'."\n" + .'|endpoint | Yes | OSS endpoint |'."\n" + .'|bucket | Yes | oss bucket |'."\n" + .'|CNAME | No | |'."\n" + .'|accessId | Yes | Alibaba Cloud Access ID |'."\n" + .'|accessKey | Yes | Alibaba Cloud Access Key |', + 'changeSet' => [ + ['createdAt' => '2025-04-16T01:56:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDataset' => [ + 'summary' => 'Creates a new dataset under a specified project. Available since v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '7255013756724992'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The creation request.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The dataset type. Valid values: FILE, TABLE, HYBRID.', 'type' => 'string', 'required' => true, 'example' => 'FILE'], + 'StorageType' => ['title' => '', 'description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'OSS'], + 'MetadataStorageType' => ['title' => '', 'description' => 'The metastore type.', 'type' => 'string', 'required' => false, 'example' => 'POSTGRESQL'], + 'ContentType' => ['title' => '', 'description' => 'The dataset content type. Valid values: GENERAL, TEXT, AUDIO, VIDEO, IMAGE, TABLE, INDEX.', 'type' => 'string', 'required' => true, 'example' => 'GENERAL'], + 'DataCellId' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'string', 'required' => false, 'example' => '78201'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '测试数据集'], + 'Owner' => ['title' => '', 'description' => 'The list of owner IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => '7255018404650688'], + 'DirName' => ['title' => '', 'description' => 'The directory (obtained from the file service by using the fileId).', 'type' => 'string', 'required' => true, 'example' => '/'], + 'Scenario' => ['title' => '', 'description' => 'The dataset scenarios. Valid values:'."\n" + .'- OFFLINE: offline. This is the default value.'."\n" + .'- REALTIME: real-time.', 'type' => 'string', 'required' => true, 'example' => 'OFFLINE'], + 'Version' => ['title' => '', 'description' => 'The version number. If not specified, the default version V1 is used.', 'type' => 'string', 'required' => false, 'example' => 'V1'], + 'VersionConfig' => [ + 'description' => 'The version configuration.', + 'type' => 'object', + 'properties' => [ + 'VersionDescription' => ['title' => '', 'description' => 'The version description.', 'type' => 'string', 'required' => false, 'example' => '测试数据集版本'], + 'FileStorageConfig' => [ + 'description' => 'The file storage configuration.', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7445343860022804608'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => '测试数据源'], + 'DevPath' => ['title' => '', 'description' => 'The development path (not required for basic projects).', 'type' => 'string', 'required' => false, 'example' => 'HTML正文提取/test423/'], + 'ProdPath' => ['title' => '', 'description' => 'The production path.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'MountPath' => ['title' => '', 'description' => 'The mount path.', 'type' => 'string', 'required' => true, 'example' => '/var/run/openresty/cache/corp'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'MetadataStorageConfig' => [ + 'description' => 'The metastore configuration.', + 'type' => 'object', + 'properties' => [ + 'MetadataStorageMode' => ['title' => '', 'description' => 'The metadata storage mode. Valid values:'."\n" + .'- CREATE: create a new table.'."\n" + .'- EXISTING: use an existing table.', 'type' => 'string', 'required' => true, 'example' => 'CREATE'], + 'MetadataStorageType' => ['title' => '', 'description' => 'The metastore type.', 'type' => 'string', 'required' => false, 'example' => 'MILVUS'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7429133693081710272'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => '测试数据源'], + 'DevSchema' => ['title' => '', 'description' => 'The development database/schema.', 'type' => 'string', 'required' => false, 'example' => 'HTML正文提取/test423/'], + 'ProdSchema' => ['title' => '', 'description' => 'The production database/schema.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 's_crm_all_plt_jala_shop'], + 'TableSchema' => [ + 'description' => 'The table schema.', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The column list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The column structure.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'id'], + 'Type' => ['title' => '', 'description' => 'The field type.', 'type' => 'string', 'required' => true, 'example' => 'int8'], + 'ElementType' => ['title' => '', 'description' => 'The array element subtype. Valid only when type is set to ARRAY.', 'type' => 'string', 'required' => false, 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => 'The maximum capacity of the array. Valid only when type is set to ARRAY. Default value: 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '35'], + 'Pk' => ['title' => '', 'description' => 'Specifies whether the field is a primary key.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Comment' => ['title' => '', 'description' => 'The field comment.', 'type' => 'string', 'required' => false, 'example' => 'primary key'], + 'Url' => ['title' => '', 'description' => 'Specifies whether the field is a URL.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'MultiModal-Embedding'], + 'Dimension' => ['title' => '', 'description' => 'The vector dimensions.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance:mongodb'], + 'IndexType' => ['title' => '', 'description' => 'The index type. PostgreSQL supports IVFFlat and HNSW. Milvus supports all types.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type. Default value: COSINE. Valid values: COSINE, L2, IP.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters. Different parameters are required based on the indexType. For example, HNSW requires {M:30, efConstruction:360} and IVF_FLAT requires {nlist:128}.', 'type' => 'object', 'required' => false, 'example' => '{M:30, efConstruction:360}'], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RealtimeMetaTableConfig' => [ + 'title' => '', + 'description' => 'The real-time meta table configuration. Takes effect when metadataStorageType is set to STREAM_TABLE.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID of the meta table (cross-project supported).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7256391656294144'], + 'MetaTableName' => ['title' => '', 'description' => 'The meta table name.', 'type' => 'string', 'required' => true, 'example' => '测试元表'], + 'DatasourceType' => ['title' => '', 'description' => 'The meta table data source type (only KAFKA is supported in this version).', 'type' => 'string', 'required' => true, 'example' => 'KAFKA'], + 'TableSchema' => [ + 'description' => 'The table schema.', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The column list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The column structure.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'happen_time'], + 'Type' => ['title' => '', 'description' => 'The field type.', 'type' => 'string', 'required' => true, 'example' => 'date'], + 'ElementType' => ['title' => '', 'description' => 'The array element subtype. Valid only when type is set to ARRAY.', 'type' => 'string', 'required' => false, 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => 'The maximum capacity of the array. Valid only when type is set to ARRAY. Default value: 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '35'], + 'Pk' => ['title' => '', 'description' => 'Specifies whether the field is a primary key.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Comment' => ['title' => '', 'description' => 'The field comment.', 'type' => 'string', 'required' => false, 'example' => 'happen time'], + 'Url' => ['title' => '', 'description' => 'Specifies whether the field is a URL.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration. Configure this when the field type is FLOAT_VECTOR/FLOAT16_VECTOR/BFLOAT16_VECTOR to set the dimension, index type, and similarity.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'MultiModal-Embedding'], + 'Dimension' => ['title' => '', 'description' => 'The vector dimensions.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance:MySQL.monitor'], + 'IndexType' => ['title' => '', 'description' => 'The index type. PostgreSQL supports IVFFlat and HNSW. Milvus supports all types.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type. Default value: COSINE. Valid values: COSINE, L2, IP.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters. Different parameters are required based on the indexType. For example, HNSW requires {M:30, efConstruction:360} and IVF_FLAT requires {nlist:128}.', 'type' => 'object', 'required' => false, 'example' => '{M:30, efConstruction:360}'], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '12356', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The dataset object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ComputeSourceInfo' => [ - 'title' => '计算源详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '计算源Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '101101', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10101101', - ], - 'BindProject' => [ - 'title' => '是否绑定项目', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Type' => [ - 'title' => '计算源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'DatasetId' => ['title' => '', 'description' => 'The dataset ID (business primary key).', 'type' => 'string', 'example' => '7280832407583104'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create dataset', + 'description' => '## Operation description'."\n" + .'- This API creates a new dataset in a specified project.'."\n" + .'- `ProjectId` is a required parameter that specifies the ID of the project in which to create the dataset.'."\n" + .'- `CreateCommand` is a complex object that contains the configuration information required to create the dataset.'."\n" + .'- `Name`, `Type`, `ContentType`, and `Scenario` are required fields that specify the dataset name, type, content type, and scenarios respectively.'."\n" + .'- `FileStorageConfig` and `MetadataStorageConfig` in `VersionConfig` can be configured as needed.'."\n" + .'- If you need a real-time meta table configuration, provide the `RealtimeMetaTableConfig` information.'."\n" + .'- Ensure that all required fields are correctly specified. Otherwise, the request failed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"DatasetId\\": \\"7280832407583104\\"\\n}","type":"json"}]', ], - 'DeleteComputeSource' => [ - 'summary' => '删除计算源。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDirectory' => [ + 'summary' => 'Creates a menu tree directory. This operation supports features such as compute nodes, data integration, and synchronization tasks.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -5109,107 +3782,101 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The create request.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1212344'], + 'Category' => ['title' => '', 'description' => 'The menu tree category. Valid values:'."\n" + .'- tempCode: custom query'."\n" + .'- codeManage: code node'."\n" + .'- offlinePipeline: offline pipeline'."\n" + .'- offlinePipelineCustomPlugin: pipeline custom component'."\n" + .'- dataX: synchronization task'."\n" + .'- streamMeta: real-time meta table'."\n" + .'- streamCustomDataSource: real-time custom source'."\n" + .'- streamTemplate: real-time compute template'."\n" + .'- resourceManage: resource management'."\n" + .'- udfResource: offline function'."\n" + .'- streamFunction: real-time function.', 'type' => 'string', 'required' => true, 'example' => 'tempCode'], + 'Name' => ['title' => '', 'description' => 'The name of the new file directory.', 'type' => 'string', 'required' => true, 'example' => 'test_xx'], + 'Directory' => ['title' => '', 'description' => 'The parent directory of the new file directory.', 'type' => 'string', 'required' => true, 'example' => '/'], + ], 'required' => true, - 'example' => '12356', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1311113211'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Create a menu tree directory', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateComputeSource' => [ - 'summary' => '创建计算源。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'CreateNodeSupplement' => [ + 'summary' => 'General-purpose backfill API that supports both list-mode and bulk-mode backfill:'."\n" + .'1. Backfill instances will be generated and executed, affecting the data output of related tables.'."\n" + .'2. Task execution will incur computing costs and storage costs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5217,319 +3884,419 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建命令', - 'description' => '', + 'title' => '', + 'description' => 'Create backfill request', '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', + 'NodeIdList' => [ + 'title' => '', + 'description' => 'Root nodes for backfill. Multiple root nodes are supported.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Root node', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Node ID', 'type' => 'string', 'required' => true, 'example' => 'n_1232324'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'Field ID list: Can be specified when the node is a logical table node ID. If not specified, the entire table is used by default.', + 'type' => 'array', + 'items' => ['description' => 'Field ID', 'type' => 'string', 'required' => false, 'example' => '1201', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], 'required' => true, - 'example' => 'MacCompute', + 'example' => '', ], - 'ConfigList' => [ - 'title' => '连接配置项', - 'description' => '', + 'StartBizDate' => ['title' => '', 'description' => 'Start business date', 'type' => 'string', 'required' => true, 'example' => '2024-05-21'], + 'EndBizDate' => ['title' => '', 'description' => 'End business date', 'type' => 'string', 'required' => true, 'example' => '2024-05-21'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101121'], + 'Name' => ['title' => '', 'description' => 'Backfill name. If not specified, a name is automatically generated by the system.', 'type' => 'string', 'example' => 'xx测试', 'required' => false], + 'DownStreamNodeIdList' => [ + 'title' => '', + 'description' => 'Downstream node IDs. Specifies downstream nodes for execution.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => 'Node ID', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '配置项值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], - 'Key' => [ - 'title' => '配置项', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', + 'Id' => ['title' => '', 'description' => 'Node ID', 'type' => 'string', 'required' => false, 'example' => '2323232'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'Field ID', + 'type' => 'array', + 'items' => ['description' => 'Field ID', 'type' => 'string', 'required' => false, 'example' => '232322211', 'title' => ''], + 'required' => false, + 'example' => '', ], ], 'required' => false, + 'example' => 'n_23243', ], - 'required' => true, + 'required' => false, + 'example' => '', + ], + 'ContainAllDownStream' => ['title' => '', 'description' => 'Bulk mode: Include all downstream nodes. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'FilterList' => [ + 'title' => '', + 'description' => 'Filter list: Used together with ContainAllDownStream. You can include or exclude items based on project, node, and other criteria. Default value: empty.', + 'type' => 'array', + 'items' => [ + 'description' => 'Filter', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Filter key. Valid values:'."\n" + .'- PROJECT: project'."\n" + .'- NODE_OUTPUT_NAME: node output name'."\n" + .'- NODE_NAME: node name'."\n" + .'- NODE_ID: node ID'."\n" + .'- TARGETS: specified endpoints'."\n" + .'- SOURCES: specified start points', 'type' => 'string', 'required' => false, 'example' => 'NODE_OUTPUT_NAME', 'title' => ''], + 'ValueList' => [ + 'description' => 'Filter value list', + 'type' => 'array', + 'items' => ['description' => 'Filter value', 'type' => 'string', 'required' => false, 'example' => 'xxtest', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Exclude' => ['description' => 'Specifies whether to exclude the matched items. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Parallelism' => ['title' => '', 'description' => 'Concurrency. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'MinDueTime' => ['title' => '', 'description' => 'Earliest trigger time (HH:MM). This parameter applies only to hourly tasks.', 'type' => 'string', 'required' => false, 'example' => '00:00'], + 'MaxDueTime' => ['title' => '', 'description' => 'Latest trigger time (HH:MM). This parameter applies only to hourly tasks.', 'type' => 'string', 'required' => false, 'example' => '20:59'], + 'GlobalParamList' => [ + 'title' => '', + 'description' => 'Runtime global parameters', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Parameter key', 'type' => 'string', 'required' => false, 'example' => 'param1', 'title' => ''], + 'Value' => ['description' => 'Parameter value', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'NodeParamsList' => [ + 'title' => '', + 'description' => 'Runtime custom parameters, configured per node', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['description' => 'Node ID', 'type' => 'string', 'required' => false, 'example' => 'n_23324', 'title' => ''], + 'ParamList' => [ + 'description' => 'Parameter list', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Parameter key', 'type' => 'string', 'required' => false, 'example' => 'param1', 'title' => ''], + 'Value' => ['description' => 'Parameter value', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Environment identifier.'."\n" + .'- DEV: development environment.'."\n" + .'- PROD (default): production environment.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'PROD', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Response result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '创建结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '计算源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12356', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true/false'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'SubmitId' => ['title' => '', 'description' => '- Standard mode: the FlowId is returned.'."\n" + .'- Bulk mode: the submitted JobId is returned. You can call GetOperationSubmitStatus to query the task submission status. After the submission succeeds, the FlowId is returned.', 'type' => 'string', 'example' => 'f_2264518792396800000_20210223_2329354897145659392'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'General backfill API', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetSparkLocalClientInfo' => [ - 'summary' => '获取计算源对应集群的spark客户信息', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateNodeSupplement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreatePipeline' => [ + 'summary' => 'Create an integration pipeline/unstructured workflow task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '项目ID', - 'type' => 'string', + 'title' => '', + 'description' => 'Request context information', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'Project ID to which the integration pipeline/workflow task belongs', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'Current operating environment: DEV indicates the development environment, PROD indicates the production environment (for workflows, only PROD is currently supported)', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'EnvEnum', - 'in' => 'query', + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '环境标识：'."\n" - .'DEV：开发环境'."\n" - .'PROD：生产环境', - 'type' => 'string', + 'title' => '', + 'description' => 'Pipeline/workflow task creation configuration', + 'type' => 'object', + 'properties' => [ + 'ScheduleConfig' => ['title' => '', 'description' => 'Scheduling configuration in JSON string format. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString method', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}'], + 'Comment' => ['title' => '', 'description' => 'Comment', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'PipelineConfig' => [ + 'title' => '', + 'description' => 'Integration pipeline component/workflow operator configuration', + 'type' => 'object', + 'properties' => [ + 'Steps' => [ + 'title' => '', + 'description' => 'Component/operator configuration: contains detailed configuration of all components/operators used', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Specific component/operator configuration', + 'type' => 'object', + 'properties' => [ + 'PluginConfig' => ['title' => '', 'description' => 'Specific component configuration in JSON string format. Refer to the utility class: subclasses of com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig (for workflow operators, use com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.unstructured.BaseOAUnstructuredNeuronConfig) and their toJsonString method. Developers should inherit this component/operator configuration class and implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as the task configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => '{}'], + 'StepType' => ['title' => '', 'description' => 'Component type: input indicates an input component, output indicates an output component, transfrom indicates a transform component, process indicates a flow control component. For workflow tasks, this indicates the operator type, such as image for image, text for text. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType. Developers should inherit this component/operator configuration class and implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as the configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => 'input'], + 'StepName' => ['title' => '', 'description' => 'Step name. Step names must be unique within the same pipeline task', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + 'IsDistribute' => ['title' => '', 'description' => 'Indicates the data distribution method when the current component has multiple downstream components:'."\n" + .'true indicates that data from the current component is sent to all downstream components in a round-robin manner. For example, if the current component has 100 records and two downstream components, each downstream component receives 50 records. The default value is true.'."\n" + .'false indicates that data from the current component is sent in full to all downstream components. For example, if the current component has 100 records and two downstream components, both downstream components receive all 100 records.'."\n" + .'For workflow tasks, this value can be ignored.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Key' => ['title' => '', 'description' => 'Plugin/operator ID. Each plugin/operator has a unique identifier. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey. Developers should inherit this component/operator configuration class and implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as the configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'Hops' => [ + 'title' => '', + 'description' => 'DAG (directed acyclic graph) link configuration: describes the connections between all components/operators', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Integration pipeline input/output component/workflow operator dependency relationship configuration', + 'type' => 'object', + 'properties' => [ + 'Target' => ['title' => '', 'description' => 'Output step name, i.e., Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer'], + 'SendTo' => ['title' => '', 'description' => 'For conditional distribution components, set to true when the downstream condition is true, otherwise set to false.'."\n" + .'For workflow tasks, this can be ignored.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Source' => ['title' => '', 'description' => 'Input step name, i.e., Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'Integration pipeline/workflow task basic information', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '', 'description' => 'Integration pipeline/workflow task name', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'NodeId' => ['title' => '', 'description' => 'Scheduling node ID of the pipeline/workflow task. Leave empty for initial creation. When updating a pipeline/workflow task, at least one of pipelineId, fileId, or nodeId must be specified', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'Pipeline/workflow task ID. Leave empty for initial creation. When updating a pipeline/workflow task, at least one of pipelineId, fileId, or nodeId must be specified', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'Pipeline/workflow file ID. Leave empty for initial creation. When updating a pipeline/workflow task, at least one of pipelineId, fileId, or nodeId must be specified', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'Directory' => ['title' => '', 'description' => 'Directory of the integration pipeline/workflow task node (defaults to root directory). The directory must exist. If it does not exist, call the relevant API to create a directory of type offlinePipeline (or unstructuredPipeline for workflows)', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + 'required' => true, + 'example' => '', + ], + 'PipelineType' => ['title' => '', 'description' => 'Task type: 0 indicates offline integration (default), 1 indicates real-time integration, 14 indicates a workflow task', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Mode' => ['title' => '', 'description' => 'Integration pipeline configuration mode: PIPELINE indicates pipeline mode (default), JSON indicates script mode.'."\n" + .'For workflows, this can be ignored.', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE'], + 'Submit' => ['title' => '', 'description' => 'Whether to submit. Submitted by default', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'PipelineJson' => ['title' => '', 'description' => 'In script mode: integration pipeline configuration (in JSON string format).'."\n" + .'Workflow tasks do not support script mode', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Settings' => ['title' => '', 'description' => 'Channel configuration in JSON string format. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString method', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Backend response exception details', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], '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' => '', - 'type' => 'string', - 'example' => 'XXXX-XXXX-XXXX-XXXX', - ], - 'Editable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true/false', - ], - ], + 'title' => '', + 'description' => 'Integration pipeline/workflow task creation result', + 'type' => 'object', + 'properties' => [ + 'SubmitId' => ['title' => '', 'description' => 'Submit ID of the pending release list generated after successfully submitting the pipeline, used for release through the release domain.'."\n" + .'Workflow tasks only support PROD, so this value is not applicable.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'HostMachine' => ['title' => '', 'description' => 'Server-side execution machine name and IP', 'type' => 'string', 'example' => 'hostName:hostIp'], + 'Version' => ['title' => '', 'description' => 'Pending release version number generated after pipeline submission.'."\n" + .'Workflow tasks only support PROD, so this value is not applicable.', 'type' => 'string', 'example' => '1'], + 'NodeId' => ['title' => '', 'description' => 'Scheduling node ID of the pipeline/workflow task after successful creation', 'type' => 'string', 'example' => '123'], + 'PipelineId' => ['title' => '', 'description' => 'Pipeline/workflow ID after successful creation', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Create an integration pipeline/unstructured workflow task', + 'extraInfo' => 'For usage details, refer to the demo in the utility toolkit: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'SyncDepartment' => [ - 'summary' => '同步部门信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreatePipelineByAsync' => [ + 'summary' => 'Asynchronously create a pipeline/unstructured workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -5537,150 +4304,154 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Request context information', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'Project ID to which the integration pipeline/workflow task belongs', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'Current operating environment env: DEV - indicates the development environment, PROD - indicates the production environment (for workflows, only PROD is currently supported)', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', ], ], [ - 'name' => 'SyncDepartmentCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'Create pipeline/workflow task configuration', 'type' => 'object', 'properties' => [ - 'DepartmentList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DepartmentId' => [ - 'title' => '部门ID（部门唯一标识）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10001', - ], - 'DepartmentName' => [ - 'title' => '部门展示名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '研发中心', - ], - 'ParentDepartmentId' => [ - 'title' => '父部门ID（部门唯一标识，如无则为null）', - 'description' => '', - 'type' => 'string', + 'ScheduleConfig' => ['title' => '', 'description' => 'Scheduling configuration in JSON string format. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString method', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}'], + 'Comment' => ['title' => '', 'description' => 'Comment', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'PipelineConfig' => [ + 'title' => '', + 'description' => 'Integration pipeline component/workflow operator configuration', + 'type' => 'object', + 'properties' => [ + 'Steps' => [ + 'title' => '', + 'description' => 'Component/operator configuration: contains detailed configurations of all components/operators used', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Specific component/operator configuration', + 'type' => 'object', + 'properties' => [ + 'PluginConfig' => ['title' => '', 'description' => 'Specific component configuration in JSON string format. Refer to the utility class: subclasses of com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig (for workflow operators, use com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.unstructured.BaseOAUnstructuredNeuronConfig) and their toJsonString methods. Developers should extend the component/operator configuration class to implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as a task configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => '{}'], + 'StepType' => ['title' => '', 'description' => 'Component type: input - indicates an input component, output - indicates an output component, transform - indicates a transform component, process - indicates a flow control component. For workflow tasks, it indicates the operator type, for example: image - image, text - text. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType. Developers should extend the component/operator configuration class to implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as a configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => 'input'], + 'StepName' => ['title' => '', 'description' => 'Step name. Step names must be unique within the same pipeline task', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + 'IsDistribute' => ['title' => '', 'description' => 'Indicates the data distribution method when the current component has multiple downstream components: true - indicates that the data of the current component is sent to all downstream components in a round-robin manner. For example, if the current component has 100 records and two downstream components, each downstream component receives 50 records. The default value is true. false - indicates that the data of the current component is sent in full to all downstream components. For example, if the current component has 100 records and two downstream components, both downstream components receive 100 records. This value is not applicable to workflow tasks.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Key' => ['title' => '', 'description' => 'Plugin ID. Each plugin/operator has a unique identifier. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey. Developers should extend the component/operator configuration class to implement the corresponding component/operator configuration. Each component/operator configuration has the same structure as a configuration created on the Dataphin page', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'Hops' => [ + 'title' => '', + 'description' => 'DAG (Directed Acyclic Graph) link configuration: describes the connection relationships of all components', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Integration pipeline input/output component relationship configuration', + 'type' => 'object', + 'properties' => [ + 'Target' => ['title' => '', 'description' => 'Output step name, i.e., Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'odps_writer'], + 'SendTo' => ['title' => '', 'description' => 'For conditional distribution components, set to true when the downstream connection condition is true, otherwise set to false. This is not applicable to workflow tasks.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Source' => ['title' => '', 'description' => 'Input step name, i.e., Steps[*].StepName', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + ], 'required' => false, - 'example' => '10001', + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'required' => true, ], 'required' => true, + 'example' => '', + ], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'Integration pipeline task basic information', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '', 'description' => 'Integration pipeline task name', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'NodeId' => ['title' => '', 'description' => 'Pipeline task scheduling node ID. Leave empty for the first creation. When updating a pipeline task, at least one of pipelineId, fileId, or nodeId must be configured', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'Pipeline task ID. Leave empty for the first creation. When updating a pipeline task, at least one of pipelineId, fileId, or nodeId must be configured', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'Pipeline file ID. Leave empty for the first creation. When updating a pipeline task, at least one of pipelineId, fileId, or nodeId must be configured', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'Directory' => ['title' => '', 'description' => 'Integration pipeline task node directory (defaults to the root directory). The directory must exist. If it does not exist, call the relevant API to create a directory of type offlinePipeline', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + 'required' => true, + 'example' => '', ], + 'PipelineType' => ['title' => '', 'description' => 'Task type: 0 - indicates offline integration (default), 1 - indicates real-time integration, 14 - indicates a workflow task', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Mode' => ['title' => '', 'description' => 'Integration pipeline configuration mode: PIPELINE - indicates pipeline mode (default), JSON - indicates script mode. This is not applicable to workflows.', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE'], + 'Submit' => ['title' => '', 'description' => 'Whether to submit. The default is to submit', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'PipelineJson' => ['title' => '', 'description' => 'In script mode: integration pipeline configuration (in JSON string format). Workflow tasks do not support script mode', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Settings' => ['title' => '', 'description' => 'Channel configuration in JSON string format. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString method', 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Backend response exception details', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'Asynchronous execution query ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Asynchronously Create Pipeline/Unstructured Workflow', + 'extraInfo' => 'For usage details, refer to the demo in the utility toolkit: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'SyncDepartmentUser' => [ - 'summary' => '同步部门成员信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreatePipelineNode' => [ + 'summary' => 'Creates a data integration task. Note: This operation is deprecated starting from Dataphin v5.3.1. Use CreatePipeline instead.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5688,692 +4459,709 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SyncDepartmentUserCommand', + 'name' => 'CreatePipelineNodeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The command to create a pipeline. Both offline and real-time pipelines are supported.', 'type' => 'object', 'properties' => [ - 'DeptUserMapping' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceUserId' => [ - 'title' => '用户系统的用户ID（用户唯一标识）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30000001', - ], - 'DepartmentIdList' => [ - 'title' => '用户归属部门ID列表（为空则为删除用户归属关系）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEPT_1', - ], - 'required' => false, - ], - ], - 'required' => true, + 'PipelineName' => ['title' => '', 'description' => 'The pipeline name.', 'type' => 'string', 'required' => true, 'example' => 'test_pipeline'], + 'PipelineType' => [ + 'title' => '', + 'description' => 'The pipeline type. Valid values: OFFLINE_PIPELINE and REAL_TIME_PIPELINE.', + 'type' => 'string', + 'required' => true, + 'example' => 'REAL_TIME_PIPELINE', + 'enum' => ['OFFLINE_PIPELINE', 'REAL_TIME_PIPELINE'], + ], + 'NodeType' => [ + 'title' => '', + 'description' => 'The node type. Valid values: NORMAL, MANUAL, and REAL_TIME.', + 'type' => 'string', + 'required' => true, + 'example' => 'REAL_TIME', + 'enum' => ['NORMAL', 'MANUAL', 'REAL_TIME'], + ], + 'FileInfo' => [ + 'title' => '', + 'description' => 'The task file information.', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'test_pipeline'], + 'Directory' => ['title' => '', 'description' => 'The full path of the parent directory of the file. If this parameter is left empty, the root path (/) is used.', 'type' => 'string', 'required' => false, 'example' => 'test', 'default' => '/'], + 'Description' => ['title' => '', 'description' => 'The file description.', 'type' => 'string', 'example' => 'desc', 'required' => false], ], 'required' => true, + 'example' => '', ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7091124176569088'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The pipeline node information.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['title' => '', 'description' => 'The ID of the pipeline created.', 'type' => 'integer', 'format' => 'int64', 'example' => '33749'], + 'ErrorCodeList' => [ + 'title' => '', + 'description' => 'The error codes.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The error codes.', 'type' => 'string', 'example' => 'DPN.Pipeline.Config.ErrorReason'], + 'example' => '', + ], + 'ErrorMessageList' => [ + 'title' => '', + 'description' => 'The error messages.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '管道配置错误：{0}'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Create a data integration pipeline task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'TransferOwnershipForAllObject' => [ - 'summary' => '一键转交负责人', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreatePipelineNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateResource' => [ + 'summary' => 'Creates a resource file.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'PrivilegeTransferRecord', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'OldOwner' => [ - 'title' => '转出人用户ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30000001', - ], - 'NewOwner' => [ - 'title' => '接收人用户ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30000002', - ], - 'TransferComment' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], + 'Name' => ['title' => '', 'description' => 'The resource name.', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + 'Directory' => ['title' => '', 'description' => 'The folder in which the resource file is stored.', 'type' => 'string', 'required' => true, 'example' => '/'], + 'ResourceType' => ['title' => '', 'description' => 'The type of the resource file. Valid values:'."\n" + .'- FILE: common file.'."\n" + .'- JAR: JAR file.'."\n" + .'- PYTHON: Python file.'."\n" + .'- OTHERS: other type of file.', 'type' => 'string', 'required' => true, 'example' => 'JAR'], + 'StorageAddress' => ['title' => '', 'description' => 'The storage address of the resource file.', 'type' => 'string', 'required' => true, 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c'], + 'Description' => ['title' => '', 'description' => 'The description of the resource file.', 'type' => 'string', 'required' => true, 'example' => 'xx 测试'], + 'Comment' => ['title' => '', 'description' => 'The commit remarks.', 'type' => 'string', 'required' => true, 'example' => 'xx 测试'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine type. Valid values:'."\n" + .'- MAX_COMPUTE'."\n" + .'- HADOOP'."\n" + .'- NONE.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '转交记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The ID of the resource file.', 'type' => 'integer', 'format' => 'int64', 'example' => '10112101'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 10112101\\n}","type":"json"}]', + 'title' => 'Create a resource file', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'RetryTransferOwnership' => [ - 'summary' => '重新转交运行失败的转交任务', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateRowPermission' => [ + 'summary' => 'Creates a row-level permission.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'PrivilegeTransferRecord', + 'name' => 'CreateRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Request command.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '转出任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'NewOwner' => [ - 'title' => '接收人用户ID', - 'description' => '', - 'type' => 'string', + 'RowPermissionName' => ['title' => '', 'description' => 'The name of the row-level permission.', 'type' => 'string', 'required' => true, 'example' => '业务管控'], + 'RowPermissionDesc' => ['title' => '', 'description' => 'The description of the row-level permission.', 'type' => 'string', 'required' => false, 'example' => '管控业务数据'], + 'MappingColumns' => [ + 'title' => '', + 'description' => 'The mapping columns.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['title' => '', 'description' => 'The name of the mapping column.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + 'ColumnType' => [ + 'title' => '', + 'description' => 'The type of the mapping column.', + 'type' => 'string', + 'required' => true, + 'enum' => ['STRING', 'NUMBER'], + 'example' => 'STRING', + ], + 'ColumnDesc' => ['title' => '', 'description' => 'The description of the mapping column.', 'type' => 'string', 'required' => false, 'example' => '控制业务ID字段'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '30000001', - ], - 'TransferComment' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'comment', + 'example' => '', + ], + 'Rules' => [ + 'title' => '', + 'description' => 'The rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule object.', + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['title' => '', 'description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'example' => '中台'], + 'ScopeType' => [ + 'title' => '', + 'description' => 'The scope type of the rule.', + 'type' => 'string', + 'required' => true, + 'enum' => ['ALL_COLUMN', 'SELECT_COLUMN'], + 'example' => 'SELECT_COLUMN', + ], + 'IsDelete' => [ + 'title' => '', + 'description' => 'Specifies whether to delete the rule.', + 'type' => 'boolean', + 'required' => false, + 'enum' => ['0', '1'], + 'example' => '1', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the rule.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enum' => ['0', '1'], + 'example' => '1', + ], + 'Expressions' => [ + 'title' => '', + 'description' => 'The rule expressions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping column.', 'type' => 'string', 'required' => true, 'example' => 'id'], + 'Values' => [ + 'title' => '', + 'description' => 'The expression operation values.', + 'type' => 'array', + 'items' => ['description' => 'The expression operation value.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'required' => true, + 'example' => '', + ], + 'Type' => [ + 'title' => '', + 'description' => 'The type of the expression.', + 'type' => 'string', + 'required' => true, + 'enum' => ['EXPRESSION', 'RELATION'], + 'example' => 'RELATION', + ], + 'SubConditions' => [ + 'title' => '', + 'description' => 'The sub-expressions.', + 'type' => 'array', + 'items' => ['description' => 'The sub-expression. The structure is the same as Expressions.', 'type' => 'any', 'required' => true, 'example' => '子表达式，结构同Expressions', 'title' => ''], + 'required' => true, + 'example' => '', + ], + 'Operator' => [ + 'title' => '', + 'description' => 'The operator of the expression.', + 'type' => 'string', + 'required' => true, + 'enum' => ['EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND'], + 'example' => 'EQUAL', + ], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'UserMappingList' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountType' => [ + 'title' => '', + 'description' => 'The type of the account bound to the rule.', + 'enumValueTitles' => ['PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE'], + 'type' => 'string', + 'required' => true, + 'example' => 'PERSONAL', + ], + 'Accounts' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '', 'description' => 'The ID of the account bound to the rule.', 'type' => 'string', 'required' => true, 'example' => '300001111'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => 'PERSONAL', + 'enum' => ['PERSONAL', 'PRODUCE', 'USER_GROUP'], + ], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'The related tables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping column.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + 'ResourceId' => ['title' => '', 'description' => 'The GUID of the table.', 'type' => 'string', 'required' => true, 'example' => 'odps.300199897.project_name.table_name'], + 'ColumnName' => ['title' => '', 'description' => 'The column of the table.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '转交记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code of the request. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message of the request.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'The creation result.', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'CreateRowPermission', + 'description' => 'You can query detailed information about published APIs based on the appKey.', + 'extraInfo' => 'API release version: v5.1.0', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'GetTransferInfo' => [ - 'summary' => '根据转交任务ID查询转交任务的进度', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateSecurityClassify' => [ + 'summary' => 'Creates a data classification. Available since v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The create command.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Abbreviation' => ['title' => '', 'description' => 'The classification abbreviation.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The classification description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ParentPath' => ['title' => '', 'description' => 'The classification path. This parameter is optional. If this parameter is left empty or set to /, the classification is directly placed under the root directory.', 'type' => 'string', 'required' => false, 'example' => '/'], + 'LevelName' => ['title' => '', 'description' => 'The data level name.', 'type' => 'string', 'required' => true, 'example' => 'L2'], + 'FeatureNameList' => [ + 'title' => '', + 'description' => 'The feature names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The feature names.', 'type' => 'string', 'required' => false, 'example' => '行业'], + 'required' => false, + 'example' => '', + ], + 'Priority' => ['title' => '', 'description' => 'The priority. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + 'AdvancedConditionList' => [ + 'title' => '', + 'description' => 'The advanced configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['title' => '', 'description' => 'The parent node of the feature condition.', 'type' => 'string', 'required' => false, 'example' => '123'], + 'Id' => ['title' => '', 'description' => 'The ID of the feature condition node. The ID is randomly generated by the application and must be unique.', 'type' => 'string', 'required' => true, 'example' => '234'], + 'Relation' => ['title' => '', 'description' => 'The condition relation. Valid values:'."\n" + .'- EXPRESSION: expression.'."\n" + .'- RELATION: relation.', 'type' => 'string', 'required' => true, 'example' => 'EXPRESSION'], + 'Property' => ['title' => '', 'description' => 'The feature property. Valid values:'."\n" + .'- TABLE_NAME: table name.'."\n" + .'- TABLE_DESC: table description.'."\n" + .'- FIELD_CONTENT: field content.'."\n" + .'- FIELD_NAME: field name.'."\n" + .'- FIELD_DESC: field description.'."\n" + .'- FIELD_TYPE: field type.', 'type' => 'string', 'required' => false, 'example' => 'TABLE_NAME'], + 'Operate' => ['title' => '', 'description' => 'The condition operation. Valid values:'."\n" + .'- AND'."\n" + .'- OR'."\n" + .'- BUILT_IN_EXPRESSION: built-in expression.'."\n" + .'- IGNORE_CASE_EXPRESSION: regular expression with case-insensitive matching.'."\n" + .'- EXPRESSION: regular expression.'."\n" + .'- NOT_BELONG: does not belong to.'."\n" + .'- CONTAINS: contains.'."\n" + .'- NOT_CONTAINS: does not contain.'."\n" + .'- EQUAL'."\n" + .'- NOT_EQUAL.', 'type' => 'string', 'required' => true, 'example' => 'AND'], + 'ValueList' => [ + 'title' => '', + 'description' => 'The condition values.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The condition values.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'required' => false, + 'example' => '', + ], + 'OptionList' => [ + 'title' => '', + 'description' => 'The additional properties, such as field content.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Status' => ['title' => '', 'description' => 'The classification status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'required' => false, 'example' => 'ENABLE'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The data classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create data classification', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateSecurityClassifyCatalog' => [ + 'summary' => 'Creates a data classification folder. Available since v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'ProposalId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '转交记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The create command.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the classification folder.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'ParentPath' => ['title' => '', 'description' => 'The full path of the parent folder. Default value: /.', 'type' => 'string', 'required' => false, 'example' => '/d1/'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The list of administrator IDs. This parameter takes effect only when the parent folder is the root folder.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of administrator IDs. This parameter takes effect only when the parent folder is the root folder.', 'type' => 'string', 'required' => false, 'example' => '30001011'], + 'required' => false, + 'example' => '', + ], + 'VisibleType' => ['title' => '', 'description' => 'The visibility scope of the classification folder. Valid values:'."\n" + .'- PUBLIC: visible to all users.'."\n" + .'- PRIVATE: visible only to administrators.'."\n" + .'Default value: PUBLIC. This parameter takes effect only when the parent folder is the root folder.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProposalId' => [ - 'title' => '审批单id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FlowId' => [ - 'title' => '审批单flowId', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1753669315426', - ], - 'Title' => [ - 'title' => '审批单title', - 'description' => '', - 'type' => 'string', - 'example' => 'transefer title', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30000001', - ], - 'DisplayName' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'zhangsan', - ], - ], - ], - 'OldOwner' => [ - 'title' => '旧的owner', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30000001', - ], - 'DisplayName' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'zhangsan', - ], - ], - ], - 'NewOwner' => [ - 'title' => '新的owner', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30000001', - ], - 'DisplayName' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'zhangsan', - ], - ], - ], - 'PrivilegeTransferMode' => [ - 'title' => '转交模式：一键转交-ONE_STOP,根据功能模块转交-FUNCTION_MODULE_BASED', - 'description' => '', - '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' => '', - '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The full path of the newly created folder.', 'type' => 'string', 'example' => '/d1/d2/'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"/d1/d2/\\"\\n}","type":"json"}]', + 'title' => 'Create a data classification folder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'AddTenantMembers' => [ - 'summary' => '新增租户成员', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateSecurityIdentifyResult' => [ + 'summary' => 'Creates a security identification result.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -6381,150 +5169,82 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AddCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The create request.', 'type' => 'object', 'properties' => [ - 'UserList' => [ - 'title' => '成员列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '成员对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1323241', - ], - 'RoleList' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '角色列表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SECURITY_ADMIN', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'IsDatasourceTable' => ['title' => '', 'description' => 'Specifies whether the table is a datasource table. Default value: false (treated as a Dataphin table).', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name. This parameter is required only for datasource tables.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'DatasourceEnv' => ['title' => '', 'description' => 'The datasource environment identifier. This parameter is required only for datasource tables.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'TableCatalog' => ['title' => '', 'description' => 'The table catalog. For a datasource table, specify the database or schema name. For a Dataphin physical table, specify the project name in English. For a Dataphin logical table, specify the business unit name in English.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 't_test'], + 'FieldName' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'col1'], + 'ClassifyId' => ['title' => '', 'description' => 'The classification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'Enable' => ['title' => '', 'description' => 'Specifies whether to enable the result. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.'."\n" + .'Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ConflictStrategy' => ['title' => '', 'description' => 'The deduplication strategy. Valid values:'."\n" + .'- COVER_ALL: overwrites all online tags.'."\n" + .'- COVER_UNLOCKED: overwrites only unlocked online tags.', 'type' => 'string', 'required' => true, 'example' => 'COVER_ALL'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '新增租户成员结果', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The identification result ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create a security identification result', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'AddTenantMembersBySourceUser' => [ - 'summary' => '通过原始用户添加租户成员.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateSecurityLevel' => [ + 'summary' => 'Creates a data classification level. Available since v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -6532,171 +5252,73 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AddCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'SourceUserList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SourceId' => [ - 'title' => '用户原始Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2323131', - ], - 'DisplayName' => [ - 'title' => '显示名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - '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, - ], + 'Name' => ['title' => '', 'description' => 'The name of the classification level.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the classification level.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Index' => ['title' => '', 'description' => 'The sort order of the classification level. If this parameter is not specified, the current maximum order ID is used by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Description' => ['title' => '', 'description' => 'The description of the classification level.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '添加结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The ID of the data classification level.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create a data classification level', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateUserGroup' => [ - 'summary' => '新建用户组.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandard' => [ + 'summary' => 'Creates a standard.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -6704,151 +5326,245 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '用户组名称', - 'description' => '', - 'type' => 'string', + 'EffectiveTimeConfig' => [ + 'title' => '', + 'description' => 'The effective period configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The effective period type. Valid values:'."\n" + .'- FOREVER: permanent.'."\n" + .'- TIME_PERIOD: time period.', 'type' => 'string', 'required' => true, 'example' => 'TIME_PERIOD'], + 'StartTime' => ['title' => '', 'description' => 'The start of the effective period.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end of the effective period.', 'type' => 'string', 'required' => false, 'example' => '2025-12-30 00:00:00'], + ], 'required' => false, 'example' => '', ], - 'Description' => [ - 'title' => '用户组描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The owner. If this parameter is not specified, the current user is used.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'StandardTemplateReference' => [ + 'title' => '', + 'description' => 'The standard template to which the standard belongs.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'Version' => ['title' => '', 'description' => 'The standard template version number. The latest version is used by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'AttributeValueList' => [ + 'title' => '', + 'description' => 'The attribute values corresponding to the attributes in the referenced template. If this parameter is left empty, default values are used.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011'], + 'Value' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], - 'Active' => [ - 'title' => '是否启用用户组', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'StandardSetReference' => [ + 'title' => '', + 'description' => 'The reference to the standard set.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + ], + 'required' => true, + 'example' => '', ], - 'AdminUserIdList' => [ - 'title' => '用户组管理员用户Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户组管理员用户Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23231', + 'StandardGeneralMonitorConfig' => [ + 'title' => '', + 'description' => 'The standard monitoring configuration.', + 'type' => 'object', + 'properties' => [ + 'StandardMonitorConfigList' => [ + 'title' => '', + 'description' => 'The list of standard monitoring configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The monitoring configuration ID. If this parameter is left empty, a new monitoring configuration is created. If an existing monitoring configuration ID is specified, the corresponding monitoring configuration is updated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The rule description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The monitoring type. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'required' => true, 'example' => 'METADATA'], + 'MonitorFrom' => ['title' => '', 'description' => 'The method used to add the monitoring configuration. Valid values:'."\n" + .'- BY_USER: manually added.'."\n" + .'- BY_SYSTEM_ATTRIBUTE: preset by system attribute.', 'type' => 'string', 'required' => true, 'example' => 'BY_SYSTEM_ATTRIBUTE'], + 'AttributeId' => ['title' => '', 'description' => 'The associated attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '112'], + 'AttributeName' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'required' => false, 'example' => 'teset'], + 'AttributeMonitorConfig' => [ + 'title' => '', + 'description' => 'The monitoring configuration for the associated attribute.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitoring method. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'required' => true, 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'The field to check.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Specifies whether the check is case-sensitive.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'RuleSubType' => ['title' => '', 'description' => 'The rule subtype. This parameter is required when the monitoring type is QUALITY. Valid values:'."\n" + .'- BY_ATTRIBUTE: configured based on attributes.'."\n" + .'- CUSTOMIZED: custom configuration.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED'], + 'QualityRuleTemplate' => [ + 'title' => '', + 'description' => 'The rule template. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Type' => ['title' => '', 'description' => 'The template source. Valid values:'."\n" + .'- FROM_SYSTEM: system template.'."\n" + .'- CUSTOMIZED: custom template.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + ], + 'required' => false, + 'example' => '', + ], + 'RuleConfigList' => [ + 'title' => '', + 'description' => 'The rule configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'RuleValidateConfigList' => [ + 'title' => '', + 'description' => 'The rule validation configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The validation configuration ID. This ID is randomly generated by the business and must be unique.', 'type' => 'string', 'required' => true, 'example' => 'abc'], + 'ParentId' => ['title' => '', 'description' => 'The parent validation configuration ID. The parent rule validation type can only be RELATION.', 'type' => 'string', 'required' => false, 'example' => 'a'], + 'Type' => ['title' => '', 'description' => 'The rule validation type. Valid values:'."\n" + .'- RELATION: relation.'."\n" + .'- EXPRESSION: expression.', 'type' => 'string', 'required' => true, 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'If the validation type is EXPRESSION, valid values:'."\n" + .'- EQUAL: equal to.'."\n" + .'- NOT_EQUAL: not equal to.'."\n" + .'- LARGER: greater than.'."\n" + .'- LARGE_OR_EQUAL: greater than or equal to.'."\n" + .'- SMALLER: less than.'."\n" + .'- SMALLER_OR_EQUAL: less than or equal to.'."\n" + ."\n" + .'If the validation type is RELATION, valid values:'."\n" + .'- AND: and.'."\n" + .'- OR: or.', 'type' => 'string', 'required' => true, 'example' => 'AND'], + 'Metric' => ['title' => '', 'description' => 'The metric. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'required' => false, 'example' => 'a'], + 'MetricName' => ['title' => '', 'description' => 'The metric name. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The value to compare.', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], ], 'required' => false, + 'example' => '', ], + 'NeedGenerateStandardCode' => ['title' => '', 'description' => 'Specifies whether to generate a standard code based on rules. If this parameter is set to true, the standard code specified in the attribute values is ignored and a new standard code is generated.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'UserGroupId' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'example' => '2313131', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1234\\n}","type":"json"}]', + 'title' => 'Create a standard', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'AddUserGroupMember' => [ - 'summary' => '添加用户组成员.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardLookupTable' => [ + 'summary' => 'Creates a data standard lookup table.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -6856,138 +5572,103 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AddCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '添加用户组成员', - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'UserGroupId' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '132331', - ], - 'UserIdList' => [ - 'title' => '用户Id列表', - 'description' => '', + 'Name' => ['title' => '', 'description' => 'The name of the lookup table.', 'type' => 'string', 'required' => true, 'example' => '城市码表'], + 'Code' => ['title' => '', 'description' => 'The code of the lookup table.', 'type' => 'string', 'required' => true, 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'The description of the lookup table.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The ID of the lookup table owner. Default value: the user ID of the caller.', 'type' => 'string', 'required' => false, 'example' => '30012021'], + 'LookupTableValueList' => [ + 'title' => '', + 'description' => 'The list of lookup table values.', 'type' => 'array', 'items' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The code value.', 'type' => 'string', 'required' => true, 'example' => '杭州'], + 'Name' => ['title' => '', 'description' => 'The code name.', 'type' => 'string', 'required' => true, 'example' => 'Hangzhou'], + 'EnglishName' => ['title' => '', 'description' => 'The English name of the code.', 'type' => 'string', 'required' => false, 'example' => 'HZ'], + 'Description' => ['title' => '', 'description' => 'The description of the code.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], 'required' => false, - 'example' => '342313', + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'The directory to which the lookup table belongs.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The directory to which the lookup table belongs.', 'type' => 'string', 'required' => true, 'example' => '/dir1/dir2'], ], 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '添加结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The ID of the lookup table.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1234\\n}","type":"json"}]', + 'title' => 'Create a data standard lookup table', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteUserGroup' => [ - 'summary' => '删除用户组.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardMapping' => [ + 'summary' => 'Creates standard mapping relationships, including valid mappings and invalid mappings.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -6995,116 +5676,102 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UserGroupId', - 'in' => 'query', + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The create command.', + 'type' => 'object', + 'properties' => [ + 'AssetGuidList' => [ + 'title' => '', + 'description' => 'The list of asset GUIDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of asset GUIDs.', 'type' => 'string', 'required' => true, 'example' => '1121'], + 'required' => true, + 'example' => '', + ], + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'RelationType' => ['title' => '', 'description' => 'The mapping relationship type. Valid values:'."\n" + .'- VALID: valid mapping.'."\n" + .'- INVALID: invalid mapping.'."\n" + ."\n" + .'Default value: VALID.', 'type' => 'string', 'required' => false, 'example' => 'VALID'], + 'InvalidMappingRelationOperationType' => ['title' => '', 'description' => 'The processing policy for invalid mappings when importing mapping relationships. Valid values:'."\n" + .'- SET_INVALID_TO_VALID: sets invalid mappings to valid mappings.'."\n" + .'- KEEP_INVALID_AND_SKIP: retains invalid mappings and skips them.'."\n" + ."\n" + .'Default value: SET_INVALID_TO_VALID.', 'type' => 'string', 'required' => false, 'example' => 'SET_INVALID_TO_VALID'], + ], 'required' => true, - 'example' => '232131', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], 'Data' => [ - 'title' => '删除结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'SuccessCount' => ['title' => '', 'description' => 'The number of successfully added mappings.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'FailedGuidList' => [ + 'title' => '', + 'description' => 'The list of asset GUIDs that failed to be created.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of asset GUIDs that failed to be created.', 'type' => 'string', 'example' => '1021'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Create standard mapping relationships', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateUserGroup' => [ - 'summary' => '编辑用户组.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardRelations' => [ + 'summary' => 'Creates a standard association. Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -7112,152 +5779,103 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑用户组', - 'description' => '', + 'title' => '', + 'description' => 'The create command.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '13423', - ], - 'Name' => [ - 'title' => '用户组名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'AdminUserIdList' => [ - 'title' => '用户组管理员', - 'description' => '', + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'StandardRefList' => [ + 'title' => '', + 'description' => 'The list of referenced standards.', 'type' => 'array', 'items' => [ - 'title' => '用户组管理员', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], 'required' => false, - 'example' => '2323131', + 'description' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'example' => '', ], + 'RelationType' => ['title' => '', 'description' => 'The standard association type: RELATIVE.', 'type' => 'string', 'required' => true, 'example' => 'RELATIVE'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], 'Data' => [ - 'title' => '编辑结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'SuccessCount' => ['title' => '', 'description' => 'The number of successfully added items.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'NotExistStandardIdList' => [ + 'title' => '', + 'description' => 'The list of standard IDs that do not exist.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of standard IDs that do not exist.', 'type' => 'integer', 'format' => 'int64', 'example' => '1021'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Create standard association', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateUserGroupSwitch' => [ - 'summary' => '编辑用户组启用开关.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardSet' => [ + 'summary' => 'Creates a standard set.'."\n" + .'Available since: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -7265,127 +5883,158 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'UserGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '31323', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Active', - 'in' => 'query', + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '是否启用用户组标识', - 'description' => '', - 'type' => 'boolean', + 'title' => '', + 'description' => 'The create instruction.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the standard set.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'The code of the standard set.', 'type' => 'string', 'required' => true, 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'The description of the standard set.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'The directory to which the standard set belongs.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The directory to which the standard set belongs.', 'type' => 'string', 'required' => true, 'example' => '/dir1'], + ], + 'required' => false, + 'example' => '', + ], + 'MaintainerList' => [ + 'title' => '', + 'description' => 'The list of maintainers.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of maintainers.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'required' => false, + 'example' => '', + ], + 'MemberList' => [ + 'title' => '', + 'description' => 'The list of members.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of members.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'required' => false, + 'example' => '', + ], + 'MemberGroupList' => [ + 'title' => '', + 'description' => 'The list of member groups.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of member groups.', 'type' => 'string', 'required' => false, 'example' => '1121'], + 'required' => false, + 'example' => '', + ], + 'VisibilityConfig' => [ + 'title' => '', + 'description' => 'The visibility configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The visibility type. Valid values:'."\n" + .'- PUBLIC: visible to all users.'."\n" + .'- PRIVATE: visible only to standard set members and administrators.'."\n" + .'- SPECIFIED: visible only to specified users.', 'type' => 'string', 'required' => true, 'example' => 'PUBLIC'], + 'SpecifiedUserList' => [ + 'title' => '', + 'description' => 'The list of specified users who can view the standard set. This parameter takes effect only when the visibility type is set to SPECIFIED.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of specified users who can view the standard set. This parameter takes effect only when the visibility type is set to SPECIFIED.', 'type' => 'string', 'required' => false, 'example' => '1121'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'ApprovalConfig' => [ + 'title' => '', + 'description' => 'The approval configuration for going online.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Specifies whether to enable approval.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Specifies whether to submit approvals in batches.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'The approval process type. Valid values:'."\n" + .'- BY_DEFAULT: the default approval type.'."\n" + .'- BY_TEMPLATE: approval based on an approval template.', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'The ID of the approval template. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + ], + 'required' => false, + 'example' => '', + ], + 'OfflineApprovalConfig' => [ + 'title' => '', + 'description' => 'The approval configuration for going offline.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Specifies whether to enable approval.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Specifies whether to submit approvals in batches.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'The approval process type. Valid values:'."\n" + .'- BY_DEFAULT: the default approval type.'."\n" + .'- BY_TEMPLATE: approval based on an approval template.', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'The ID of the approval template. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + ], + 'required' => false, + 'example' => '', + ], + 'DefaultStandardTemplateId' => ['title' => '', 'description' => 'The ID of the default standard template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1001'], + ], 'required' => true, - 'example' => 'true', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '编辑结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The ID of the standard set.', 'type' => 'integer', 'format' => 'int64', 'example' => '1201'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1201\\n}","type":"json"}]', + 'title' => 'Create a standard set', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateTenantMember' => [ - 'summary' => '编辑租户成员', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardTemplate' => [ + 'summary' => 'Create a data standard template.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -7393,3139 +6042,1643 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求对象', - 'description' => '', + 'title' => '', + 'description' => 'Create command.', 'type' => 'object', 'properties' => [ - 'MemberList' => [ - 'title' => '成员列表', - 'description' => '', + 'Name' => ['title' => '', 'description' => 'Standard template name.', 'type' => 'string', 'required' => true, 'example' => '测试模板'], + 'Code' => ['title' => '', 'description' => 'Standard template code. Globally unique. Cannot be modified when referenced.', 'type' => 'string', 'required' => true, 'example' => 'test01'], + 'Description' => ['title' => '', 'description' => 'Standard template description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'MaintainerList' => [ + 'title' => '', + 'description' => 'Maintainers.', 'type' => 'array', - 'items' => [ - 'title' => '成员对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - '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', + 'items' => ['title' => '', 'description' => 'Maintainer.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'required' => false, + 'example' => '', + ], + 'AttributesConfig' => [ + 'title' => '', + 'description' => 'Attribute configuration.', + 'type' => 'object', + 'properties' => [ + 'AttributeList' => [ + 'title' => '', + 'description' => 'Attribute list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Attribute name. Not required when referencing a public attribute.', 'type' => 'string', 'required' => false, 'example' => 'attr1'], + 'Code' => ['title' => '', 'description' => 'Attribute code. Not required when referencing a public attribute.', 'type' => 'string', 'required' => false, 'example' => 'test_attr'], + 'Type' => ['title' => '', 'description' => 'Attribute type. Valid values: BIZ_ATTRIBUTE (business attribute), TECH_ATTRIBUTE (technical attribute), MANAGEMENT_ATTRIBUTE (management attribute), QUALITY_ATTRIBUTE (quality attribute), MASTER_DATA_ATTRIBUTE (master data attribute), LIFECYCLE_ATTRIBUTE (lifecycle attribute), and SECURITY_ATTRIBUTE (security attribute). Not required when referencing a public attribute.', 'type' => 'string', 'required' => false, 'example' => 'BIZ_ATTRIBUTE'], + 'Required' => ['title' => '', 'description' => 'Specifies whether the attribute is required. Not required when referencing a public attribute.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'Value configuration. Not required when referencing a public attribute.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Attribute value type. Valid values: CUSTOMIZED (custom input), SINGLE_ENUM (single enumeration value), MULTIPLE_ENUMS (multiple enumeration values), and RANGE (range value).', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'Data type of the attribute value. Valid values: STRING (string), BIGINT (numeric), DOUBLE (floating point), DATE (date with day precision), DATETIME (date with millisecond precision), and BOOLEAN (boolean).', 'type' => 'string', 'required' => true, 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'Attribute value length. An empty value or -1 indicates no length limit. Usually only the string type has a length limit for attribute values.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'ValueRange' => [ + 'title' => '', + 'description' => 'Value range.', + 'type' => 'object', + 'properties' => [ + 'ValueConstraint' => ['title' => '', 'description' => 'Value source. Valid values: NONE (no constraint), LIST (from a list), LOOKUP_TABLE (lookup table), MIN_MAX (between minimum and maximum values), DATAPHIN_ATTRIBUTE (Dataphin system attribute), BUILT_IN_DATA_TYPES (built-in data types), BUILT_IN_DATA_CLASSIFICATION (built-in data classification), and BUILT_IN_DATA_LEVEL (built-in data security level).', 'type' => 'string', 'required' => true, 'example' => 'NONE'], + 'ValueList' => [ + 'title' => '', + 'description' => 'Value list. Effective when the value source is LIST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Value. Effective when the value source is LIST.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'required' => false, + 'example' => '', + ], + 'MinMaxValueConfig' => [ + 'title' => '', + 'description' => 'Min-max value configuration. Effective when the value source is MIN_MAX.', + 'type' => 'object', + 'properties' => [ + 'MinValue' => ['title' => '', 'description' => 'Minimum value.', 'type' => 'string', 'required' => true, 'example' => '0'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Specifies whether to include the minimum value.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'Maximum value.', 'type' => 'string', 'required' => true, 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Specifies whether to include the maximum value.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'LookupTableReference' => [ + 'title' => '', + 'description' => 'Lookup table reference. Effective when the value source is LOOKUP_TABLE.', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'Lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'Column' => ['title' => '', 'description' => 'Referenced lookup table column.', 'type' => 'string', 'required' => false, 'example' => 'col1'], + ], + 'required' => false, + 'example' => '', + ], + 'DataphinAttributeType' => ['title' => '', 'description' => 'Dataphin attribute type. Effective when the value source is DATAPHIN_ATTRIBUTE. Valid values: BIZ_UNIT (data domain), PROJECT (project), USER (user), and USER_GROUP (user group).', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_ATTRIBUTE'], + ], + 'required' => true, + 'example' => '', + ], + 'DefaultValue' => ['title' => '', 'description' => 'Default value.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'example' => '', + ], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'RefAttribute' => [ + 'title' => '', + 'description' => 'Referenced attribute information.', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'Attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'AttributeFromInfo' => [ + 'title' => '', + 'description' => 'Attribute source.', + 'type' => 'object', + 'properties' => [ + 'AttributeFrom' => ['title' => '', 'description' => 'Attribute source type. Valid values: SYSTEM (system attribute), CUSTOM (custom attribute), and STANDARD (standard).', 'type' => 'string', 'required' => true, 'example' => 'CUSTOM'], + 'StandardReference' => [ + 'title' => '', + 'description' => 'Standard reference. Effective when the attribute source is STANDARD.', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'Standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'Version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], ], 'required' => false, + 'description' => '', + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'required' => false, ], 'required' => true, + 'example' => '', + ], + 'PublishInfo' => [ + 'title' => '', + 'description' => 'Standard template publish information.', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['title' => '', 'description' => 'Publish comment.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'example' => '', + ], + 'CodeRuleConfig' => [ + 'title' => '', + 'description' => 'Standard code auto-generation rule configuration.', + 'type' => 'object', + 'properties' => [ + 'GenerateType' => ['title' => '', 'description' => 'Standard code generation method. Valid values: CUSTOMIZED (custom) and AUTO_GENERATE (auto-generate based on standard code rules).', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'AutoConfig' => [ + 'title' => '', + 'description' => 'Standard code rule auto-generation configuration. Effective when the generation method is AUTO_GENERATE.', + 'type' => 'object', + 'properties' => [ + 'NeedStrongValidate' => ['title' => '', 'description' => 'Specifies whether to enable strict validation.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'CodeRuleList' => [ + 'title' => '', + 'description' => 'Standard code rules.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'Code rule position index.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'Code rule type. Valid values: FIXED_STRING (fixed string), AUTO_INCREMENT (auto-increment sequence), and STANDARD_SET_CODE (standard set code).', 'type' => 'string', 'required' => true, 'example' => 'FIXED_STRING'], + 'Value' => ['title' => '', 'description' => 'Code rule format or value.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AutoIncrementSequenceConfig' => [ + 'title' => '', + 'description' => 'Auto-increment sequence configuration.', + 'type' => 'object', + 'properties' => [ + 'Digit' => ['title' => '', 'description' => 'Number of digits.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], + 'StartValue' => ['title' => '', 'description' => 'Start value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'Step' => ['title' => '', 'description' => 'Step.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'NeedPaddingZero' => ['title' => '', 'description' => 'Specifies whether to pad with zeros.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'Standard template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 22\\n}","type":"json"}]', + 'title' => 'CreateDataStandardTemplate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListResourcePermissionOperationLog' => [ - 'summary' => '分页获取权限操作列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateStandardWordRoot' => [ + 'summary' => 'Creates a data standard root word.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The create instruction.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the root word.', 'type' => 'string', 'required' => true, 'example' => '平均值'], + 'FullName' => ['title' => '', 'description' => 'The full name of the root word.', 'type' => 'string', 'required' => true, 'example' => 'average'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the root word.', 'type' => 'string', 'required' => true, 'example' => 'avg'], + 'Description' => ['title' => '', 'description' => 'The description of the root word.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The name of the root word.', 'type' => 'string', 'example' => 'average'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"average\\"\\n}","type":"json"}]', + 'title' => 'Create a data standard root word', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateStreamBatchJobMapping' => [ + 'summary' => 'Creates a stream-batch integrated node.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['Dataphin公共云'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ListQuery', + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'StreamBatchJobMappingCreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页请求', - 'description' => '', + 'title' => '', + 'description' => 'The stream-batch integrated node information.', 'type' => 'object', 'properties' => [ - 'TabType' => [ - 'title' => 'TAB名称：表：TABLE;数据源：DATASOURCE', - 'description' => '', - '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', - ], + 'Env' => ['title' => '', 'description' => 'The environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'EngineVersion' => ['title' => '', 'description' => 'The Flink DPI engine version.', 'type' => 'string', 'required' => true, 'example' => 'vvr-8.0.9-flink-1.17'], + 'ClusterId' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d'], + 'QueueName' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'required' => true, 'example' => 'default-queue'], + 'Directory' => ['title' => '', 'description' => 'The folder in which the node is generated.', 'type' => 'string', 'required' => true, 'example' => '/karel'], + 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'karel_hover_3'], + 'FileType' => ['title' => '', 'description' => 'The file type.', 'type' => 'string', 'required' => true, 'example' => 'FLINK_SQL'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752'], + 'VvpClusterType' => ['title' => '', 'description' => 'The VVP cluster type. Valid values: SESSION and PREJOB. This parameter is specific to VVP. If not applicable, leave this parameter empty or do not pass it.', 'type' => 'string', 'required' => true, 'example' => 'PREJOB'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '这是一段任务的描述信息'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The result returned when the node is created.', '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123133', - ], - 'OperateType' => [ - 'title' => '操作类型: 申请：APPLY；授权：GRANT', - 'description' => '', - 'type' => 'string', - 'example' => 'APPLY', - ], - 'ResourceInfo' => [ - 'title' => '权限资源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '权限资源ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'Env' => [ - 'title' => '资源环境类型 开发：DEV；生产：PROD', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - ], - ], - 'ProjectInfo' => [ - 'title' => '项目', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '项目ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - ], - ], - ], - ], - 'Account' => [ - 'title' => '操作人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', - 'description' => '', - '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', - ], - ], - ], - 'TargetAccount' => [ - 'title' => '被授权对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'EndTime' => [ - 'title' => '到期时间', - 'description' => '', - 'type' => 'string', - 'example' => '1712000000000', - ], - ], - ], - 'AuthScope' => [ - 'title' => '表的授权范围 制定表：selectTable 项目下所有表：projectAllTable，板块下所有逻辑表：bizUnitAllLogicTable', - 'description' => '', - 'type' => 'string', - 'example' => 'selectTable', - ], - ], - ], - ], + 'FileId' => ['title' => '', 'description' => 'The job file ID.', 'type' => 'string', 'example' => '7083701105376640'], + 'Url' => ['title' => '', 'description' => 'The redirect relative path.', 'type' => 'string', 'example' => '/dev/streamJob/7083701105376640?env=DEV&projectId=7081229106458752&tenantId=300001420'], + 'JobId' => ['description' => 'JobId', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Create a stream-batch integrated node', + 'changeSet' => [ + ['createdAt' => '2025-08-18T09:35:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateStreamBatchJobMapping', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + ], + 'CreateUdf' => [ + 'summary' => 'Creates a user-defined function.', + '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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The create command.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'required' => true, 'example' => 'my_udf'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine type. Valid values: MAX_COMPUTE, HADOOP.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], + 'Directory' => ['title' => '', 'description' => 'The directory in which the function is stored.', 'type' => 'string', 'required' => false, 'example' => '/'], + 'RefResourceIdList' => [ + 'title' => '', + 'description' => 'The IDs of referenced resources.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The IDs of referenced resources.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10200121011'], + 'required' => true, + 'example' => '', + ], + 'ClassName' => ['title' => '', 'description' => 'The class name that implements the function in the resource.', 'type' => 'string', 'required' => true, 'example' => 'com.lydaas.SleepTest'], + 'Category' => ['title' => '', 'description' => 'The UDF category identifier. Valid values: 1: window function. 2: statistical function. 3: numerical function. 4: string function. 5: time function. 6: IP address utility function. 7: URL-related function. 8: encoding and decoding function. 9: business-related function. 10: other.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'CommandHelp' => ['title' => '', 'description' => 'The command format for function calling invoke.', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep(100)'], + 'Comment' => ['title' => '', 'description' => 'The commit remarks.', 'type' => 'string', 'required' => true, 'example' => '测试'], + ], + 'required' => true, + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The function ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10212101'], + ], + 'example' => '', + ], + ], ], - '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"}]', - ], - 'ListResourcePermissions' => [ - 'summary' => '分页获取权限记录列表', - 'methods' => [ - 'post', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 10212101\\n}","type":"json"}]', + 'title' => 'Create a user-defined function', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateUserGroup' => [ + 'summary' => 'Creates a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'CreateCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The creation request.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the user group.', 'type' => 'string', 'required' => false, 'example' => 'xx用户组'], + 'Description' => ['title' => '', 'description' => 'The description of the user group.', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'Active' => ['title' => '', 'description' => 'Specifies whether to enable the user group.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AdminUserIdList' => [ + 'title' => '', + 'description' => 'The user IDs of the user group administrators.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user IDs of the user group administrators.', 'type' => 'string', 'required' => false, 'example' => '23231'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'UserGroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '2313131'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Create a user group', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateWorkFlowByJson' => [ + 'summary' => 'Creates an unstructured workflow node using JSON script mode. Online version: v6.2.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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the workflow node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '789'], + 'Env' => ['title' => '', 'description' => 'The current operating environment. Valid values:'."\n" + ."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment.'."\n" + ."\n" + .'The current version supports only BASIC mode, so set this parameter to PROD.', 'type' => 'string', 'required' => true, 'example' => 'PROD'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', ], ], [ - 'name' => 'ListQuery', + 'name' => 'CreateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页请求', - 'description' => '', + 'title' => '', + 'description' => 'The JSON script command for creating a workflow.', 'type' => 'object', 'properties' => [ - 'TabType' => [ - 'title' => 'TAB名称：表：TABLE;数据源：DATASOURCE', - 'description' => '', - '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', - ], + 'ScheduleConfig' => ['title' => '', 'description' => 'The schedule configuration. This parameter is required for periodic nodes. The value is a JSON string. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString method.', 'type' => 'string', 'required' => false, 'example' => '{"cronExpression":"0 0 0 * * ?"}'], + 'WorkFlowJson' => ['title' => '', 'description' => 'The workflow JSON.', 'type' => 'string', 'required' => true, 'example' => '{"pipelineDTO":{"hops":[],"steps":[{"name":"xxx","x":305,"y":144,"id":"c404a7c6-8a75-4ed8-b348-0785423ad859","webConfig":{},"type":"text","key":"special_character_removal","pluginConfig":{"neuronParameters":{},"neuronInput":{},"neuronOutput":{},"setting":{}}}]}}'], + 'Description' => ['title' => '', 'description' => 'The description of the node.', 'type' => 'string', 'required' => false, 'example' => 'cooment'], + 'TaskName' => ['title' => '', 'description' => 'The name of the node.', 'type' => 'string', 'required' => true, 'example' => 'workflow_name'], + 'TaskType' => ['title' => '', 'description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'- 1: periodic scheduling.'."\n" + .'- 3: manual scheduling.'."\n" + .'- 5: real-time node.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5372881'], + 'Submit' => ['title' => '', 'description' => 'Specifies whether to submit the node. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Directory' => ['title' => '', 'description' => 'The folder to which the node belongs. If this parameter is left empty, the root folder is used.', 'type' => 'string', 'required' => false, 'example' => '/'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '12123111', - ], - 'ResourceInfo' => [ - 'title' => '权限资源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '权限资源ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'Env' => [ - 'title' => '资源环境类型 开发：DEV；生产：PROD', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - ], - ], - 'ProjectInfo' => [ - 'title' => '项目', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '项目ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - ], - ], - ], - ], - 'TargetAccount' => [ - 'title' => '被授权对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '个人账号：Dataphin侧userId；生产账号：UserId（通过GetProjectProduceUser接口获取），用户组：用户组Id（通过ListUserGroup接口获取）', - 'description' => '', - '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', - ], - ], - ], - 'Period' => [ - 'title' => '有效期设置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '有效期类型'."\n" - .'自定义：CUSTOM；长期：LONG_TERM', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'EndTime' => [ - 'title' => '到期时间', - 'description' => '', - 'type' => 'string', - 'example' => '1712000000000', - ], - ], - ], - 'AuthScope' => [ - 'title' => '表的授权范围 制定表：selectTable 项目下所有表：projectAllTable，板块下所有逻辑表：bizUnitAllLogicTable', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'EndTime' => [ - 'title' => '到期时间', - 'description' => '', - 'type' => 'string', - 'example' => '1712000000000', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The creation result of the workflow node.', + 'type' => 'object', + 'properties' => [ + 'SubmitId' => ['title' => '', 'description' => 'The submit ID generated for the pending publish list after submission. Use this ID to publish through the publish domain. You can ignore this value for BASIC projects.', 'type' => 'integer', 'format' => 'int64', 'example' => '7891'], + 'HostMachine' => ['title' => '', 'description' => 'The name and IP address of the server-side execution machine.', 'type' => 'string', 'example' => 'hostName:hostIp'], + 'Version' => ['title' => '', 'description' => 'The pending publish version number generated after the workflow is submitted. You can ignore this value for BASIC projects.', 'type' => 'string', 'example' => '1'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the workflow node after successful creation.', 'type' => 'string', 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The workflow ID after successful creation.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an unstructured workflow node using JSON script mode', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SubmitId\\": 7891,\\n \\"HostMachine\\": \\"hostName:hostIp\\",\\n \\"Version\\": \\"1\\",\\n \\"NodeId\\": \\"n_123\\",\\n \\"PipelineId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'GetProjectProduceUser' => [ - 'summary' => '获取项目生产账号', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteAdHocFile' => [ + 'summary' => 'Deletes an ad hoc query file from the menu tree.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131311111321', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'User' => [ - 'title' => '生产者用户', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '123131', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Delete Ad Hoc Query File', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:41:31.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetUsers' => [ - 'summary' => '获取用户详情', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteBatchTask' => [ + 'summary' => 'Deletes a batch task. If the node has not been offlined, you must offline it before deleting it.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UserIdList', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户Id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '132313', + 'title' => '', + 'description' => 'The delete request.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'FileId' => ['title' => '', 'description' => 'The ID of the node in the folder.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + 'Comment' => ['title' => '', 'description' => 'The description of the delete operation.', 'type' => 'string', 'required' => true, 'example' => 'test task'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1233121', - ], - 'ParentId' => [ - 'title' => '用户归属主账号Id', - 'description' => '', - 'type' => 'string', - 'example' => '231231', - ], - 'SourceType' => [ - 'title' => '用户来源', - 'description' => '', - 'type' => 'string', - 'example' => 'ALIYUN', - ], - 'SourceId' => [ - 'title' => '用户来源Id', - 'description' => '', - 'type' => 'string', - 'example' => '123@xx.com', - ], - 'Name' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DisplayName' => [ - 'title' => '用户显示名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DisplayNameWithoutStatus' => [ - 'title' => '用户显示名（不含状态）', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AccountName' => [ - 'title' => '账号名', - 'description' => '', - 'type' => 'string', - 'example' => '123@xx.com', - ], - 'RealName' => [ - 'title' => '用户真实名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'NickName' => [ - 'title' => '用户昵称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'WhiteIp' => [ - 'title' => '白名单', - 'description' => '', - 'type' => 'string', - 'example' => '*', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717343597000', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Delete a batch task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListAddableUsers' => [ - 'summary' => '获取可加入租户成员列表的用户', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteBizEntity' => [ + 'summary' => 'Deletes a business entity.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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, - ], + 'name' => 'BizUnitId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the business unit to which the entity belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the business entity. For more information, refer to the create business entity operation.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '123231', - ], - 'ParentId' => [ - 'title' => '用户归属主账号Id', - 'description' => '', - 'type' => 'string', - 'example' => '231313', - ], - 'SourceType' => [ - 'title' => '用户来源', - 'description' => '', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'SourceId' => [ - 'title' => '用户来源Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'WhiteIp' => [ - 'title' => '白名单', - 'description' => '', - 'type' => 'string', - 'example' => '*', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717343597000', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Delete a business entity', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListTenantMembers' => [ - 'summary' => '查询租户成员列表', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteBizMetric' => [ + 'summary' => 'Deletes a business metric.'."\n" + .'Release version: v5.5.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'DeleteBizMetricCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求对象', - 'description' => '', + 'title' => '', + 'description' => 'The delete request.', '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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1213111', - ], - 'required' => false, - ], - 'RoleList' => [ - 'title' => '成员角色：'."\n" - .'SUPER_ADMIN PROJECT_OPS PROJECT_DEVELOPER等', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DATA_ADMIN', - ], - 'required' => false, - ], + 'Name' => ['title' => '', 'description' => 'The name of the business metric to delete.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'example' => 'Metric1'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The deletion result.', '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' => '', - 'type' => 'string', - 'example' => '132321', - ], - 'SourceType' => [ - 'title' => '用户来源', - 'description' => '', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'SourceId' => [ - 'title' => '用户来源Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '121313', - ], - 'Name' => [ - 'title' => '用户组名字', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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', - ], - ], - ], - ], - ], + 'Success' => ['title' => '', 'description' => 'Indicates whether the deletion was successful. Valid values:'."\n" + .'- true: Succeeded.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'The exception information.', 'type' => 'string', 'example' => 'success'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Delete a business metric', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetUserGroup' => [ - 'summary' => '获取用户组详情.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteBizUnit' => [ + 'summary' => 'Deletes a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UserGroupId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1313213', - ], + 'schema' => ['title' => '', 'description' => 'The business domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'UserGroupInfo' => [ - 'title' => '用户组详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'example' => '1313213', - ], - 'Name' => [ - 'title' => '用户组名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '131313', - ], - 'DisplayName' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AccountName' => [ - 'title' => '用户账号名', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], - ], - 'MyRole' => [ - 'title' => '当前用户在用户组角色', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Delete a data domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:18.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListAddableRoles' => [ - 'summary' => '获取用户角色列表', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteComputeSource' => [ + 'summary' => 'Deletes a compute source.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Delete a compute source', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListUserGroups' => [ - 'summary' => '用户组列表分页查询.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDataDomain' => [ + 'summary' => 'Deletes a subject domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - ], - 'Active' => [ - 'title' => '是否启用用户组', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AdminIdList' => [ - 'title' => '用户组管理员用户Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户组管理员用户Id', - 'description' => '', - '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, - ], + 'name' => 'BizUnitId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The subject domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '31313232', - ], - 'Name' => [ - 'title' => '用户组名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '用户组描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Active' => [ - 'title' => '是否启用用户组', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AdminList' => [ - 'title' => '用户组管理员', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Delete a subject domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:18.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetMyTenants' => [ - 'summary' => '获取当前用户归属租户.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDataServiceApp' => [ + 'summary' => 'Deletes a data service application. Only superusers, system administrators, or application owners can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FeatureCodeList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '租户拥有售卖Code', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '售卖Code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DATAPHIN_STREAM', - ], - 'required' => false, - ], + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '-535093682933'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '132311', - ], - 'Name' => [ - 'title' => '租户名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OwnerId' => [ - 'title' => '租户归属用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '21323231', - ], - 'Description' => [ - 'title' => '租户描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Delete a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetMyRoles' => [ - 'summary' => '获取用户角色列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDataServiceAppGroup' => [ + 'summary' => 'Deletes a data service application group. Only superusers and system administrators can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '550980364236'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'RoleList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '角色Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300047957', - ], - 'Name' => [ - 'title' => '角色名称', - 'description' => '', - 'type' => 'string', - 'example' => 'dataphinAdmin', - ], - 'Description' => [ - 'title' => '角色描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Delete a data service application group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListUserGroupMembers' => [ - 'summary' => '用户组成员列表分页查询.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDataSource' => [ + 'summary' => 'Deletes a data source.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询', - 'description' => '', + 'title' => '', + 'description' => 'The request for deleting a data source.', 'type' => 'object', 'properties' => [ - 'Keyword' => [ - 'title' => '用户名关键字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'UserGroupId' => [ - 'title' => '用户组Id', - 'description' => '', + 'Mode' => [ + 'title' => '', + 'description' => 'The deletion mode selection. Valid values:'."\n" + .'- DEV: deletes the data source only in the development environment.'."\n" + .'- DEV_PROD: deletes the data source in both the development and production environments.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => false, - 'example' => '232231', - ], - 'UserIdList' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户Id', - 'description' => '', - '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', + 'example' => 'DEV', + 'enum' => ['DEV', 'DEV_PROD'], ], + 'ProdDataSourceId' => ['title' => '', 'description' => 'The ID of the data source in the production environment.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13121'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2324211', - ], - 'UserGroupId' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', - 'example' => '231111', - ], - 'UserInfo' => [ - 'title' => '用户组成员', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '13232', - ], - 'DisplayName' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The deletion result.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Delete a data source', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetUserBySourceId' => [ - 'summary' => '通过用户原始Id（如阿里云Id）获取用户详情', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDataset' => [ + 'summary' => 'Deletes a dataset. Release version: v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SourceId', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7280840713415040'], + ], + [ + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7262419688152064'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '用户来源Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323131', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a dataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + ], + 'DeleteDirectory' => [ + 'summary' => 'Deletes a file directory from the menu tree.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'User' => [ - 'title' => '用户对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户id', - 'description' => '', - 'type' => 'string', - 'example' => '23231231', - ], - 'DisplayName' => [ - 'title' => '用户显示名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Delete a menu tree file directory', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GrantResourcePermission' => [ - 'summary' => '通过资源点对用户授权', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteQualityRules' => [ + 'summary' => 'Deletes quality rule objects in batches.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -10533,180 +7686,77 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'GrantCommand', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '授权请求', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', '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' => '', - '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', - ], + 'RuleIdList' => [ + 'title' => '', + 'description' => 'The rule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of deleted rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Batch delete quality rule objects', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'RevokeResourcePermission' => [ - 'summary' => '回收用户资源授权', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteQualitySchedules' => [ + 'summary' => 'Deletes quality scheduling objects in batches.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -10714,341 +7764,155 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RevokeCommand', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '授权回收请求', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'odps.300002102.beginner_test.amin_table', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'OperateList' => [ - 'title' => '操作列表', - 'description' => '', + 'ScheduleIdList' => [ + 'title' => '', + 'description' => 'The IDs of the scheduling objects.', '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' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'The IDs of the scheduling objects.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], 'required' => true, - 'example' => '13131', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of deleted scheduling objects.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Batch delete quality scheduling objects', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CheckResourcePermission' => [ - 'summary' => '校验用户是否有指定资源权限点.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteQualityTemplates' => [ + 'summary' => 'Deletes quality template objects in batches.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CheckCommand', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '校验用户资源点权限', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323231', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PHYSICAL_TABLE', - ], - 'ResourceList' => [ - 'title' => '权限资源列表', - 'description' => '', + 'TemplateIdList' => [ + 'title' => '', + 'description' => 'The template object IDs.', 'type' => 'array', - 'items' => [ - 'title' => '权限资源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Operate' => [ - 'title' => '操作类型', - 'description' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'The template object IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], 'required' => true, - 'example' => 'UPDATE', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ResourcePermissionList' => [ - 'title' => '资源权限列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源Id', - 'description' => '', - 'type' => 'string', - 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01'."\n", - ], - 'HasPermission' => [ - 'title' => '是否有指定资源点权限', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of deleted templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Batch delete quality template objects', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'RemoveTenantMember' => [ - 'summary' => '删除租户成员', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteQualityWatches' => [ + 'summary' => 'Deletes monitored objects in batches.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -11056,258 +7920,305 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RemoveCommand', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', 'type' => 'object', 'properties' => [ - 'SourceId' => [ - 'title' => '用户来源Id', - 'description' => '', - 'type' => 'string', + 'WatchIdList' => [ + 'title' => '', + 'description' => 'The IDs of the monitored objects.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The IDs of the monitored objects.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], 'required' => true, - 'example' => '123@xx.com', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The exception details of the backend response.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of deleted monitored objects.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Batch delete monitored objects', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'RemoveUserGroupMember' => [ - 'summary' => '移除用户组成员.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteRegisterLineage' => [ + 'summary' => 'Deletes registered lineage. Available since version v5.4.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RemoveCommand', + 'name' => 'DeleteRegisterLineageCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '移除用户组成员', - 'description' => '', + 'title' => '', + 'description' => 'The command for deleting registered lineage.', 'type' => 'object', 'properties' => [ - 'UserGroupId' => [ - 'title' => '用户组Id', - 'description' => '', - 'type' => 'string', + 'Source' => [ + 'title' => '', + 'description' => 'The source of the lineage.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID, BY_PROPERTY.', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'MetadataSubType' => ['title' => '', 'description' => 'The asset subtype. Specify this parameter only when metadataType is set to TABLE and referenceType is not set to BY_GUID.', 'type' => 'string', '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', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog asset property. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema asset property. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'table1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], 'required' => true, - 'example' => '2311', + 'example' => '', ], - 'UserIdList' => [ - 'title' => '用户Id列表', - 'description' => '', + 'Target' => [ + 'title' => '', + 'description' => 'The target of the lineage.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID, BY_PROPERTY.', 'type' => 'string', 'required' => true, 'example' => 'BY_GUID, BY_PROPERTY'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'MetadataSubType' => ['title' => '', 'description' => 'The asset subtype. Specify this parameter only when metadataType is set to TABLE and referenceType is not set to BY_GUID.', 'type' => 'string', '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', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog asset property. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema asset property. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'table1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + 'DetailedLineages' => [ + 'title' => '', + 'description' => 'The detailed lineage relationships. For tables, the detailed lineage relationships refer to field-level lineage.', 'type' => 'array', 'items' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '131313', + 'title' => '', + 'description' => 'The child object lineage relationship.', + 'type' => 'object', + 'properties' => [ + 'IsDirect' => ['title' => '', 'description' => 'Specifies whether the lineage is direct. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Source' => [ + 'title' => '', + 'description' => 'The source asset reference.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID, BY_PROPERTY.', 'type' => 'string', 'example' => 'BY_GUID, BY_PROPERTY', 'required' => false], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'ParentGuid' => ['title' => '', 'description' => 'The GUID of the parent asset. If the current object is a field, parentGuid is the GUID of the table to which the field belongs.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'example' => 'COLUMN', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog asset property. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema asset property. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + 'Target' => [ + 'title' => '', + 'description' => 'The target asset reference.', + 'type' => 'object', + 'properties' => [ + 'ReferenceType' => ['title' => '', 'description' => 'The asset reference data type. Valid values: BY_GUID, BY_PROPERTY.', 'type' => 'string', 'example' => 'BY_GUID, BY_PROPERTY', 'required' => false], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset. This parameter is required when referenceType is set to BY_GUID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'ParentGuid' => ['title' => '', 'description' => 'The GUID of the parent asset. If the current object is a field, parentGuid is the GUID of the table to which the field belongs.', 'type' => 'string', 'required' => false, 'example' => 'odps.300000001.project1.table1'], + 'MetadataType' => ['title' => '', 'description' => 'The asset type. Set this parameter based on the actual scenario.', 'type' => 'string', 'example' => 'COLUMN', 'required' => false], + 'Catalog' => ['title' => '', 'description' => 'The catalog asset property. For tables, the catalog of both compute source tables and logical tables is uniformly set to dataphin. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'dataphin'], + 'Schema' => ['title' => '', 'description' => 'The schema asset property. For tables, this is typically the project or business unit. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'project1, bizUnit1'], + 'Env' => ['title' => '', 'description' => 'The environment to which the asset belongs. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'DEV, PROD'], + 'Name' => ['title' => '', 'description' => 'The name of the asset. This property is used to identify the corresponding asset by property when referenceType is set to BY_PROPERTY. If referenceType is set to BY_GUID, this property does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'ExtProperties' => ['title' => '', 'description' => 'The extended properties.', 'type' => 'object', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', ], - 'required' => true, + 'required' => false, + 'example' => '', ], + 'CascadeDeleteLineage' => ['title' => '', 'description' => 'Specifies whether to automatically delete the object lineage after all detailed lineage entries are deleted. Default value: true.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => ''], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300001234'], + 'UserId' => ['title' => '', 'description' => 'The ID of the current user.', 'type' => 'string', 'required' => false, 'example' => '300004567'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '移除用户组成员结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], - 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 \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Delete registered lineage', + 'extraInfo' => 'Released in version: 5.4.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteResource' => [ + 'summary' => 'Delete a resource file.', + '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' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Resource file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10300010201'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'required' => true, 'example' => '测试'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend error details.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete Resource File', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], 'DeleteRowPermission' => [ - 'summary' => '删除行级权限', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a row-level permission.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11315,321 +8226,402 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'DeleteRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The request command.', 'type' => 'object', 'properties' => [ - 'RowPermissionId' => [ - 'title' => '行级权限ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '300001234', - ], + 'RowPermissionId' => ['title' => '', 'description' => 'The row-level permission ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001234'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Delete row-level permission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetAccountByRowPermissionId' => [ - 'summary' => '根据行级权限ID获取某一行级权限下的所有授权账号', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteSecurityClassify' => [ + 'summary' => 'Deletes a data categorization. Available since v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The delete instruction.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The categorization ID. If this parameter is not specified, the categorization is matched and deleted based on the categorization name and parent path.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The categorization name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ParentPath' => ['title' => '', 'description' => 'The categorization path. Default value: /.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The deletion result.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": false\\n}","type":"json"}]', + 'title' => 'Delete a data categorization', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteSecurityClassifyCatalog' => [ + 'summary' => 'Deletes a data classification catalog. Release version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], [ - 'name' => 'GetAccountByRowPermissionIdQuery', + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', 'type' => 'object', 'properties' => [ - 'RowPermissionId' => [ - 'title' => '行级权限ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '300001234', - ], - 'RuleIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '300001235', - ], - 'required' => true, - ], + 'Path' => ['title' => '', 'description' => 'The full path of the original catalog.', 'type' => 'string', 'required' => true, 'example' => '/d1/d2/'], + 'ReturnRemovedDetails' => ['title' => '', 'description' => 'Specifies whether to return deletion details. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '300901111', - ], - 'AccountName' => [ - 'title' => '规则绑定账号名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'enum' => [ - 'PERSONAL', - 'PRODUCE', - 'USER_GROUP', - ], - ], - ], - ], - ], + 'title' => '', + 'description' => 'The deletion result details.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '', 'description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => ''], + 'ChildCatalogFullPathList' => [ + 'title' => '', + 'description' => 'The list of full paths of child catalogs that were also deleted.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of full paths of child catalogs that were also deleted.', 'type' => 'string', 'example' => '/d1/d2/d3/'], + 'example' => '', + ], + 'ClassifyIdList' => [ + 'title' => '', + 'description' => 'The list of classification IDs that were also deleted.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of classification IDs that were also deleted.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"Success\\": false,\\n \\"ChildCatalogFullPathList\\": [\\n \\"/d1/d2/d3/\\"\\n ],\\n \\"ClassifyIdList\\": [\\n 5\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Delete a data classification catalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteSecurityIdentifyResults' => [ + 'summary' => 'Deletes security identification results in batches. Release version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The delete instruction.', + 'type' => 'object', + 'properties' => [ + 'IdentifyResultIdList' => [ + 'title' => '', + 'description' => 'The list of identification result IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of identification result IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The deletion result.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": false\\n}","type":"json"}]', + 'title' => 'Batch delete security identification results', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListRowPermission' => [ - 'summary' => '分页查询行级权限', - 'methods' => [ - 'post', + 'DeleteSecurityLevel' => [ + 'summary' => 'Deletes a data classification level. Available since 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The delete instruction.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'The sensitivity level of the classification level. If this parameter is not specified, the classification level is deleted based on an exact match of the classification level name.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The classification level name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'DeleteResult' => [ + 'title' => '', + 'description' => 'The deletion result.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '', 'description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => ''], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'E10012011'], + 'RelatedClassifyIdList' => [ + 'title' => '', + 'description' => 'The list of data classification IDs that are associated with the current classification level. This parameter is returned only when this error is triggered.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of data classification IDs that are associated with the current classification level. This parameter is returned only when this error is triggered.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"DeleteResult\\": {\\n \\"Success\\": false,\\n \\"ErrorCode\\": \\"E10012011\\",\\n \\"RelatedClassifyIdList\\": [\\n 1\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Delete a data classification level', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteStandard' => [ + 'summary' => 'Deletes a standard.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -11637,411 +8629,154 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The delete command.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a standard', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteStandardInValidMapping' => [ + 'summary' => 'Deletes invalid mapping relationships.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'PageRowPermissionQuery', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', 'type' => 'object', 'properties' => [ - 'Keyword' => [ - 'title' => '搜索关键字', - 'description' => '', - 'type' => 'string', + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'GuidList' => [ + 'title' => '', + 'description' => 'The list of GUIDs. A maximum of 1000 GUIDs are supported.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of GUIDs. A maximum of 1000 GUIDs are supported.', 'type' => 'string', 'required' => false, 'example' => '1022'], 'required' => false, 'example' => '', ], - 'PageNum' => [ - 'title' => '分页页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + 'BelongGuidList' => [ + 'title' => '', + 'description' => 'The list of parent GUIDs. A maximum of 1000 GUIDs are supported.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of parent GUIDs. A maximum of 1000 GUIDs are supported.', 'type' => 'string', 'required' => false, 'example' => '1023'], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - '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' => '', - ], - ], - ], - ], - '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', - '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' => '', - 'type' => 'any', - 'example' => '', - ], - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000001', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete invalid mapping relationships', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListRowPermissionByUserId' => [ - 'summary' => '分页查询指定用户行级权限', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteStandardLookupTable' => [ + 'summary' => 'Deletes a data standard lookup table. Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -12049,362 +8784,163 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a data standard lookup table', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteStandardRelations' => [ + 'summary' => 'Deletes standard associations in batches.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'ListRowPermissionByUserIdQuery', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', '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', + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'StandardRefList' => [ + 'title' => '', + 'description' => 'The list of referenced standards.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], 'required' => true, - 'example' => '10', + 'example' => '', ], + 'RelationType' => ['title' => '', 'description' => 'The standard association type: RELATIVE.', 'type' => 'string', 'required' => true, 'example' => 'RELATIVE'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'any', - 'example' => '', - ], - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000001', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The deletion result.', + 'type' => 'object', + 'properties' => [ + 'SuccessCount' => ['title' => '', 'description' => 'The number of successfully deleted associations.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'NotExistStandardIdList' => [ + 'title' => '', + 'description' => 'The list of standard IDs that do not exist.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of standard IDs that do not exist.', 'type' => 'integer', 'format' => 'int64', 'example' => '1021'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Batch delete standard associations', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateRowPermission' => [ - 'summary' => '更新行级权限', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteStandardSet' => [ + 'summary' => 'Deletes a standard set.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -12412,381 +8948,204 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a standard set', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteStandardValidMapping' => [ + 'summary' => 'Deletes valid mapping relationships.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'UpdateRowPermissionCommand', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DeleteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The delete instruction.', 'type' => 'object', 'properties' => [ - 'RowPermissionId' => [ - 'title' => '行级权限ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30009999', - ], - 'RowPermissionName' => [ - 'title' => '行级权限名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'RowPermissionDesc' => [ - 'title' => '行级权限描述', - 'description' => '', - 'type' => 'string', + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'GuidList' => [ + 'title' => '', + 'description' => 'The list of GUIDs. A maximum of 1000 GUIDs are supported.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of GUIDs. A maximum of 1000 GUIDs are supported.', 'type' => 'string', 'required' => false, 'example' => '1022'], 'required' => false, 'example' => '', ], - 'MappingColumns' => [ - 'title' => '映射字段', - 'description' => '', + 'BelongGuidList' => [ + 'title' => '', + 'description' => 'The list of parent GUIDs. A maximum of 1000 GUIDs are supported.', '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' => '', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Rules' => [ - 'title' => '规则', - 'description' => '', - 'type' => 'array', - 'items' => [ - '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' => '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' => '', - 'type' => 'any', - 'required' => true, - 'example' => '', - ], - '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' => '', - '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' => '', - '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, + 'items' => ['title' => '', 'description' => 'The list of parent GUIDs. A maximum of 1000 GUIDs are supported.', 'type' => 'string', 'required' => false, 'example' => '1023'], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete valid mapping relationships', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateRowPermission' => [ - 'summary' => '创建行级权限', - 'methods' => [ - 'post', + 'DeleteStandardWordRoot' => [ + 'summary' => 'Deletes a data standard root word.'."\n" + .'Online version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the root word.', 'type' => 'string', 'required' => true, 'example' => '平均值'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a data standard root word', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteUdf' => [ + 'summary' => 'Deletes a user-defined function.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -12794,382 +9153,261 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the user-defined function.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10300010201'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'required' => true, 'example' => '测试'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a user-defined function', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteUserGroup' => [ + 'summary' => 'Deletes a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CreateRowPermissionCommand', - 'in' => 'formData', - 'style' => 'json', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => '232131'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求命令', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - ], - ], - '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' => '', - 'type' => 'any', - 'required' => true, - 'example' => '', - ], - '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' => '', - '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' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The deletion result.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Delete a user group', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ExecuteAdHocTask' => [ + 'summary' => 'Executes an ad hoc query task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ExecuteCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The execution command.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The node script.', 'type' => 'string', 'required' => true, 'example' => 'show tables;'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The runtime parameters.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The runtime parameters.', 'type' => 'object', 'properties' => [ - 'MappingColumnName' => [ - 'title' => '映射字段名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'business_id', - ], - 'ResourceId' => [ - 'title' => '表GUID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'odps.300199897.project_name.table_name', - ], - 'ColumnName' => [ - 'title' => '表字段', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'business_id', - ], + 'Key' => ['title' => '', 'description' => 'The parameter.', 'type' => 'string', 'required' => true, 'example' => 'param1'], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => true, 'example' => 'value1'], ], 'required' => true, + 'example' => '', ], 'required' => false, + 'example' => '', ], + 'OperatorType' => ['title' => '', 'description' => 'The node type.', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123222121'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for a database SQL task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for a database SQL task. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for a database SQL task. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'required' => false, 'example' => 'erp'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ExecuteResult' => [ + 'title' => '', + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327'], + 'SubTaskCount' => ['title' => '', 'description' => 'The number of subtasks split from the parsed task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Execute an ad hoc query task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:19.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateDirectory' => [ - 'summary' => '创建菜单树文件目录', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:ExecuteAdHocTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + ], + 'ExecuteManualNode' => [ + 'summary' => 'Runs a manually scheduled node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13177,159 +9415,115 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ExecuteCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建请求', - 'description' => '', + 'title' => '', + 'description' => 'The request for running a manual task.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tempCode', - ], - 'Name' => [ - 'title' => '新建文件目录名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_xx', - ], - 'Directory' => [ - 'title' => '新建文件目录父目录', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/', + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_12132'], + 'FlowName' => ['title' => '', 'description' => 'The workflow name.', 'type' => 'string', 'example' => 'xx测试', 'required' => false], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123324'], + 'StartBizDate' => ['title' => '', 'description' => 'The start business date.', 'type' => 'string', 'required' => true, 'example' => '2024-05-01'], + 'EndBizDate' => ['title' => '', 'description' => 'The end business date.', 'type' => 'string', 'required' => true, 'example' => '2024-05-07'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The runtime parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The runtime parameters.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The parameter.', 'type' => 'string', 'example' => 'param1', 'required' => false], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'FileId' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1311113211', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'FlowId' => ['title' => '', 'description' => 'The workflow ID.', 'type' => 'string', 'example' => 'f_1231_121324'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"FlowId\\": \\"f_1231_121324\\"\\n}","type":"json"}]', + 'title' => 'Run a manual task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:40:18.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteDirectory' => [ - 'summary' => '删除菜单树文件目录', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:ExecuteManualNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ExecuteTriggerNode' => [ + 'summary' => 'Runs a trigger-based node.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -13337,122 +9531,81 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_12345678'], + ], + [ + 'name' => 'BizDate', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'required' => true, 'example' => '2025-06-01'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12132323', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10110201'], ], [ - 'name' => 'FileId', + 'name' => 'Index', 'in' => 'query', - 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12121111', - ], + 'schema' => ['title' => '', 'description' => 'If the node is an hourly or minutely node, multiple instances are generated per day. This parameter specifies the ordinal number of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment. Valid values:'."\n" + .'- DEV: development environment.'."\n" + .'- PROD: production environment.'."\n" + ."\n" + .'Default value: PROD.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Run a trigger-based node', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateFileName' => [ - 'summary' => '修改菜单树文件名称', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'FixData' => [ + 'summary' => 'Reruns downstream nodes to fix data link issues. Supports forced rerun of downstream nodes. Impact: incurs compute costs and affects data output.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13460,270 +9613,275 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12132323', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FileId', - 'in' => 'query', + 'name' => 'FixDataCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The command to rerun downstream nodes to fix data link issues. You can choose to force a rerun.', + 'type' => 'object', + 'properties' => [ + 'RootInstanceId' => [ + 'title' => '', + 'description' => 'The root instance.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 't_2323111'], + 'FieldInstanceIdList' => [ + 'title' => '', + 'description' => 'The field IDs. This parameter is available when the node is a logical table instance ID. If you do not specify this parameter, the full table is used by default.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'required' => false, 'example' => '121', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'DownStreamInstanceIdList' => [ + 'title' => '', + 'description' => 'The downstream instances. If you have specified a downstream range, you do not need to specify this parameter. Otherwise, you must specify the list of downstream instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 't_2323421', 'title' => ''], + 'FieldInstanceIdList' => [ + 'description' => 'The field instance ID.', + 'type' => 'array', + 'items' => ['description' => 'The field instance ID.', 'type' => 'string', 'required' => false, 'example' => 't_2311', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'ContainRootInstance' => ['title' => '', 'description' => 'Specifies whether to rerun the root instance. If you do not specify this parameter, the default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'DownstreamRange' => ['title' => '', 'description' => 'The downstream range. Valid values:'."\n" + .'- ALL_FAILED_INSTANCE: all failed instances.'."\n" + .'- ALL_INSTANCE: all instances.'."\n" + .'- ALL_FINAL_INSTANCE: all desired state instances.'."\n" + .'- If you do not specify this parameter, the rerun is performed based on the specified downstream instances.', 'type' => 'string', 'required' => false, 'example' => 'ALL_INSTANCE'], + 'ForceRerun' => ['title' => '', 'description' => 'Specifies whether to force a rerun.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '132344'], + ], 'required' => true, - 'example' => '12121111', + 'example' => '', ], ], [ - 'name' => 'Name', + 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'title' => '更改后文件名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxNew', - ], + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'SubmitId' => ['title' => '', 'description' => 'The submit ID of this submission.', 'type' => 'string', 'example' => '12324234'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitId\\": \\"12324234\\"\\n}","type":"json"}]', + 'title' => 'Rerun for data repair', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:10.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateFileDirectory' => [ - 'summary' => '修改菜单树文件所在目录', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:FixData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAccountByRowPermissionId' => [ + 'summary' => 'Retrieves all authorized accounts under a specific row-level permission by row-level permission ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12132323', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12121111', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Directory', - 'in' => 'query', + 'name' => 'GetAccountByRowPermissionIdQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '更改后文件目录', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request command.', + 'type' => 'object', + 'properties' => [ + 'RowPermissionId' => ['title' => '', 'description' => 'The row-level permission ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001234'], + 'RuleIds' => [ + 'description' => 'The row-level permission rule IDs.', + 'type' => 'array', + 'items' => ['description' => 'The row-level permission rule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300001235', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '/xx测试/目录new', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The row-level permission rule IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '300001235', 'title' => ''], + 'UserMappingList' => [ + 'title' => '', + 'description' => 'The accounts associated with the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountType' => [ + 'title' => '', + 'description' => 'The type of the account associated with the rule.', + 'enumValueTitles' => ['PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE'], + 'type' => 'string', + 'example' => 'PERSONAL', + ], + 'Accounts' => [ + 'title' => '', + 'description' => 'The accounts associated with the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '', 'description' => 'The ID of the account associated with the rule.', 'type' => 'string', 'example' => '300901111'], + 'AccountName' => ['title' => '', 'description' => 'The name of the account associated with the rule.', 'type' => 'string', 'example' => '张三'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'enum' => ['PERSONAL', 'PRODUCE', 'USER_GROUP'], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Retrieve all authorized accounts by row-level permission ID', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetDirectoryTree' => [ - 'summary' => '获取文件夹目录树', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'Dataphin公共云', - ], + 'GetAdHocFile' => [ + 'summary' => 'Queries a custom query file in the directory tree.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13731,322 +9889,94 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Category', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '目录名称；'."\n" - ."\n" - .'部分根目录枚举值如下：实时计算表：streamMeta；离线物理表：PhysicalTable；计算任务：codeManage；实时计算模板：streamTemplate；离线计算模板：batchTaskTemplate；资源：resourceManage；FLINK函数：streamFunction；MAXC函数：udfResource；', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'codeManage', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323'], ], [ - 'name' => 'ProjectId', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7081229106458752', - ], + 'schema' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'StringId' => [ - 'title' => '目录StringID', - 'description' => '', - 'type' => 'string', - 'example' => '3', - 'default' => 'null', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7081229106458752', - ], - 'CategoryType' => [ - 'title' => '目录类型', - 'description' => '', - 'type' => 'string', - 'example' => 'codeManage', - ], - 'DataCellId' => [ - 'title' => '数据单元ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '300000907', - ], - 'LastModifierName' => [ - 'title' => '修改人名称'."\n" - ."\n", - 'description' => '', - 'type' => 'string', - 'example' => 'John', - ], - ], - ], - 'Children' => [ - 'title' => '子节点', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '目录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'StringId' => [ - 'title' => '目录StringID', - 'description' => '', - 'type' => 'string', - 'example' => '3', - 'default' => 'null', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7081229106458752', - ], - 'CategoryType' => [ - 'title' => '目录类型', - 'description' => '', - 'type' => 'string', - 'example' => 'codeManage', - ], - 'DataCellId' => [ - 'title' => '数据单元ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '300000907', - ], - 'LastModifierName' => [ - 'title' => '修改人名称'."\n" - ."\n", - 'description' => '', - 'type' => 'string', - 'example' => 'John', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'FileInfo' => [ + 'title' => '', + 'description' => 'The details of the custom query file.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12121111'], + 'Name' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => 'xx测试'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12132323'], + 'Directory' => ['title' => '', 'description' => 'The directory where the file is located.', 'type' => 'string', 'example' => '/xx1/xx2/'], + 'Content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'example' => 'select 1;'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '12121'], + 'LastModifier' => ['title' => '', 'description' => 'The last modifier.', 'type' => 'string', 'example' => '12121'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query a custom query file', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListFiles' => [ - 'summary' => '遍历菜单树目录文件。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAdHocTaskLog' => [ + 'summary' => 'Retrieves the runtime logs of an ad hoc query task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14054,245 +9984,200 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327'], + ], + [ + 'name' => 'SubTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The subtask ID. The value starts from 0.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The offset for querying logs. Increment the value based on the returned result. Set the initial value to 0.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1021'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tempCode', - ], - 'Recursive' => [ - 'title' => '是否递归遍历查询'."\n" - .'true：是， 返回目录下的所有节点'."\n" - .'false：否，返回目录下第一层级节点', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Directory' => [ - 'title' => '文件目录', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/xx/x', - ], - 'Env' => [ - 'title' => '环境标识'."\n" - .'DEV'."\n" - .'PROD', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'LogInfo' => [ + 'title' => '', + 'description' => 'The log details.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327'], + 'SubTaskId' => ['title' => '', 'description' => 'The subtask ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'TaskStatus' => ['title' => '', 'description' => 'The task running status. Example: WAIT_RESOURCE indicates that the task is waiting for resources.', 'type' => 'string', 'example' => 'WAIT_RESOURCE'], + 'HasNext' => ['title' => '', 'description' => 'Indicates whether the next log entry exists.', 'type' => 'boolean', 'example' => ''], + 'HasResult' => ['title' => '', 'description' => 'Indicates whether the current query produces a result.', 'type' => 'boolean', 'example' => ''], + 'NextOffset' => ['title' => '', 'description' => 'The start position of the next log entry.', 'type' => 'integer', 'format' => 'int32', 'example' => '2021'], + 'Content' => ['title' => '', 'description' => 'The runtime log content.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', ], ], - 'required' => true, + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"HasResult\\": false,\\n \\"NextOffset\\": 2021,\\n \\"Content\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve runtime logs of an ad hoc query task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocTaskLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetAdHocTaskResult' => [ + 'summary' => 'Retrieves the task execution result of an ad hoc query.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327'], + ], + [ + 'name' => 'SubTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The subtask ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111231112', - ], - 'Name' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '312112121', - ], - 'Category' => [ - 'title' => '文件类目', - 'description' => '', - 'type' => 'string', - 'example' => 'tempCode', - ], - 'FileType' => [ - 'title' => '文件类型, 如 directory', - 'description' => '', - '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', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ExecuteResult' => [ + 'title' => '', + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'MaxCompute_SQL_300000843_1611548758327'], + 'ScheduleTaskId' => ['title' => '', 'description' => 'The ID of the corresponding scheduling task.', 'type' => 'string', 'example' => 't_2242892326444990464_20210125_2242892326444990465'], + 'Result' => ['title' => '', 'description' => 'The task execution result.', 'type' => 'string', 'example' => '1'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Retrieve task execution result of an ad hoc query', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBizEntityInfoByVersion' => [ - 'summary' => '查询指定版本的业务实体的详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAlertEvent' => [ + 'summary' => 'Retrieves the details of an alert event.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14300,449 +10185,288 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - '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', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], - ], - [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'title' => '版本', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The alert event ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'BizEntityInfo' => [ - 'title' => '新建结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'AlertEventInfo' => [ + 'title' => '', + 'description' => 'The alert event information.', 'type' => 'object', 'properties' => [ - 'BizObject' => [ - 'title' => '业务对象', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The alert event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'AlertObject' => [ + 'title' => '', + 'description' => 'The alert object.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务对象Id', - 'description' => '', - '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', + 'SourceSystemType' => ['title' => '', 'description' => 'The source system type. Valid values:'."\n" + ."\n" + .'- ALL: all systems'."\n" + .'- DQE: data quality'."\n" + .'- OS: data service'."\n" + .'- STREAM: real-time computing'."\n" + .'- VDM_BATCH: batch computing'."\n" + .'- SOP: O&M platform'."\n" + .'- REAL_TIME_PIPELINE: real-time integration'."\n" + .'- KGB: baseline monitoring'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'ALL'], + 'Name' => ['title' => '', 'description' => 'The name of the alert object.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The alerting object type. Valid values:'."\n" + .'- OS_API: API operation'."\n" + .'- OS_APPLICATION_SERVICE: service application'."\n" + .'- STREAM_TASK: real-time computing'."\n" + .'- REAL_TIME_PIPELINE_TASK: real-time integration'."\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: logical table'."\n" + .'- DQE_PHYSICAL_TABLE: physical table'."\n" + .'- DQE_REALTIME_TABLE: real-time metadata table'."\n" + .'- DQE_DATA_SOURCE: data source'."\n" + .'- DQE_INDEX: metric'."\n" + .'- QD_DECISION_INVOKE: QD decision invocation'."\n" + .'- BASELINE: baseline'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'VDM_BATCH_PYTHON37'], + ], + 'example' => '', + ], + 'LatestAlertTime' => ['title' => '', 'description' => 'The time of the latest alert.', 'type' => 'string', 'example' => '2024-11-05 16:19:33'], + 'FirstAlertTime' => ['title' => '', 'description' => 'The time of the first alert.', 'type' => 'string', 'example' => '2024-11-05 16:19:33'], + 'AlertReceiverList' => [ + 'title' => '', + 'description' => 'The list of alert receivers.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The alert receiver.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the alert receiver. Valid values:'."\n" + .'- ON_CALL_TABLE: on-call schedule'."\n" + .'- USER_DEFINED: custom user'."\n" + .'- OWNER: owner.', 'type' => 'string', 'example' => 'OWNER'], + 'AlertChannelTypeList' => [ + 'title' => '', + 'description' => 'The list of alert channel types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert channel type. Valid values:'."\n" + .'- VOICE: phone call'."\n" + .'- SMS: text message'."\n" + .'- MAIL: email'."\n" + .'- DINGTALK_ROBOT: DingTalk chatbot'."\n" + .'- DINGDING: DingTalk work notification'."\n" + .'- CUSTOM: custom message channel'."\n" + .'- WECHAT: WeCom'."\n" + .'- FEISHU: Lark'."\n" + .'- SILENCE: do not send.', 'type' => 'string', 'example' => 'SMS'], + 'example' => '', + ], + 'CustomAlertChannelIdList' => [ + 'title' => '', + 'description' => 'The list of custom alert channel IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The custom alert channel ID.', 'type' => 'string', 'example' => '12345'], + 'example' => '', + ], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of alert users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'Admin'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'OnCallTableName' => ['title' => '', 'description' => 'The name of the on-call schedule.', 'type' => 'string', 'example' => 'test'], ], - 'RefBizEntityIdList' => [ - 'title' => '关联已上线业务实体Id列表', - 'description' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AlertReason' => [ + 'title' => '', + 'description' => 'The alert reason.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the alert reason. Valid values:'."\n" + .'- DQE_COLUMN: field rule exception'."\n" + .'- DQE_DATA_SOURCE: data source rule exception'."\n" + .'- DQE_CUSTOMIZE: custom rule exception'."\n" + .'- DQE_TABLE: table rule exception'."\n" + .'- DQE_REALTIME_TABLE: real-time table rule exception'."\n" + .'- DQE_INDEX: metric rule exception'."\n" + .'- OS_AVG_RESPONSE: average response time exception'."\n" + .'- OS_CALL_TIMES: call count exception'."\n" + .'- OS_ERROR_RATE: error rate exception'."\n" + .'- OS_OFFLINE: Offline percentage exception'."\n" + .'- STREAM_BIZ_DELAY: business delay too high'."\n" + .'- STREAM_DATA_RETENTION: data retention exceeds configuration'."\n" + .'- STREAM_MORE_THAN_FAILURE: failure frequency exceeds configuration'."\n" + .'- STREAM_TPS_OUT_RANGE: TPS out of range'."\n" + .'- STREAM_CHECKPOINT_FAILURE: checkpoint failures exceed configuration'."\n" + .'- STREAM_BACKPRESSURE: backpressure duration exceeds configuration'."\n" + .'- STREAM_JOB_FAILURE: job failure'."\n" + .'- VDM_BATCH_ERROR: error'."\n" + .'- VDM_BATCH_FINISH: completed'."\n" + .'- VDM_BATCH_TIME_OUT: execution timeout'."\n" + .'- VDM_BATCH_UNDONE: incomplete'."\n" + .'- VDM_BATCH_LOGIC_DATA_DELAY: data delay'."\n" + .'- QD_DECISION_CALL_TIMES: decision call count exception'."\n" + .'- QD_DECISION_MAX_RESPONSE: maximum response time exception'."\n" + .'- QD_DECISION_ERROR_RATE: error rate exception'."\n" + .'- QD_DECISION_PARAM_COUNT: decision parameter count exception'."\n" + .'- QD_DECISION_PARAM_PERCENTAGE: decision parameter percentage exception'."\n" + .'- QD_DECISION_PARAM_SUM: decision parameter sum exception'."\n" + .'- QD_DECISION_PARAM_AVG: decision parameter average exception'."\n" + .'- LOGICAL_INSTANCE_GENERATION: logical instance generation monitoring'."\n" + .'- KGB_TASK_ERROR: baseline task error'."\n" + .'- KGB_TASK_SLOW_DOWN: baseline task slowdown'."\n" + .'- KGB_EARLY_WARNING: baseline early warning'."\n" + .'- KGB_BROKEN_LINE: baseline breach'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2024-11-05 16:19:32'], + 'UniqueKey' => ['title' => '', 'description' => 'The unique identifier.', 'type' => 'string', 'example' => 't_6340131422711644160_20241104_6340142'], + 'AlertReasonParamList' => [ + 'title' => '', + 'description' => 'The list of alert reason parameters.', 'type' => 'array', 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '116106', + 'title' => '', + 'description' => 'The alert reason parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The name of the alert reason parameter.', 'type' => 'string', 'example' => 'biz_date'], + 'Value' => ['title' => '', 'description' => 'The value of the alert reason parameter.', 'type' => 'string', 'example' => '2024-11-04 00:00:00'], + ], + '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '221323121212', - ], - 'ApprovalStatus' => [ - 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', - 'description' => '', - 'type' => 'string', - 'example' => 'APPROVING', + 'example' => '', ], ], + 'example' => '', ], - 'BizProcess' => [ - 'title' => '业务活动', - 'description' => '', + 'BelongProject' => [ + 'title' => '', + 'description' => 'The project to which the alert event belongs.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务活动Id', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '116106', - ], - ], - 'BizEventEntityIdList' => [ - 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', - 'description' => '', - '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' => '', - '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' => '', - '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', - ], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.', 'type' => 'string', 'example' => 'project_1'], + 'BizName' => ['title' => '', 'description' => 'The name of the business unit.', 'type' => 'string', 'example' => 'biz_1'], ], + 'example' => '', ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6798087749072704', + 'Status' => ['title' => '', 'description' => 'The alert status. Valid values:'."\n" + .'- ALERTING: Alerting.'."\n" + .'- DO_NOT_DISTURB: Do not disturb.'."\n" + .'- SILENCING: Alerting (cool-down period).'."\n" + .'- FINISH: Alert completed.', 'type' => 'string', 'example' => 'FINISH'], + 'AlertFrequency' => ['title' => '', 'description' => 'The alert frequency. Valid values:'."\n" + .'- ONCE: Instant alert.'."\n" + .'- PERIOD: Periodic alert. Format: 1HOUR, 1MINUTE, 1SECOND.', 'type' => 'string', 'example' => 'ONCE'], + 'TotalAlertTimes' => ['title' => '', 'description' => 'The total number of alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DoNotDisturbEndTime' => ['title' => '', 'description' => 'The expiration time of the do-not-disturb period.', 'type' => 'string', 'example' => '2024-11-05 00:00:00'], + 'UrlConfig' => [ + 'title' => '', + 'description' => 'The URL configuration.', + 'type' => 'object', + 'properties' => [ + 'ObjectUrl' => ['title' => '', 'description' => 'The URL of the alert object page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test1'], + 'LogUrl' => ['title' => '', 'description' => 'The URL of the log page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test2'], + 'AlertConfigUrl' => ['title' => '', 'description' => 'The URL of the alert configuration page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test3'], + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Get alert event details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBizEntityInfo' => [ - 'summary' => '获取业务实体详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAlertEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAssetMappingRelations' => [ + 'summary' => 'Queries mapping relationships by asset object GUID.'."\n" + .'Available since: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -14750,607 +10474,576 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'AssetMappingQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'The query instruction.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset object.', 'type' => 'string', 'required' => true, 'example' => '1121'], + 'AssetType' => ['title' => '', 'description' => 'The object type of the asset. Valid values:'."\n" + .'- COLUMN: field.'."\n" + .'- INDEX: metric.', 'type' => 'string', 'required' => true, 'example' => 'INDEX'], + 'RelationType' => ['title' => '', 'description' => 'The type of the mapping relationship. Valid values:'."\n" + .'- VALID: mapped.'."\n" + .'- INVALID: invalid mapping.', 'type' => 'string', 'required' => true, 'example' => 'VALID'], + ], + 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'Type', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIZ_OBJECT', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error details from the backend response.', 'type' => 'string', 'example' => 'internal error'], + 'MappingRelationList' => [ + 'title' => '', + 'description' => 'The list of mapping relationships.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset.', 'type' => 'string', 'example' => '1122'], + 'Name' => ['title' => '', 'description' => 'The name of the asset.', 'type' => 'string', 'example' => 'test'], + 'AssetType' => ['title' => '', 'description' => 'The Asset Type. Valid values:'."\n" + .'- COLUMN: field.'."\n" + .'- INDEX: metric.', 'type' => 'string', 'example' => 'COLUMN'], + 'StandardId' => ['title' => '', 'description' => 'The ID of the standard.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StandardName' => ['title' => '', 'description' => 'The name of the standard.', 'type' => 'string', 'example' => 'test'], + 'StandardCode' => ['title' => '', 'description' => 'The code of the standard.', 'type' => 'string', 'example' => 'cc'], + 'StandardSetId' => ['title' => '', 'description' => 'The ID of the standard set.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'StandardSetName' => ['title' => '', 'description' => 'The name of the standard set.', 'type' => 'string', 'example' => 'test'], + 'StandardSetDirectory' => ['title' => '', 'description' => 'The folder in which the standard set resides.', 'type' => 'string', 'example' => '/dir1'], + 'StandardStage' => ['title' => '', 'description' => 'The stage of the standard.', 'type' => 'string', 'example' => 'PROD'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query mapping relationships by asset object GUID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetBatchTaskInfo' => [ + 'summary' => 'Retrieves the details of an offline compute node.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID in the directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + ."\n" + .'- dev'."\n" + .'- prod'."\n" + ."\n" + .'Default value: dev.', 'type' => 'string', 'required' => false, 'example' => 'dev'], + ], + [ + 'name' => 'IncludeAllUpStreams', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to include all upstream nodes, including invalid dependencies. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'BizEntityInfo' => [ - 'title' => '业务实体详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'TaskInfo' => [ + 'title' => '', + 'description' => 'The node details.', 'type' => 'object', 'properties' => [ - 'BizObject' => [ - 'title' => '业务对象', - 'description' => '', + 'FileId' => ['title' => '', 'description' => 'The node ID in the directory tree.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '测试任务1'], + 'Status' => ['title' => '', 'description' => 'The submit status. Valid values:'."\n" + ."\n" + .'- 0: draft.'."\n" + .'- 1: submitted.'."\n" + .'- 100: in development.', 'type' => 'string', 'example' => '测试任务1'], + 'Published' => ['title' => '', 'description' => 'Indicates whether the node is published.', 'type' => 'boolean', 'example' => ''], + 'NeedPublish' => ['title' => '', 'description' => 'Indicates whether the node needs to be published.', 'type' => 'boolean', 'example' => ''], + 'HasDevNode' => ['title' => '', 'description' => 'Indicates whether the node has a development environment node.', 'type' => 'boolean', 'example' => ''], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1011_21232132322'], + 'NodeName' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '测试任务1'], + 'NodeOutputNameList' => [ + 'title' => '', + 'description' => 'The list of node output names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The node output name.', 'type' => 'string', 'example' => 'xx测试'], + 'example' => '', + ], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the node owner.', 'type' => 'string', 'example' => '30231123'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the node owner.', 'type' => 'string', 'example' => '张三'], + 'OperatorUserId' => ['title' => '', 'description' => 'The user ID of the current operator.', 'type' => 'string', 'example' => '30231123'], + 'NodeDescription' => ['title' => '', 'description' => 'The node description.', 'type' => 'string', 'example' => 'xx测试'], + 'TaskType' => ['title' => '', 'description' => 'The node type. For more information, refer to the create offline compute node operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '21'], + 'ScheduleType' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- 1: periodic node.'."\n" + .'- 3: manual node.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period. Valid values:'."\n" + ."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY.', 'type' => 'string', 'example' => 'DAILY'], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for automatic scheduling. Refer to the Linux cron expression format.', 'type' => 'string', 'example' => '0 0 1 * * ?'], + 'CustomScheduleConfig' => [ + 'title' => '', + 'description' => 'The custom scheduling interval configuration.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务对象Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1011', - ], - 'Name' => [ - 'title' => '业务对象编码名称', - 'description' => '', - 'type' => 'string', - 'example' => 'create_object_code_name', + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period.', 'type' => 'string', 'example' => 'DAILY'], + 'Interval' => ['title' => '', 'description' => 'The custom interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'IntervalUnit' => ['title' => '', 'description' => 'The interval unit. Valid values:'."\n" + ."\n" + .'- MINUTE'."\n" + .'- HOUR.', 'type' => 'string', 'example' => 'HOUR'], + 'StartTime' => ['title' => '', 'description' => 'The start time in the format of HH:mm.', 'type' => 'string', 'example' => '08:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time in the format of HH:mm.', 'type' => 'string', 'example' => '20:59'], + ], + 'example' => '', + ], + 'Code' => ['title' => '', 'description' => 'The node code.', 'type' => 'string', 'example' => 'show tables;'], + 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => 'test xx'], + 'DagId' => ['title' => '', 'description' => 'The ID of the DAG to which the node belongs.', 'type' => 'string', 'example' => 'dag_102121211'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The list of custom node parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The custom node parameter.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => 'Value'], + 'Key' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'key'], ], - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '116106', + 'example' => '', + ], + 'example' => '', + ], + 'Rerunable' => ['title' => '', 'description' => 'Indicates whether the node can be rerun.', 'type' => 'boolean', 'example' => ''], + 'Priority' => ['title' => '', 'description' => 'The scheduling priority of the node. Valid values: 1 to 9. A larger value indicates a lower priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeStatus' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + ."\n" + .'- 1: Normal.'."\n" + .'- 2: Paused.'."\n" + .'- 3: Dry run.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Paused' => ['title' => '', 'description' => 'Indicates whether the node is paused for scheduling.', 'type' => 'boolean', 'example' => ''], + 'NodeFrom' => ['title' => '', 'description' => 'The node source, indicating the organization or application that created the node.', 'type' => 'string', 'example' => 'openapi'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211'], + 'UpStreamList' => [ + 'title' => '', + 'description' => 'The upstream dependencies.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node association.', + 'type' => 'object', + 'properties' => [ + 'SourceTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'example' => 't_input1'], + 'SourceNodeId' => ['title' => '', 'description' => 'The upstream node ID.', 'type' => 'string', 'example' => 'n_2001'], + 'PeriodDiff' => ['title' => '', 'description' => 'The period difference. A value of 0 indicates a same-period dependency. A positive number indicates a dependency on the previous N periods.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeType' => ['title' => '', 'description' => 'The upstream dependency node type. Valid values:'."\n" + ."\n" + .'- PHYSICAL: physical node.'."\n" + .'- LOGICAL: logical table dependency.', 'type' => 'string', 'example' => 'PHYSICAL'], + 'SourceNodeName' => ['title' => '', 'description' => 'The upstream node name.', 'type' => 'string', 'example' => 't_input1'], + 'DependPeriod' => [ + 'title' => '', + 'description' => 'The dependency period.', + 'type' => 'object', + 'properties' => [ + 'PeriodType' => ['title' => '', 'description' => 'The dependency period type. Valid values:'."\n" + ."\n" + .'- CURRENT_PERIOD'."\n" + .'- LAST_PERIOD'."\n" + .'- LAST_N_PERIOD'."\n" + .'- LAST_24_HOUR.', 'type' => 'string', 'example' => 'CURRENT_PERIOD'], + 'PeriodOffset' => ['title' => '', 'description' => 'The period offset. This parameter is required when PeriodType is set to LAST_N_PERIOD.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + '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' => '', - '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', + 'SourceNodeUserName' => ['title' => '', 'description' => 'The username of the upstream node owner.', 'type' => 'string', 'example' => '张三'], + 'SourceNodeEnabled' => ['title' => '', 'description' => 'Indicates whether the upstream node is enabled.', 'type' => 'boolean', 'example' => ''], + 'SourceNodeOutputName' => ['title' => '', 'description' => 'The output name of the upstream node.', 'type' => 'string', 'example' => 't_input1'], + 'DependStrategy' => ['title' => '', 'description' => 'The dependency strategy. Valid values: ALL, FIRST, LAST, NEAR.', 'type' => 'string', 'example' => 'LAST'], + 'FieldList' => [ + 'title' => '', + 'description' => 'The dependent logical table fields.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The dependent logical table fields.', 'type' => 'string', 'example' => 'column1'], + 'example' => '', ], ], - 'OnlineStatus' => [ - 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', - 'description' => '', - 'type' => 'string', - 'example' => 'SUBMITTED', - ], - 'Status' => [ - 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', - 'description' => '', - 'type' => 'string', - 'example' => 'SUBMITTED', - ], - 'ApprovalId' => [ - 'title' => '审批流程Id', - 'description' => '', - 'type' => 'string', - 'example' => '221323121212', - ], - 'ApprovalStatus' => [ - 'title' => '审批状态: 未提交 INIT、审批中 APPROVING、已通过 AGREE、已拒绝 REJECT、校验失败 FAILED、主动撤回 REVOKE', - 'description' => '', - 'type' => 'string', - 'example' => 'APPROVING', - ], + 'example' => '', ], + 'example' => '', ], - 'BizProcess' => [ - 'title' => '业务活动', - 'description' => '', + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for database SQL nodes.', 'type' => 'string', 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for database SQL nodes. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for database SQL nodes. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'example' => 'erp'], + 'SparkClientInfo' => [ + 'title' => '', + 'description' => 'The Spark client information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务活动Id', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '116106', - ], - ], - 'BizEventEntityIdList' => [ - 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', - 'description' => '', - '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' => '', - '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' => 'SUBMITTED', - ], - 'Status' => [ - 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', - 'description' => '', - 'type' => 'string', - 'example' => 'SUBMITTED', - ], - 'ApprovalId' => [ - 'title' => '审批流程Id', - 'description' => '', - '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', - ], + 'SparkClientVersion' => ['title' => '', 'description' => 'The Spark client version name.', 'type' => 'string', 'example' => 'abc'], ], + 'example' => '', ], - 'Type' => [ - 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', - 'description' => '', - 'type' => 'string', - 'example' => 'BIZ_OBJECT', - ], - 'DataDomainId' => [ - 'title' => '业务活动所属主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20101011', - ], - 'BizUnitId' => [ - 'title' => '业务活动所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6798087749072704', - ], + 'DevelopOwnerId' => ['title' => '', 'description' => 'The user ID of the development owner.', 'type' => 'string', 'example' => '30231123'], + 'DevelopOwnerName' => ['title' => '', 'description' => 'The name of the development owner.', 'type' => 'string', 'example' => '张三'], + 'OpsOwnerId' => ['title' => '', 'description' => 'The user ID of the O&M owner.', 'type' => 'string', 'example' => '30231123'], + 'OpsOwnerName' => ['title' => '', 'description' => 'The name of the O&M owner.', 'type' => 'string', 'example' => '张三'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskInfo\\": {\\n \\"FileId\\": 12113111,\\n \\"Name\\": \\"测试任务1\\",\\n \\"Status\\": \\"测试任务1\\",\\n \\"Published\\": false,\\n \\"NeedPublish\\": false,\\n \\"HasDevNode\\": false,\\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\\": false,\\n \\"Priority\\": 1,\\n \\"NodeStatus\\": 1,\\n \\"Paused\\": false,\\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\\": false,\\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' => 'Get offline compute node details', + 'changeSet' => [ + ['createdAt' => '2025-06-24T11:51:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateBizUnit' => [ - 'summary' => '更新数据板块。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBatchTaskInfoByVersion' => [ + 'summary' => 'Retrieves the details of a specified version of a batch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'icon-environment', - ], - 'BizUnitAccountList' => [ - 'title' => '板块架构师', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '板块架构师', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '20001201', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID in the node directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'TaskInfo' => [ + 'title' => '', + 'description' => 'The node details.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['title' => '', 'description' => 'The node ID in the node directory tree.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '测试任务1'], + 'Status' => ['title' => '', 'description' => 'The publish status. Valid values:'."\n" + .'- 0: draft.'."\n" + .'- 1: submitted.'."\n" + .'- 100: in development.', 'type' => 'string', 'example' => '测试任务1'], + 'Published' => ['title' => '', 'description' => 'Indicates whether the node has been published.', 'type' => 'boolean', 'example' => ''], + 'NeedPublish' => ['title' => '', 'description' => 'Indicates whether the node needs to be published.', 'type' => 'boolean', 'example' => ''], + 'HasDevNode' => ['title' => '', 'description' => 'Indicates whether the node has a development environment node.', 'type' => 'boolean', 'example' => ''], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1011_21232132322'], + 'NodeName' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '测试任务1'], + 'NodeOutputNameList' => [ + 'title' => '', + 'description' => 'The list of node output names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The node output name.', 'type' => 'string', 'example' => 'xx测试'], + 'example' => '', + ], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the node owner.', 'type' => 'string', 'example' => '30231123'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the node owner.', 'type' => 'string', 'example' => '张三'], + 'OperatorUserId' => ['title' => '', 'description' => 'The user ID of the current operator.', 'type' => 'string', 'example' => '30231123'], + 'NodeDescription' => ['title' => '', 'description' => 'The node description.', 'type' => 'string', 'example' => 'xx测试'], + 'TaskType' => ['title' => '', 'description' => 'The node type. For more information, see the API operation for creating a batch task.', 'type' => 'integer', 'format' => 'int32', 'example' => '21'], + 'ScheduleType' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" + .'- 1: periodic node.'."\n" + .'- 3: manual node.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY.', 'type' => 'string', 'example' => 'DAILY'], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for automatic scheduling. For more information, refer to the Linux cron expression syntax.', 'type' => 'string', 'example' => '0 0 1 * * ?'], + 'CustomScheduleConfig' => [ + 'title' => '', + 'description' => 'The custom scheduling interval configuration.', + 'type' => 'object', + 'properties' => [ + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period.', 'type' => 'string', 'example' => 'DAILY'], + 'Interval' => ['title' => '', 'description' => 'The custom interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'IntervalUnit' => ['title' => '', 'description' => 'The interval unit. Valid values: MINUTE, HOUR.', 'type' => 'string', 'example' => 'HOUR'], + 'StartTime' => ['title' => '', 'description' => 'The start time in the format of HH:mm.', 'type' => 'string', 'example' => '08:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time in the format of HH:mm.', 'type' => 'string', 'example' => '20:59'], + ], + 'example' => '', + ], + 'Code' => ['title' => '', 'description' => 'The node code.', 'type' => 'string', 'example' => 'show tables;'], + 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => 'test xx'], + 'DagId' => ['title' => '', 'description' => 'The ID of the DAG to which the node belongs.', 'type' => 'string', 'example' => 'dag_102121211'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The list of custom node parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The custom node parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => 'Value'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Rerunable' => ['title' => '', 'description' => 'Indicates whether the node can be rerun.', 'type' => 'boolean', 'example' => ''], + 'Priority' => ['title' => '', 'description' => 'The scheduling priority of the node. Valid values: 1 to 9. A larger value indicates a lower priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeStatus' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + .'- 1: Normal.'."\n" + .'- 2: Paused.'."\n" + .'- 3: Dry run.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Paused' => ['title' => '', 'description' => 'Indicates whether the node scheduling is paused.', 'type' => 'boolean', 'example' => ''], + 'NodeFrom' => ['title' => '', 'description' => 'The source of the node, indicating the organization or application that created the node.', 'type' => 'string', 'example' => 'openapi'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211'], + 'UpStreamList' => [ + 'title' => '', + 'description' => 'The upstream dependencies.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node association.', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['title' => '', 'description' => 'The type of the upstream dependency node. Valid values:'."\n" + .'- PHYSICAL: physical node.'."\n" + .'- LOGICAL: logical table dependency.', 'type' => 'string', 'example' => 'PHYSICAL'], + 'SourceNodeId' => ['title' => '', 'description' => 'The upstream node ID.', 'type' => 'string', 'example' => 'n_2001'], + 'SourceNodeName' => ['title' => '', 'description' => 'The upstream node name.', 'type' => 'string', 'example' => 't_input1'], + 'SourceNodeUserName' => ['title' => '', 'description' => 'The username of the upstream node owner.', 'type' => 'string', 'example' => '张三'], + 'SourceNodeOutputName' => ['title' => '', 'description' => 'The output name of the upstream node.', 'type' => 'string', 'example' => 't_input1'], + 'SourceTableName' => ['title' => '', 'description' => 'The input table name.', 'type' => 'string', 'example' => 't_input1'], + 'PeriodDiff' => ['title' => '', 'description' => 'The period difference. A value of 0 indicates a same-period dependency. A positive number indicates a dependency on the previous N periods.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'FieldList' => [ + 'title' => '', + 'description' => 'The fields of the dependent logical table.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The fields of the dependent logical table.', 'type' => 'string', 'example' => 'column1'], + 'example' => '', + ], + 'DependPeriod' => [ + 'title' => '', + 'description' => 'The dependency period.', + 'type' => 'object', + 'properties' => [ + 'PeriodType' => ['title' => '', 'description' => 'The dependency period type. Valid values:'."\n" + .'- CURRENT_PERIOD'."\n" + .'- LAST_PERIOD'."\n" + .'- LAST_N_PERIOD'."\n" + .'- LAST_24_HOUR.', 'type' => 'string', 'example' => 'CURRENT_PERIOD'], + 'PeriodOffset' => ['title' => '', 'description' => 'The period offset. This parameter is required when PeriodType is set to LAST_N_PERIOD.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'DependStrategy' => ['title' => '', 'description' => 'The dependency strategy. Valid values: ALL, FIRST, LAST, NEAR.', 'type' => 'string', 'example' => 'LAST'], + 'SourceNodeEnabled' => ['title' => '', 'description' => 'Indicates whether the upstream node is enabled.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for database SQL nodes.', 'type' => 'string', 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for database SQL nodes. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for database SQL nodes. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'example' => 'erp'], + 'SparkClientInfo' => [ + 'title' => '', + 'description' => 'The Spark client information.', + 'type' => 'object', + 'properties' => [ + 'SparkClientVersion' => ['title' => '', 'description' => 'The Spark client version.', 'type' => 'string', 'example' => 'abc'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskInfo\\": {\\n \\"FileId\\": 12113111,\\n \\"Name\\": \\"测试任务1\\",\\n \\"Status\\": \\"测试任务1\\",\\n \\"Published\\": false,\\n \\"NeedPublish\\": false,\\n \\"HasDevNode\\": false,\\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\\": false,\\n \\"Priority\\": 1,\\n \\"NodeStatus\\": 1,\\n \\"Paused\\": false,\\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\\": false\\n }\\n ],\\n \\"DataSourceId\\": \\"12131111\\",\\n \\"DataSourceCatalog\\": \\"mysql_catalog\\",\\n \\"DataSourceSchema\\": \\"erp\\",\\n \\"SparkClientInfo\\": {\\n \\"SparkClientVersion\\": \\"abc\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query batch task details by version', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListBizUnits' => [ - 'summary' => '获取当前租户下的所有数据板块', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskInfoByVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBatchTaskUdfLineages' => [ + 'summary' => 'Obtains the custom lineage of an offline task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15358,214 +11051,195 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID of the task directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. The value OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ - 'title' => '查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'BizUnitList' => [ - 'title' => '数据板块详情', - 'description' => '', + 'LineageGroupList' => [ + 'title' => '', + 'description' => 'The list of lineage groups.', 'type' => 'array', 'items' => [ - 'title' => '数据板块详情', - 'description' => '', + 'title' => '', + 'description' => 'The lineage group.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '数据板块Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30010010', - ], - 'LastModifierName' => [ - 'title' => '最近一次修改人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'Icon' => [ - 'title' => '数据板块图标', - 'description' => '', - 'type' => 'string', - 'example' => 'icon-e-commerce', - ], - 'Env' => [ - 'title' => '环境标识: DEV：开发环境，PROD：生产环境', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'Mode' => [ - 'title' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV_PROD', + 'InputLineageList' => [ + 'title' => '', + 'description' => 'The collection of input lineage tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The lineage table.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 't_input'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the table.', 'type' => 'string', 'example' => 't_input'], + 'Guid' => ['title' => '', 'description' => 'The globally unique ID.', 'type' => 'string', 'example' => 'Guid_101121'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test xx'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the table.', 'type' => 'string', 'example' => '张三'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the table.', 'type' => 'string', 'example' => '20112101'], + 'ProjectName' => ['title' => '', 'description' => 'The project to which the table belongs.', 'type' => 'string', 'example' => 'prj_test'], + 'ProjectId' => ['title' => '', 'description' => 'The project to which the table belongs.', 'type' => 'string', 'example' => '131211211'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'string', 'example' => '103111231'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'xx测试'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values: prod and dev.', 'type' => 'string', 'example' => 'dev'], + 'SubType' => ['title' => '', 'description' => 'The table subtype. For example, dim indicates a dimension logical table.', 'type' => 'string', 'example' => 'dim'], + 'FullTable' => ['title' => '', 'description' => 'Indicates whether the full table is selected.', 'type' => 'boolean', 'example' => ''], + 'ColumnList' => [ + 'title' => '', + 'description' => 'The list of lineage columns.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The lineage column.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The column ID.', 'type' => 'string', 'example' => 'c011'], + 'Name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'example' => 'c011'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'xx'], + 'DataType' => ['title' => '', 'description' => 'The data type.', 'type' => 'string', 'example' => 'varchar'], + 'PartitionKey' => ['title' => '', 'description' => 'Indicates whether the column is a partition key.', 'type' => 'boolean', 'example' => ''], + 'PrimaryKey' => ['title' => '', 'description' => 'Indicates whether the column is a primary key.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], - 'AccountList' => [ - 'title' => '板块架构师', - 'description' => '', + 'OutputLineageList' => [ + 'title' => '', + 'description' => 'The collection of output lineage tables.', 'type' => 'array', 'items' => [ - 'title' => '用户', - 'description' => '', + 'title' => '', + 'description' => 'The lineage table.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '20001201', + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 't_input'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the table.', 'type' => 'string', 'example' => 't_input'], + 'Guid' => ['title' => '', 'description' => 'The globally unique ID.', 'type' => 'string', 'example' => 'Guid_101121'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test xx'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the table.', 'type' => 'string', 'example' => '张三'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the table.', 'type' => 'string', 'example' => '20112101'], + 'ProjectName' => ['title' => '', 'description' => 'The project to which the table belongs.', 'type' => 'string', 'example' => 'prj_test'], + 'ProjectId' => ['title' => '', 'description' => 'The project to which the table belongs.', 'type' => 'string', 'example' => '131211211'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'string', 'example' => '103111231'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'xx测试'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values: prod and dev.', 'type' => 'string', 'example' => 'dev'], + 'SubType' => ['title' => '', 'description' => 'The table subtype. For example, dim indicates a dimension logical table.', 'type' => 'string', 'example' => 'dim'], + 'FullTable' => ['title' => '', 'description' => 'Indicates whether the full table is selected.', 'type' => 'boolean', 'example' => ''], + 'ColumnList' => [ + 'title' => '', + 'description' => 'The list of lineage columns.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The lineage column.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The column ID.', 'type' => 'string', 'example' => 'c011'], + 'Name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'example' => 'c011'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'xx'], + 'DataType' => ['title' => '', 'description' => 'The data type.', 'type' => 'string', 'example' => 'varchar'], + 'PartitionKey' => ['title' => '', 'description' => 'Indicates whether the column is a partition key.', 'type' => 'boolean', 'example' => ''], + 'PrimaryKey' => ['title' => '', 'description' => 'Indicates whether the column is a primary key.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"ColumnList\\": [\\n {\\n \\"Id\\": \\"c011\\",\\n \\"Name\\": \\"c011\\",\\n \\"Description\\": \\"xx\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"PartitionKey\\": false,\\n \\"PrimaryKey\\": false\\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\\": false,\\n \\"ColumnList\\": [\\n {\\n \\"Id\\": \\"c011\\",\\n \\"Name\\": \\"c011\\",\\n \\"Description\\": \\"xx\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"PartitionKey\\": false,\\n \\"PrimaryKey\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Custom Lineage of Offline Computing Tasks', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBizUnitInfo' => [ - 'summary' => '获取数据板块详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskUdfLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBatchTaskVersions' => [ + 'summary' => 'Retrieves the version list of a batch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15573,1152 +11247,923 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '数据板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID in the node directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'BizUnitInfo' => [ - 'title' => '数据板块详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The request result.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '数据板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101001201', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test01', - ], - 'DisplayName' => [ - 'title' => '展示名', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'EnvList' => [ - 'title' => '生产/开发 2个环境对应的板块英文名', - 'description' => '', + 'BatchTaskVersionList' => [ + 'title' => '', + 'description' => 'The list of batch task versions.', 'type' => 'array', 'items' => [ - 'title' => '生产/开发 2个环境对应的板块英文名', - 'description' => '', + 'title' => '', + 'description' => 'The batch task version.', 'type' => 'object', 'properties' => [ - 'EnvName' => [ - 'title' => '环境标识: PROD / DEV', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV_PROD', - ], - 'AccountList' => [ - 'title' => '板块架构师', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '20001201', - ], - ], - ], - ], - 'BusinessLeaderList' => [ - 'title' => '业务负责人', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '20001201', - ], - ], - ], - ], - 'DataLeaderList' => [ - 'title' => '数据负责人', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用户', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '20001201', - ], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_10231001'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'example' => '1'], + 'UserId' => ['title' => '', 'description' => 'The ID of the user who submitted the version.', 'type' => 'string', 'example' => '20110110'], + 'UserName' => ['title' => '', 'description' => 'The ID of the user who submitted the version.', 'type' => 'string', 'example' => '张三'], + 'Comment' => ['title' => '', 'description' => 'The comment for the submission.', 'type' => 'string', 'example' => 'test'], + 'Published' => ['title' => '', 'description' => 'Indicates whether the version has been published to the production environment.', 'type' => 'boolean', 'example' => ''], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10232111011'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:10:10'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:10:10'], ], + 'example' => '', ], - ], - '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', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'Retrieve batch task version list', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteBizUnit' => [ - 'summary' => '删除数据板块。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBatchTemplateVersions' => [ + 'summary' => 'Retrieves the version list of a specified offline template ID. Online version: v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '6798087749072704', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1001'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment. Valid values:'."\n" + ."\n" + .'- DEV: development environment.'."\n" + .'- PROD: production environment.'."\n" + ."\n" + .'Default value for dev_prod projects: DEV.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'TemplateVersionList' => [ + 'title' => '', + 'description' => 'The template version list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID, which is the same as the menu tree node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '数据处理模板'], + 'OperatorType' => ['title' => '', 'description' => 'The template operator type. Valid values:'."\n" + ."\n" + .'- 10: Shell.'."\n" + .'- 21: Python.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Engine' => ['title' => '', 'description' => 'The version of the compute engine. Currently supported Python versions: Python 2.7 and Python 3.7.', 'type' => 'string', 'example' => 'Python 3.7'], + 'Content' => ['title' => '', 'description' => 'The template content.', 'type' => 'string', 'example' => '#!/bin/bash'."\n" + .'echo \'hello world\''], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'The template status. Valid values:'."\n" + ."\n" + .'- 0: draft.'."\n" + .'- 2: submitted.'."\n" + .'- 100: in development.', 'type' => 'string', 'example' => '2'], + 'Description' => ['title' => '', 'description' => 'The template description.', 'type' => 'string', 'example' => '用于数据处理的Shell模板'], + 'Owner' => ['title' => '', 'description' => 'The template owner.', 'type' => 'string', 'example' => '张三'], + 'OwnerId' => ['title' => '', 'description' => 'The template owner ID.', 'type' => 'string', 'example' => '100001'], + 'Comment' => ['title' => '', 'description' => 'The template submit comment.', 'type' => 'string', 'example' => '初始化提交'], + 'Modifier' => ['title' => '', 'description' => 'The last modifier of the template.', 'type' => 'string', 'example' => '李四'], + 'ModifierId' => ['title' => '', 'description' => 'The ID of the last modifier of the template.', 'type' => 'string', 'example' => '100002'], + 'GmtCreate' => ['title' => '', 'description' => 'The template creation time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2026-01-01 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The template modification time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2026-05-28 15:30:00'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve version list of a specified offline template ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"TemplateVersionList\\": [\\n {\\n \\"Id\\": 1001,\\n \\"ProjectId\\": 123456,\\n \\"Name\\": \\"数据处理模板\\",\\n \\"OperatorType\\": 10,\\n \\"Engine\\": \\"Python 3.7\\",\\n \\"Content\\": \\"#!/bin/bash\\\\necho \'hello world\'\\",\\n \\"Version\\": 1,\\n \\"Status\\": \\"2\\",\\n \\"Description\\": \\"用于数据处理的Shell模板\\",\\n \\"Owner\\": \\"张三\\",\\n \\"OwnerId\\": \\"100001\\",\\n \\"Comment\\": \\"初始化提交\\",\\n \\"Modifier\\": \\"李四\\",\\n \\"ModifierId\\": \\"100002\\",\\n \\"GmtCreate\\": \\"2026-01-01 10:00:00\\",\\n \\"GmtModified\\": \\"2026-05-28 15:30:00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'CreateBizUnit' => [ - 'summary' => '创建数据板块。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetBelongAssetMapping' => [ + 'summary' => 'Query mapping relationships by belonging asset GUID.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'AssetMappingQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建请求', - 'description' => '', + 'title' => '', + 'description' => 'Query command.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_code_name', - ], - 'DisplayName' => [ - 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_name', - ], - 'Description' => [ - 'title' => '业务对象描述信息，128字符以内', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'icon-environment', - ], - 'Mode' => [ - 'title' => '生产模式：单环境模式 BASIC、开发/生产双环境模式 DEV_PROD', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV_PROD', - ], - 'BizUnitAccountList' => [ - 'title' => '板块架构师', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '板块架构师', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '20001201', - ], - ], - 'required' => true, - ], - 'required' => true, - ], + 'BelongGuid' => ['title' => '', 'description' => 'The GUID of the belonging asset.', 'type' => 'string', 'required' => true, 'example' => '1121'], + 'RelationType' => ['title' => '', 'description' => 'The mapping relationship type. Valid values: VALID (mapped) and INVALID (invalid mapping).', 'type' => 'string', 'required' => false, 'example' => 'VALID'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '新建结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BizUnitId' => [ - 'title' => '新建的数据板块ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '545844456', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'MappingRelationList' => [ + 'title' => '', + 'description' => 'The list of mapping relationships.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the asset.', 'type' => 'string', 'example' => '1122'], + 'Name' => ['title' => '', 'description' => 'The name of the asset.', 'type' => 'string', 'example' => 'test'], + 'AssetType' => ['title' => '', 'description' => 'The type of the asset. Valid values: COLUMN (field) and INDEX (metric).', 'type' => 'string', 'example' => 'COLUMN'], + 'StandardId' => ['title' => '', 'description' => 'The ID of the standard.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StandardName' => ['title' => '', 'description' => 'The name of the standard.', 'type' => 'string', 'example' => 'test'], + 'StandardCode' => ['title' => '', 'description' => 'The code of the standard.', 'type' => 'string', 'example' => 'cc'], + 'StandardSetId' => ['title' => '', 'description' => 'The ID of the standard set.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'StandardSetName' => ['title' => '', 'description' => 'The name of the standard set.', 'type' => 'string', 'example' => 'test'], + 'StandardSetDirectory' => ['title' => '', 'description' => 'The directory where the standard set is located.', 'type' => 'string', 'example' => '/dir1'], + 'StandardStage' => ['title' => '', 'description' => 'The stage of the standard.', 'type' => 'string', 'example' => 'PROD'], + ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query mapping relationships by belonging asset GUID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateBizEntity' => [ - 'summary' => '更新业务实体、', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetBizEntityInfo' => [ + 'summary' => 'Retrieves the details of a business entity.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business entity type. For more information, refer to the create business entity operation.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '变更请求', - 'description' => '', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务实体Id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20101011', - ], - 'BizUnitId' => [ - 'title' => '业务活动所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '6798087749072704', - ], - 'BizObject' => [ - 'title' => '业务对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_code_name', - ], - 'DisplayName' => [ - 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_name', - ], - 'Description' => [ - 'title' => '业务对象描述信息，128字符以内', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'OwnerUserId' => [ - 'title' => '业务对象负责人用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30010010', - ], - 'ParentId' => [ - 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '116306', - ], - 'RefBizEntityIdList' => [ - 'title' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '116106', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'BizProcess' => [ - 'title' => '业务活动', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'BizEntityInfo' => [ + 'title' => '', + 'description' => 'The business entity details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_process_code_name', - ], - 'DisplayName' => [ - 'title' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_process_name', - ], - 'Description' => [ - 'title' => '业务活动描述信息，128字符以内', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'OwnerUserId' => [ - 'title' => '业务活动负责人用户Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30010010', - ], - 'RefBizEntityIdList' => [ - 'title' => '关联已上线业务实体Id列表, 若不填写: 原有的值会被清空', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '116106', - ], - 'required' => false, - ], - 'BizEventEntityIdList' => [ - 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '业务流程活动包含的业务事件活动', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1016106', + 'BizObject' => [ + 'title' => '', + 'description' => 'The business object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The business object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + 'Name' => ['title' => '', 'description' => 'The code name of the business object.', 'type' => 'string', 'example' => 'create_object_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business object.', 'type' => 'string', 'example' => 'create_object_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'Type' => ['title' => '', 'description' => 'The object type of the business object. For more information, refer to the create business entity operation.', 'type' => 'string', 'example' => 'NORMAL'], + 'ParentId' => ['title' => '', 'description' => 'The parent entity that the business object inherits from. Only common business objects support inheritance, and the parent entity must be a published business object.', 'type' => 'integer', 'format' => 'int64', 'example' => '116306'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated published business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated published business entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '116106'], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business object.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business object.', 'type' => 'string', 'example' => '张三'], + 'RefDimTableCount' => ['title' => '', 'description' => 'The number of associated logical dimension tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RefSummaryTableCount' => ['title' => '', 'description' => 'The number of associated aggregate tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ChildBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of child business objects of the business object.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The child business object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1015'], + 'example' => '', + ], + 'OnlineStatus' => ['title' => '', 'description' => 'The publish status. Valid values: '."\n" + .'- SUBMITTED: Not published.'."\n" + .'- APPROVING: Pending approval.'."\n" + .'- PUBLISHED: Published.'."\n" + .'- REJECT: Publish failed.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- DRAFT: Draft or not published.'."\n" + .'- SUBMITTING: Submitting.'."\n" + .'- SUBMITTED: Submitted.'."\n" + .'- DEVELOPING: Developing.'."\n" + .'- PUBLISHING: Publishing.'."\n" + .'- PUBLISHED: Published.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'ApprovalId' => ['title' => '', 'description' => 'The approval flow ID.', 'type' => 'string', 'example' => '221323121212'], + 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" + .'- INIT: Not submitted.'."\n" + .'- APPROVING: Pending approval.'."\n" + .'- AGREE: Approved.'."\n" + .'- REJECT: Rejected.'."\n" + .'- FAILED: Validation failed.'."\n" + .'- REVOKE: Withdrawn.', 'type' => 'string', 'example' => 'APPROVING'], ], - 'required' => false, + 'example' => '', ], - 'PreBizProcessIdList' => [ - 'title' => '业务流程活动的前序业务流程活动', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '业务流程活动的前序业务流程活动', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1016106', + 'BizProcess' => [ + 'title' => '', + 'description' => 'The business process.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The business process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + 'Name' => ['title' => '', 'description' => 'The name of the business process.', 'type' => 'string', 'example' => 'create_process_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business process.', 'type' => 'string', 'example' => '业务活动测试'], + 'Description' => ['title' => '', 'description' => 'The description of the business process.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'Type' => ['title' => '', 'description' => 'The type of the business process. For more information, refer to the create business entity operation.', 'type' => 'string', 'example' => 'BIZ_EVENT'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated published business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated published business entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '116106'], + 'example' => '', + ], + 'BizEventEntityIdList' => [ + 'title' => '', + 'description' => 'The list of business event activity IDs contained in the business flow activity. This parameter is valid only when the entity is a business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business event activity contained in the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106'], + 'example' => '', + ], + 'PreBizProcessIdList' => [ + 'title' => '', + 'description' => 'The preceding business flow activities of the business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The preceding business flow activities of the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106'], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business object.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business object.', 'type' => 'string', 'example' => '张三'], + 'HasDependent' => ['title' => '', 'description' => 'Indicates whether the business process is depended on by other entities.', 'type' => 'boolean', 'example' => ''], + 'OnlineStatus' => ['title' => '', 'description' => 'The publish status. Valid values: '."\n" + .'- SUBMITTED: Not published.'."\n" + .'- APPROVING: Pending approval.'."\n" + .'- PUBLISHED: Published.'."\n" + .'- REJECT: Publish failed.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- DRAFT: Draft or not published.'."\n" + .'- SUBMITTING: Submitting.'."\n" + .'- SUBMITTED: Submitted.'."\n" + .'- DEVELOPING: Developing.'."\n" + .'- PUBLISHING: Publishing.'."\n" + .'- PUBLISHED: Published.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'ApprovalId' => ['title' => '', 'description' => 'The approval flow ID.', 'type' => 'string', 'example' => '221323121212'], + 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" + .'- INIT: Not submitted.'."\n" + .'- APPROVING: Pending approval.'."\n" + .'- AGREE: Approved.'."\n" + .'- REJECT: Rejected.'."\n" + .'- FAILED: Validation failed.'."\n" + .'- REVOKE: Withdrawn.', 'type' => 'string', 'example' => 'APPROVING'], + 'RefFactTableCount' => ['title' => '', 'description' => 'The number of associated fact tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], - 'required' => false, + 'example' => '', ], + 'Type' => ['title' => '', 'description' => 'The business entity type. For more information, refer to the create business entity operation.', 'type' => 'string', 'example' => 'BIZ_OBJECT'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704'], ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'Get business entity details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'OnlineBizEntity' => [ - 'summary' => '上线业务实体。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizEntityInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBizEntityInfoByVersion' => [ + 'summary' => 'Queries the details of a business entity of a specified version.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], - 'Comment' => [ - 'title' => '下线备注', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - 'required' => true, - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business type. Valid values: BIZ_OBJECT and BIZ_PROCESS.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The business entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'BizEntityInfo' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'BizObject' => [ + 'title' => '', + 'description' => 'The business object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The business object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + 'Name' => ['title' => '', 'description' => 'The code name of the business object.', 'type' => 'string', 'example' => 'create_object_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business object.', 'type' => 'string', 'example' => 'create_object_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'Type' => ['title' => '', 'description' => 'The object type of the business object. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => 'NORMAL'], + 'ParentId' => ['title' => '', 'description' => 'The parent entity that the business object inherits from. Only common business objects support inheritance, and the parent entity must be online.', 'type' => 'integer', 'format' => 'int64', 'example' => '116306'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated online business entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '116106'], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business object.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business object.', 'type' => 'string', 'example' => '张三'], + 'RefDimTableCount' => ['title' => '', 'description' => 'The number of associated logical dimension tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RefSummaryTableCount' => ['title' => '', 'description' => 'The number of associated aggregate tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ChildBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of child business objects of the business object.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The child business object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1015'], + 'example' => '', + ], + 'OnlineStatus' => ['title' => '', 'description' => 'The online status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'The status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => '100'], + 'ApprovalId' => ['title' => '', 'description' => 'The approval flow ID.', 'type' => 'string', 'example' => '221323121212'], + 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => 'APPROVING'], + ], + 'example' => '', + ], + 'BizProcess' => [ + 'title' => '', + 'description' => 'The business process.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The business process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + 'Name' => ['title' => '', 'description' => 'The name of the business process.', 'type' => 'string', 'example' => 'create_process_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business process.', 'type' => 'string', 'example' => '业务活动测试'], + 'Description' => ['title' => '', 'description' => 'The description of the business process.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'Type' => ['title' => '', 'description' => 'The type of the business process. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => 'BIZ_EVENT'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated online business entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '116106'], + 'example' => '', + ], + 'BizEventEntityIdList' => [ + 'title' => '', + 'description' => 'The list of business event activity IDs contained in the business flow activity. This parameter is valid only when the type is a business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business event activity contained in the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106'], + 'example' => '', + ], + 'PreBizProcessIdList' => [ + 'title' => '', + 'description' => 'The preceding business flow activities of the business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The preceding business flow activities of the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1016106'], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business object.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business object.', 'type' => 'string', 'example' => '张三'], + 'HasDependent' => ['title' => '', 'description' => 'Indicates whether the business process is depended on by other entities.', 'type' => 'boolean', 'example' => ''], + 'OnlineStatus' => ['title' => '', 'description' => 'The online status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'The status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => '100'], + 'ApprovalId' => ['title' => '', 'description' => 'The approval flow ID.', 'type' => 'string', 'example' => '221323121212'], + 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => 'APPROVING'], + 'RefFactTableCount' => ['title' => '', 'description' => 'The number of associated fact tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'Type' => ['title' => '', 'description' => 'The type of the business entity. For more information, refer to the query business entity details operation.', 'type' => 'string', 'example' => 'BIZ_OBJECT'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the subject domain to which the entity belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID of the business object.', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'Query business entity details by version', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:38:06.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'OfflineBizEntity' => [ - 'summary' => '下线业务实体、', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizEntityInfoByVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetBizMetricByName' => [ + 'summary' => 'Query business metric details by name.'."\n" + .'Release version: v5.5.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'OfflineCommand', + 'name' => 'BizMetricByNameQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '下线请求', - 'description' => '', + 'title' => '', + 'description' => 'Query request.', 'type' => 'object', 'properties' => [ - 'BizUnitId' => [ - 'title' => '所属业务板块Id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], - 'Comment' => [ - 'title' => '下线备注', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'Name' => ['title' => '', 'description' => 'The name of the business metric.', 'type' => 'string', 'required' => true, 'example' => 'Metric1'], + 'Draft' => ['title' => '', 'description' => 'Specifies whether to query draft or published asset details. Set this parameter to True to query draft details, or False to query published details.', 'type' => 'boolean', 'required' => true, 'example' => 'True'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Data' => [ + 'title' => '', + 'description' => 'The details of the business metric.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30001011'], + 'Guid' => ['title' => '', 'description' => 'The GUID of the business metric.', 'type' => 'string', 'example' => 'guid'], + 'Name' => ['title' => '', 'description' => 'The name of the business metric.', 'type' => 'string', 'example' => 'Metric1'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'Metric Display Name'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'Metric Desc'], + 'Labels' => [ + 'title' => '', + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The label.', 'type' => 'string', 'example' => 'Label'], + 'example' => '', + ], + 'Catalogs' => [ + 'title' => '', + 'description' => 'The list of affiliated catalogs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the affiliated catalog of the metric.', + 'type' => 'object', + 'properties' => [ + 'TopicId' => ['title' => '', 'description' => 'The topic ID to which the catalog belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '43297700'], + 'TopicName' => ['title' => '', 'description' => 'The topic name to which the catalog belongs.', 'type' => 'string', 'example' => 'test topic'], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1561740764851842'], + 'CatalogName' => ['title' => '', 'description' => 'The catalog name.', 'type' => 'string', 'example' => 'test catalog'], + 'CatalogDesc' => ['title' => '', 'description' => 'The catalog description.', 'type' => 'string', 'example' => 'catalog desc'], + 'ParentCatalogId' => ['title' => '', 'description' => 'The parent catalog ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1561740764851841'], + 'ParentPath' => ['title' => '', 'description' => 'The parent path of the catalog.', 'type' => 'string', 'example' => '/catalog1/'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'BizOwnerName' => ['title' => '', 'description' => 'The name of the business owner.', 'type' => 'string', 'example' => 'SuperAdmin'], + 'MetricDefinition' => ['title' => '', 'description' => 'The metric definition.', 'type' => 'string', 'example' => '[Metric1]+[Metric2]'], + 'RelatedBizMetrics' => [ + 'title' => '', + 'description' => 'The list of related business metrics.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of the related business metric.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'The GUID.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'Metric2'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'display name'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'desc'], + 'RelationType' => ['title' => '', 'description' => 'The relation type. Valid values: POSITIVE (positive correlation), NEGATIVE (negative correlation), and OTHER (other).', 'type' => 'string', 'example' => 'POSITIVE'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AssociatedTechMetrics' => [ + 'title' => '', + 'description' => 'The list of associated technical metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the associated technical metric.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'The GUID.', 'type' => 'string', 'example' => 'table1.a.b'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'metric3'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'display name'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'desc'], + 'SubType' => ['title' => '', 'description' => 'The type of the technical metric. Valid values: INDEX (modeling metric) and CUSTOM_INDEX (custom metric).', 'type' => 'string', 'example' => 'CUSTOM_INDEX'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'MetricRelationDiagramSwitchOpen' => ['title' => '', 'description' => 'Indicates whether the metric relation diagram is enabled. A value of true indicates that the diagram is enabled. A value of false indicates that the diagram is disabled.', 'type' => 'boolean', 'example' => 'true'], + 'MetricRelationDiagramExpression' => ['title' => '', 'description' => 'The expression of the metric relation diagram.', 'type' => 'string', 'example' => '[Metric2]*10'], + 'OperateInstructionEnabled' => ['title' => '', 'description' => 'Indicates whether the operation instruction is enabled. A value of true indicates that the operation instruction is enabled. A value of false indicates that the operation instruction is disabled.', 'type' => 'boolean', 'example' => 'true'], + 'OperateInstructionContent' => ['title' => '', 'description' => 'The text content of the operation instruction.', 'type' => 'string', 'example' => 'content'], + 'ViewScope' => [ + 'title' => '', + 'description' => 'The view scope.', + 'type' => 'object', + 'properties' => [ + 'ScopeType' => [ + 'title' => '', + 'description' => 'The type of view scope. Valid values: ALL_USERS_CAN_VIEW (visible to all users), PART_USERS_CAN_VIEW (visible to specific users), and PART_USERS_CAN_NOT_VIEW (invisible to specific users).', + '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' => 'The usernames of individual accounts. This parameter is valid only when the view scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW.', + 'type' => 'array', + 'items' => ['description' => 'The username of the individual account.', 'type' => 'string', 'example' => 'SuperAdmin', 'title' => ''], + 'example' => '', + ], + 'UserGroupNames' => [ + 'title' => '', + 'description' => 'The names of user groups. This parameter takes effect only when the view scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW.', + 'type' => 'array', + 'items' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'UserGroup1', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'CustomAttribute' => [ + 'title' => '', + 'description' => 'The list of custom attributes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom attribute item.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The code of the custom attribute.', 'type' => 'string', 'example' => 'CustomAttributeCode'], + 'Values' => [ + 'title' => '', + 'description' => 'The list of attribute values. 1. For custom input and single-select dropdown attributes, the first value in the list is used. 2. For multi-select dropdown attributes, all values in the list are used. 3. For hyperlink attributes, the first value is the display text and the second value is the link URL.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The custom attribute value.', 'type' => 'string', 'example' => 'CustomAttributeValue'], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query business metric details by name', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListBizEntities' => [ - 'summary' => '查询业务实体列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetBizUnitInfo' => [ + 'summary' => 'Retrieves the details of a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16726,431 +12171,161 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询请求', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'Keyword' => [ - 'title' => '搜索关键字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'object_', - ], - 'Page' => [ - 'title' => '页码, 默认 1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认 10', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'FilterCriteria' => [ - 'title' => '查询过滤条件', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'BizUnitInfo' => [ + 'title' => '', + 'description' => 'The details of the data domain.', 'type' => 'object', 'properties' => [ - 'BizUnitIdList' => [ - 'title' => '所属业务板块', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101001201'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'test01'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => '测试'], + 'EnvList' => [ + 'title' => '', + 'description' => 'The English names of the data domain for the two environments: production and development.', 'type' => 'array', 'items' => [ - 'title' => '所属业务板块', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '102323411', + 'title' => '', + 'description' => 'The English names of the data domain for the two environments: production and development.', + 'type' => 'object', + 'properties' => [ + 'EnvName' => ['title' => '', 'description' => 'The environment identifier. Valid values: PROD and DEV.', 'type' => 'string', 'example' => 'DEV'], + 'Name' => ['title' => '', 'description' => 'The English name.', 'type' => 'string', 'example' => 'LD_test001_dev'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => '测试数据板块001_开发'], + ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], - 'BizUnitNameList' => [ - 'title' => '所属业务板块', - 'description' => '', + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the data domain.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the data domain.', 'type' => 'string', 'example' => '张三'], + 'Icon' => ['title' => '', 'description' => 'The icon of the data domain.', 'type' => 'string', 'example' => 'icon-e-commerce'], + 'Mode' => ['title' => '', 'description' => 'The production mode. Valid values:'."\n" + .'- BASIC: single-environment mode.'."\n" + .'- DEV_PROD: development/production dual-environment mode.', 'type' => 'string', 'example' => 'DEV_PROD'], + 'AccountList' => [ + 'title' => '', + 'description' => 'The architects of the data domain.', 'type' => 'array', 'items' => [ - 'title' => '所属业务板块', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '测试', + 'title' => '', + 'description' => 'The user.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '20001201'], + ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '所属负责人Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30001326', - ], - 'required' => false, - ], - 'HasTableRef' => [ - 'title' => '是否有逻辑表关联', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'StatusList' => [ - 'title' => '业务实体状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', - 'description' => '', + 'BusinessLeaderList' => [ + 'title' => '', + 'description' => 'The business owners.', 'type' => 'array', 'items' => [ - 'title' => '业务实体状态', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PUBLISHED', + 'title' => '', + 'description' => 'The user.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '20001201'], + ], + 'example' => '', ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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', + 'example' => '', ], - 'BizEntityList' => [ - 'title' => '业务实体列表', - 'description' => '', + 'DataLeaderList' => [ + 'title' => '', + 'description' => 'The data owners.', 'type' => 'array', 'items' => [ - 'title' => '业务实体', - 'description' => '', + 'title' => '', + 'description' => 'The user.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '业务实体Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'BIZ_OBJECT', - ], - 'SubType' => [ - 'title' => '业务实体细分类型', - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'DataDomainId' => [ - 'title' => '业务活动所属主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20101011', - ], - 'BizUnitId' => [ - 'title' => '业务活动所属业务板块Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30010010', - ], - 'LastModifierName' => [ - 'title' => '最近一次修改人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'OnlineStatus' => [ - 'title' => '上线状态: 未上线 SUBMITTED、审批中 APPROVING、已上线 PUBLISHED、上线失败 REJECT', - 'description' => '', - 'type' => 'string', - 'example' => 'SUBMITTED', - ], - 'Status' => [ - 'title' => '状态: 草稿态/未上线 DRAFT、提交中 SUBMITTING、已提交 SUBMITTED、开发中 DEVELOPING、发布中 PUBLISHING、已发布 PUBLISHED', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11023', - ], - ], - 'BelongToBizEntityIdList' => [ - 'title' => '被从属的业务流程, 当前类型是业务活动时有效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11023', - ], - ], - 'ChildBizEntityIdList' => [ - 'title' => '子业务对象Id列表, 当前类型是业务对象时有效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11023', - ], - ], - 'SuffixBizEntityIdList' => [ - 'title' => '后续业务流程, 当前类型是业务活动时有效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11023', - ], - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '20001201'], ], + 'example' => '', ], + 'example' => '', ], + 'DataDomainCount' => ['title' => '', 'description' => 'The number of subject domains.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BizObjectCount' => ['title' => '', 'description' => 'The number of business objects.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BizProcessCount' => ['title' => '', 'description' => 'The number of business activities.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query data domain details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateBizEntity' => [ - 'summary' => '创建业务实体。', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizUnitInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetCatalogAssetDetails' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -17158,462 +12333,558 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'GetCatalogAssetDetailsQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建请求', - 'description' => '', + 'title' => '', + 'description' => 'The paging query for the listing asset catalog list.', 'type' => 'object', 'properties' => [ - 'BizObject' => [ - 'title' => '业务对象', - 'description' => '', + 'Guid' => ['title' => '', 'description' => 'The asset GUID.', 'type' => 'string', 'required' => true, 'example' => 'dp_ds_table.300023201.7311626611751680256.load_test.abc'], + 'IncludeDetailedAttributes' => ['title' => '', 'description' => 'Specifies whether to include detailed data. Default value: false. Valid values:'."\n" + .'- false: Not included.'."\n" + .'- true: Included.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'IncludeColumns' => ['title' => '', 'description' => 'Specifies whether to include the field list. Default value: false. Valid values:'."\n" + .'- false: Not included.'."\n" + .'- true: Included.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The data catalog asset details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '业务对象编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_code_name', - ], - 'DisplayName' => [ - 'title' => '业务对象名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_object_name', - ], - 'Description' => [ - 'title' => '业务对象描述信息，128字符以内', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'OwnerUserId' => [ - 'title' => '业务对象负责人用户Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30010010', - ], - 'Type' => [ - 'title' => '业务对象类型：普通对象 NORMAL、枚举对象 ENUM、虚拟对象 VIRTUAL、层级对象 HIERARCHY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NORMAL', + 'Guid' => ['title' => '', 'description' => 'The asset GUID, which serves as the unique identifier of the asset.', 'type' => 'string', 'example' => 'dp_ds_table.300023201.7311626611751680256.load_test.abc'], + 'AssetType' => ['title' => '', 'description' => 'The asset type. Valid values: TABLE (table, including views and materialized views), INDEX (technical metric), BIZ_INDEX (business metric), API, and PAGE (dashboard).', 'type' => 'string', 'example' => 'TABLE'], + 'IsDeleted' => ['title' => '', 'description' => 'Indicates whether the asset is deleted.', 'type' => 'boolean', 'example' => ''], + 'AssetName' => ['title' => '', 'description' => 'The asset name.', 'type' => 'string', 'example' => 'abc'], + 'AssetDisplayName' => ['title' => '', 'description' => 'The asset display name. Returned when the asset type is TABLE, INDEX, or BIZ_INDEX.', 'type' => 'string', 'example' => 'abc表'], + 'AssetFullName' => ['title' => '', 'description' => 'The full name of the asset. Returned when the asset type is TABLE or INDEX.', 'type' => 'string', 'example' => 'dwd_all.abc'], + 'MaxSecurityLevel' => ['title' => '', 'description' => 'The highest sensitivity level. Returned when the asset type is TABLE.', 'type' => 'string', 'example' => 'L3'], + 'AssetTags' => [ + 'title' => '', + 'description' => 'The asset tags.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The asset tags.', 'type' => 'string', 'example' => '["标签1", "标签2"]'], + 'example' => '', ], - 'ParentId' => [ - 'title' => '业务对象继承实体信息，仅支持普通业务对象配置继承实体，且只能继承已上线的业务对象', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '116306', + 'AssetDescription' => ['title' => '', 'description' => 'The asset description.', 'type' => 'string', 'example' => 'abc'], + 'AssetFrom' => ['title' => '', 'description' => 'The asset source. For TABLE (physical table), the value is in the format of "Dataphin-Workspace Type-Project Chinese Name (Project English Name)". For TABLE (logical table), the value is in the format of "Dataphin-Workspace Type-Data Domain Chinese Name (Data Domain English Name)". For TABLE (data source table), the value is in the format of "Source System Name-Data Source Name-Database/Schema Name". For INDEX (standard modeling metric), the value is the asset source of the associated aggregate table. For INDEX (custom metric), the value is the asset source of the source table. For API, the value is the data service project name. For PAGE, the value is the application system name.', 'type' => 'string', 'example' => 'Dataphin-中间层-服饰零售 (LD_Fashion)'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '6865277495315392'], + 'BizUnitName' => ['title' => '', 'description' => 'The name of the business unit to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '服饰零售（LD_Fashion）'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the asset belongs. Returned when the asset type is TABLE (physical tables only) or INDEX (technical metrics whose source table is a physical table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '6865331517728384'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project to which the asset belongs. Returned when the asset type is TABLE (physical tables only) or INDEX (technical metrics whose source table is a physical table only).', 'type' => 'string', 'example' => 'train'], + 'DatasourceId' => ['title' => '', 'description' => 'The ID of the data source to which the asset belongs. Returned when the asset type is TABLE (data source tables only) or INDEX (technical metrics whose source table is a data source table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '7305549302863001856'], + 'DataSourceName' => ['title' => '', 'description' => 'The name of the data source to which the asset belongs. Returned when the asset type is TABLE (data source tables only) or INDEX (technical metrics whose source table is a data source table only).', 'type' => 'string', 'example' => 'demo_mysql'], + 'SubType' => ['title' => '', 'description' => 'The subtype. Valid values: DIM_NORMAL (common logical dimension table), DIM_ENUM (enumeration logical dimension table), DIM_VIRTUAL (virtual logical dimension table), SUM_BIZ_UNIT (aggregate table), FACT_EVENT (event fact logical table), FACT_SNAPSHOT (snapshot fact logical table), DATASOURCE_TABLE (data source table), PHYSICAL_TABLE (physical table), DATASOURCE_VIEW (data source view), PHYSICAL_VIEW (physical view), MATERIALIZED_VIEW (materialized view), BIZ_INDEX (business metric), INDEX (technical metric - standard modeling metric), and CUSTOM_INDEX (technical metric - custom metric).', 'type' => 'string', 'example' => 'DIM_NORMAL'], + 'Directories' => [ + 'title' => '', + 'description' => 'The directories to which the asset belongs, including topic ID, topic name, directory ID, and directory name.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The directory information of the asset.', + 'type' => 'object', + 'properties' => [ + 'TopicId' => ['title' => '', 'description' => 'The topic ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101676'], + 'TopicName' => ['title' => '', 'description' => 'The topic name.', 'type' => 'string', 'example' => '全渠道数据专题'], + 'DirectoryId' => ['title' => '', 'description' => 'The directory ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '102260'], + 'DirectoryName' => ['title' => '', 'description' => 'The directory name.', 'type' => 'string', 'example' => '线上电商平台'], + ], + 'example' => '', + ], + 'example' => '', ], - 'RefBizEntityIdList' => [ - 'title' => '关联已上线业务实体Id列表', - 'description' => '', + 'SumTableGuid' => ['title' => '', 'description' => 'The GUID of the aggregate table to which the asset belongs. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => 'odps.300023201.test.ads_gross'], + 'SumTableName' => ['title' => '', 'description' => 'The name of the aggregate table to which the asset belongs. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => 'ads_gross'], + 'Granularity' => ['title' => '', 'description' => 'The statistical granularity name of the technical metric. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => '课程'], + 'DataCellId' => ['title' => '', 'description' => 'The ID of the subject domain to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '49837403'], + 'DataCellName' => ['title' => '', 'description' => 'The name of the subject domain to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '课程域'], + 'ApiId' => ['title' => '', 'description' => 'The API ID. Returned when the asset type is API.', 'type' => 'integer', 'format' => 'int64', 'example' => '10441'], + 'ApiGroupName' => ['title' => '', 'description' => 'The API group name. Returned when the asset type is API.', 'type' => 'string', 'example' => '默认API分组'], + 'ApiRequestMethod' => ['title' => '', 'description' => 'The API operation type. Returned when the asset type is API. Valid values: 1 (Get), 2 (List), 3 (Create), 4 (Update), and 5 (Delete).', 'type' => 'string', 'example' => '1'], + 'ApiCallMode' => ['title' => '', 'description' => 'The API call mode. Returned when the asset type is API. Valid values: 1 (synchronous call) and 2 (asynchronous call).', 'type' => 'string', 'example' => '1'], + 'BiCatalog' => ['title' => '', 'description' => 'The BI workspace or directory to which the asset belongs. Returned when the asset type is PAGE (dashboard).', 'type' => 'string', 'example' => 'dataphin演示空间'], + 'ChartCount' => ['title' => '', 'description' => 'The total number of charts. Returned when the asset type is PAGE (dashboard).', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'CustomAttributes' => [ + 'title' => '', + 'description' => 'The custom attributes. Returned when includeDetailedAttributes is set to true.', 'type' => 'array', 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '116106', + 'title' => '', + 'description' => 'The custom attribute of the asset.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The attribute code.', 'type' => 'string', 'example' => 'gkglbm'], + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => '归口管理部门'], + 'Value' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'example' => 'abc'], + 'AttrType' => ['title' => '', 'description' => 'The attribute type. Valid values:'."\n" + .'- BUSINESS: Business attribute.'."\n" + .'- MANAGEMENT: Management attribute.'."\n" + .'- TECHNOLOGY: Technical attribute.', 'type' => 'string', 'example' => 'MANAGEMENT'], + ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], - ], - 'required' => false, - ], - 'BizProcess' => [ - 'title' => '业务活动', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '业务活动编码名称，64位字符以内，仅允许字母，数字和下划线;ADB_PG引擎编码名称长度为40位', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_process_code_name', + 'IsPartitionTable' => ['title' => '', 'description' => 'Indicates whether the table is a partitioned table. Returned when the asset type is TABLE. Valid values:'."\n" + .'- true: Yes.'."\n" + .'- false: No.', 'type' => 'boolean', 'example' => ''], + 'PartitionKey' => ['title' => '', 'description' => 'The partition field. Returned when the asset type is TABLE.', 'type' => 'string', 'example' => 'ds'], + 'PrimaryKey' => ['title' => '', 'description' => 'The primary key. Returned when the asset type is TABLE.', 'type' => 'string', 'example' => 'employee_id'], + 'TableLifeCycle' => ['title' => '', 'description' => 'The lifecycle. Returned when the asset type is TABLE.', 'type' => 'string', 'example' => '36000'], + 'SimpleNodeInfos' => [ + 'title' => '', + 'description' => 'The output nodes. Returned when the asset type is TABLE.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The output node information.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_7443633109495119872'], + 'SubBizType' => ['title' => '', 'description' => 'The node type. Example valid values: DLINK (offline integration) and PYTHON37 (Python compute node).', 'type' => 'string', 'example' => 'DLINK'], + 'NodeName' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '2345'], + 'Owners' => [ + 'title' => '', + 'description' => 'The list of O&M owners.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The basic user information, including the user ID and username.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Project' => [ + 'title' => '', + 'description' => 'The project to which the node belongs.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'example' => '6865331517728384'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'fashion_cdm'], + ], + 'example' => '', + ], + 'BizUnit' => ['title' => '', 'description' => 'The business unit to which the node belongs.', 'type' => 'string', 'example' => 'test'], + 'NodeScheduleType' => ['title' => '', 'description' => 'The scheduling method. Valid values:'."\n" + .'- NORMAL: Timed scheduling.'."\n" + .'- MANUAL: Manual scheduling.', 'type' => 'string', 'example' => 'NORMAL'], + 'Env' => ['title' => '', 'description' => 'The environment to which the node belongs.', 'type' => 'string', 'example' => 'PROD'], + ], + 'example' => '', + ], + 'example' => '', ], - 'DisplayName' => [ - 'title' => '业务活动名称，64位字符以内，仅允许汉字，字母，数字，下划线和中划线', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'create_process_name', + 'TableSizeInBytes' => ['title' => '', 'description' => 'The storage size in bytes. Returned when the asset type is TABLE.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-11 16:10:19'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2024-10-11 16:10:19'], + 'LastDdlTime' => ['title' => '', 'description' => 'The last DDL change time.', 'type' => 'string', 'example' => '2024-10-11 16:10:19'], + 'LastDmlTime' => ['title' => '', 'description' => 'The last DML update time.', 'type' => 'string', 'example' => '2024-10-11 16:10:19'], + 'Owner' => [ + 'title' => '', + 'description' => 'The owner.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', ], - 'Description' => [ - 'title' => '业务活动描述信息，128字符以内', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'LastOnShelveTime' => ['title' => '', 'description' => 'The last listing time.', 'type' => 'string', 'example' => '2025-05-22 10:06:20'], + 'FirstOnShelveTime' => ['title' => '', 'description' => 'The first listing time.', 'type' => 'string', 'example' => '2025-05-22 10:06:20'], + 'LastOnShelveUser' => [ + 'title' => '', + 'description' => 'The user who last listed the asset.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', ], - 'OwnerUserId' => [ - 'title' => '业务活动负责人用户Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30010010', + 'FirstOnShelveUser' => [ + 'title' => '', + 'description' => 'The user who first listed the asset.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', ], - 'Type' => [ - 'title' => '业务活动类型：业务事件 BIZ_EVENT、业务快照 BIZ_SNAPSHOT、业务流程 BIZ_PROCESS', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIZ_EVENT', + 'MaintainUserIds' => [ + 'title' => '', + 'description' => 'The listing maintenance personnel.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The listing maintenance personnel.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', ], - 'RefBizEntityIdList' => [ - 'title' => '关联已上线业务实体Id列表', - 'description' => '', + 'MaintainUserGroups' => [ + 'title' => '', + 'description' => 'The listing maintenance user groups.', 'type' => 'array', - 'items' => [ - 'title' => '关联已上线业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '116106', - ], - 'required' => false, + 'items' => ['title' => '', 'description' => 'The listing maintenance user groups.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', ], - 'BizEventEntityIdList' => [ - 'title' => '当前为业务流程活动时有效：业务流程活动包含的业务事件活动Id列表', - 'description' => '', + 'ShelveViewScopeType' => ['title' => '', 'description' => 'The visibility scope type. Valid values:'."\n" + .'- ALL_USERS_CAN_VIEW: Visible to all users.'."\n" + .'- PART_USERS_CAN_VIEW: Visible to some users.'."\n" + .'- PART_USERS_CAN_NOT_VIEW: Not visible to some users.', 'type' => 'string', 'example' => 'ALL_USERS_CAN_VIEW'], + 'ShelveViewScopeUserIds' => [ + 'title' => '', + 'description' => 'The users within the visibility scope.', 'type' => 'array', - 'items' => [ - 'title' => '业务流程活动包含的业务事件活动', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1016106', - ], - 'required' => false, + 'items' => ['title' => '', 'description' => 'The users within the visibility scope.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', ], - 'PreBizProcessIdList' => [ - 'title' => '业务流程活动的前序业务流程活动', - 'description' => '', + 'ShelveViewScopeUserGroups' => [ + 'title' => '', + 'description' => 'The user groups within the visibility scope.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user groups within the visibility scope.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', + ], + 'ProfilingReportViewScopeType' => ['title' => '', 'description' => 'The visibility scope type of the profiling report. Returned when the asset type is TABLE or INDEX. Valid values:'."\n" + .'- ALL_USERS_CAN_VIEW: Visible to all users.'."\n" + .'- PART_USERS_CAN_VIEW: Visible to some users.'."\n" + .'- ALL_USERS_CAN_NOT_VIEW: Not visible to any user.', 'type' => 'string', 'example' => 'ALL_USERS_CAN_VIEW'], + 'ProfilingReportViewScopeUserIds' => [ + 'title' => '', + 'description' => 'The users within the profiling report visibility scope.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The users within the profiling report visibility scope.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', + ], + 'ProfilingReportViewScopeUserGroups' => [ + 'title' => '', + 'description' => 'The user groups within the profiling report visibility scope.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user groups within the profiling report visibility scope.', 'type' => 'string', 'example' => '["300000901", "300006218"]'], + 'example' => '', + ], + 'ReadCount' => ['title' => '', 'description' => 'The number of views.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CollectionCount' => ['title' => '', 'description' => 'The number of favorites.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AssetDetailUrl' => ['title' => '', 'description' => 'The URL of the asset catalog details page.', 'type' => 'string', 'example' => 'https://dataphin.poc.lydaas.com/market/catalog/detail/table/...'], + 'Instruction' => ['title' => '', 'description' => 'The usage instructions.', 'type' => 'string', 'example' => 'test'], + 'Columns' => [ + 'title' => '', + 'description' => 'The field list. Returned when the asset type is TABLE.', 'type' => 'array', 'items' => [ - 'title' => '业务流程活动的前序业务流程活动', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1016106', + 'title' => '', + 'description' => 'The asset field information.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'The field GUID.', 'type' => 'string', 'example' => 'dp_table.300023201.ld_fashion.dws_lulu_location.conversion_rate'], + 'Name' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'example' => 'conversion_rate'], + 'DisplayName' => ['title' => '', 'description' => 'The field display name.', 'type' => 'string', 'example' => '门店客流转化率'], + 'Description' => ['title' => '', 'description' => 'The field description.', 'type' => 'string', 'example' => 'test'], + 'DataType' => ['title' => '', 'description' => 'The field data type.', 'type' => 'string', 'example' => 'double'], + 'BizType' => ['title' => '', 'description' => 'The business type. Valid values:'."\n" + .'- INDEX: Metric.'."\n" + .'- STAT_PERIOD: Statistical period.'."\n" + .'- DIMENSION: Dimension.', 'type' => 'string', 'example' => 'DIMENSION'], + 'AssociatedEntity' => [ + 'title' => '', + 'description' => 'The associated entity. Returned when the business type is DIMENSION.', + 'type' => 'object', + 'properties' => [ + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7137404445633152'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'LD_train'], + 'DimensionId' => ['title' => '', 'description' => 'The dimension ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '68014359'], + 'DimensionName' => ['title' => '', 'description' => 'The dimension name.', 'type' => 'string', 'example' => 'etl_source'], + 'DimensionDisplayName' => ['title' => '', 'description' => 'The dimension display name.', 'type' => 'string', 'example' => '上药erp数据源'], + ], + 'example' => '', + ], + 'Standards' => [ + 'title' => '', + 'description' => 'The associated standards.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The standard associated with the field.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '120350'], + 'Name' => ['title' => '', 'description' => 'The standard name.', 'type' => 'string', 'example' => 'id'], + 'Code' => ['title' => '', 'description' => 'The standard code.', 'type' => 'string', 'example' => 'hr_person_id'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'QualityScore' => ['title' => '', 'description' => 'The quality score.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'ClassifyName' => ['title' => '', 'description' => 'The data classification.', 'type' => 'string', 'example' => '/交易信息/0000001'], + 'LevelShortName' => ['title' => '', 'description' => 'The data sensitivity level.', 'type' => 'string', 'example' => 'L4'], + ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], ], - 'required' => false, - ], - 'Type' => [ - 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIZ_OBJECT', - ], - 'DataDomainId' => [ - 'title' => '业务活动所属主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20101011', - ], - 'BizUnitId' => [ - 'title' => '业务活动所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '6798087749072704', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query asset details', + 'summary' => 'Queries asset details. Release version: v6.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"Guid\\": \\"dp_ds_table.300023201.7311626611751680256.load_test.abc\\",\\n \\"AssetType\\": \\"TABLE\\",\\n \\"IsDeleted\\": false,\\n \\"AssetName\\": \\"abc\\",\\n \\"AssetDisplayName\\": \\"abc表\\",\\n \\"AssetFullName\\": \\"dwd_all.abc\\",\\n \\"MaxSecurityLevel\\": \\"L3\\",\\n \\"AssetTags\\": [\\n \\"[\\\\\\"标签1\\\\\\", \\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"AssetDescription\\": \\"abc\\",\\n \\"AssetFrom\\": \\"Dataphin-中间层-服饰零售 (LD_Fashion)\\",\\n \\"BizUnitId\\": 6865277495315392,\\n \\"BizUnitName\\": \\"服饰零售（LD_Fashion）\\",\\n \\"ProjectId\\": 6865331517728384,\\n \\"ProjectName\\": \\"train\\",\\n \\"DatasourceId\\": 7305549302863002000,\\n \\"DataSourceName\\": \\"demo_mysql\\",\\n \\"SubType\\": \\"DIM_NORMAL\\",\\n \\"Directories\\": [\\n {\\n \\"TopicId\\": 101676,\\n \\"TopicName\\": \\"全渠道数据专题\\",\\n \\"DirectoryId\\": 102260,\\n \\"DirectoryName\\": \\"线上电商平台\\"\\n }\\n ],\\n \\"SumTableGuid\\": \\"odps.300023201.test.ads_gross\\",\\n \\"SumTableName\\": \\"ads_gross\\",\\n \\"Granularity\\": \\"课程\\",\\n \\"DataCellId\\": \\"49837403\\",\\n \\"DataCellName\\": \\"课程域\\",\\n \\"ApiId\\": 10441,\\n \\"ApiGroupName\\": \\"默认API分组\\",\\n \\"ApiRequestMethod\\": \\"1\\",\\n \\"ApiCallMode\\": \\"1\\",\\n \\"BiCatalog\\": \\"dataphin演示空间\\",\\n \\"ChartCount\\": 23,\\n \\"CustomAttributes\\": [\\n {\\n \\"Code\\": \\"gkglbm\\",\\n \\"Name\\": \\"归口管理部门\\",\\n \\"Value\\": \\"abc\\",\\n \\"AttrType\\": \\"MANAGEMENT\\"\\n }\\n ],\\n \\"IsPartitionTable\\": false,\\n \\"PartitionKey\\": \\"ds\\",\\n \\"PrimaryKey\\": \\"employee_id\\",\\n \\"TableLifeCycle\\": \\"36000\\",\\n \\"SimpleNodeInfos\\": [\\n {\\n \\"NodeId\\": \\"n_7443633109495119872\\",\\n \\"SubBizType\\": \\"DLINK\\",\\n \\"NodeName\\": \\"2345\\",\\n \\"Owners\\": [\\n {\\n \\"UserId\\": \\"12345\\",\\n \\"DisplayName\\": \\"张三\\"\\n }\\n ],\\n \\"Project\\": {\\n \\"ProjectId\\": \\"6865331517728384\\",\\n \\"ProjectName\\": \\"fashion_cdm\\"\\n },\\n \\"BizUnit\\": \\"test\\",\\n \\"NodeScheduleType\\": \\"NORMAL\\",\\n \\"Env\\": \\"PROD\\"\\n }\\n ],\\n \\"TableSizeInBytes\\": 0,\\n \\"CreateTime\\": \\"2024-10-11 16:10:19\\",\\n \\"ModifyTime\\": \\"2024-10-11 16:10:19\\",\\n \\"LastDdlTime\\": \\"2024-10-11 16:10:19\\",\\n \\"LastDmlTime\\": \\"2024-10-11 16:10:19\\",\\n \\"Owner\\": {\\n \\"UserId\\": \\"12345\\",\\n \\"DisplayName\\": \\"张三\\"\\n },\\n \\"LastOnShelveTime\\": \\"2025-05-22 10:06:20\\",\\n \\"FirstOnShelveTime\\": \\"2025-05-22 10:06:20\\",\\n \\"LastOnShelveUser\\": {\\n \\"UserId\\": \\"12345\\",\\n \\"DisplayName\\": \\"张三\\"\\n },\\n \\"FirstOnShelveUser\\": {\\n \\"UserId\\": \\"12345\\",\\n \\"DisplayName\\": \\"张三\\"\\n },\\n \\"MaintainUserIds\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"MaintainUserGroups\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"ShelveViewScopeType\\": \\"ALL_USERS_CAN_VIEW\\",\\n \\"ShelveViewScopeUserIds\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"ShelveViewScopeUserGroups\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"ProfilingReportViewScopeType\\": \\"ALL_USERS_CAN_VIEW\\",\\n \\"ProfilingReportViewScopeUserIds\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"ProfilingReportViewScopeUserGroups\\": [\\n \\"[\\\\\\"300000901\\\\\\", \\\\\\"300006218\\\\\\"]\\"\\n ],\\n \\"ReadCount\\": 5,\\n \\"CollectionCount\\": 0,\\n \\"AssetDetailUrl\\": \\"https://dataphin.poc.lydaas.com/market/catalog/detail/table/...\\",\\n \\"Instruction\\": \\"test\\",\\n \\"Columns\\": [\\n {\\n \\"Guid\\": \\"dp_table.300023201.ld_fashion.dws_lulu_location.conversion_rate\\",\\n \\"Name\\": \\"conversion_rate\\",\\n \\"DisplayName\\": \\"门店客流转化率\\",\\n \\"Description\\": \\"test\\",\\n \\"DataType\\": \\"double\\",\\n \\"BizType\\": \\"DIMENSION\\",\\n \\"AssociatedEntity\\": {\\n \\"BizUnitId\\": 7137404445633152,\\n \\"BizUnitName\\": \\"LD_train\\",\\n \\"DimensionId\\": 68014359,\\n \\"DimensionName\\": \\"etl_source\\",\\n \\"DimensionDisplayName\\": \\"上药erp数据源\\"\\n },\\n \\"Standards\\": [\\n {\\n \\"Id\\": 120350,\\n \\"Name\\": \\"id\\",\\n \\"Code\\": \\"hr_person_id\\"\\n }\\n ],\\n \\"QualityScore\\": 0,\\n \\"ClassifyName\\": \\"/交易信息/0000001\\",\\n \\"LevelShortName\\": \\"L4\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetCheckConnectivityJobs' => [ + 'summary' => 'Queries the list of connectivity check tasks for a specified data source ID. This operation includes null value validation and tenant permission verification to prevent cross-tenant access.'."\n" + .'Release version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '462935472785'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '新建结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BizEntityId' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12113111', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'result', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'CheckConnectivityJobDTO', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '', 'description' => 'The task status.', 'type' => 'string', 'example' => 'SUCCESS'], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'example' => '30001011'], + 'JobType' => ['title' => '', 'description' => 'The task type, such as application-level or cluster-level.', 'type' => 'string', 'example' => 'application/cluster'], + 'ErrorMsg' => ['title' => '', 'description' => 'The error message that provides a detailed error description when the task fails.', 'type' => 'string', 'example' => 'notFoundIp'], + 'VoldemortTaskId' => ['title' => '', 'description' => 'The Voldemort task ID, which is used to associate with the underlying execution task.', 'type' => 'string', 'example' => 't_7572319950395080706_20251225_7572319950395080707'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'example' => '192'], + 'JobId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '123123'], ], + 'example' => '', ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The response code returned by the backend.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query data source connectivity check tasks', + 'description' => 'Queries the details of connectivity tasks that have been tested for a specified data source ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateDataDomain' => [ - 'summary' => '更新主题域。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetClusterQueueInfoByEnv' => [ + 'summary' => 'Retrieves cluster information based on the environment.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['Dataphin公共云'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752'], + ], + [ + 'name' => 'StreamBatchMode', + 'in' => 'query', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The stream-batch mode.', + 'type' => 'string', 'required' => true, - 'example' => '30001011', + 'example' => 'BOTH', + 'enum' => ['STREAM', 'BATCH', 'BOTH'], ], ], - [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '创建请求', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'BizUnitId' => [ - 'title' => '数据板块ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '545844456', - ], - 'DataDomainId' => [ - 'title' => '主题域ID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10232311', - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The cluster details.', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d'], + 'QueueName' => ['title' => '', 'description' => 'The queue name, which serves as a unique identifier. For Kubernetes, this is the resource group name.', 'type' => 'string', 'example' => 'default-queue'], + 'MaxVcore' => ['title' => '', 'description' => 'The maximum number of vCores provided by each queue.', 'type' => 'string', 'example' => '10'], + 'Namespace' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'example' => 'dataphinv45prod'], + 'CreateAt' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-31 10:29:17'], + 'ModifiedAt' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2024-10-31 10:29:17'], + 'Annotations' => ['title' => '', 'description' => 'The annotations.', 'type' => 'string', 'example' => '{ "creator": "new_datasource@test.aliyunid.com", "modifier": "new_datasource@test.aliyunid.com" }'], + 'Labels' => ['title' => '', 'description' => 'The labels.', 'type' => 'string', 'example' => 'cdh', 'default' => 'null'], + 'ResourceVersion' => ['title' => '', 'description' => 'The resource version.', 'type' => 'string', 'example' => '1'], + 'Spec' => ['title' => '', 'description' => 'The resource specification.', 'type' => 'string', 'example' => '{\\n \\"kind\\" : \\"kubernetes\\",\\n \\"kubernetes\\{"namespace" : "n1730341728989z7", "clusterName" : "a51578bdcce145" }, "state" : "ONLINE"}'], + 'VvpClusterType' => ['title' => '', 'description' => 'The VVP cluster type.', 'type' => 'string', 'example' => 'PREJOB'], + 'FlinkVersion' => ['title' => '', 'description' => 'The Flink version.', 'type' => 'string', 'required' => false, 'example' => '1.15', 'default' => 'null'], + 'FlinkImageRegistry' => ['title' => '', 'description' => 'The Flink image registry address.', 'type' => 'string', 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com/xxxx/flink:1.15.4-scala_2.12', 'default' => 'null'], + 'FlinkImageRepository' => ['title' => '', 'description' => 'The Flink image repository.', 'type' => 'string', 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com', 'default' => 'null'], + 'FlinkImageTag' => ['title' => '', 'description' => 'The Flink image tag.', 'type' => 'string', 'example' => '1.15.4', 'default' => 'null'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Retrieve environment cluster queue information', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListDataDomains' => [ - 'summary' => '获取主题域列表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetClusterQueueInfoByEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetComputeSource' => [ + 'summary' => 'Retrieves the details of a compute source by compute source ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -17621,243 +12892,79 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '所属数据板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '545844456', - ], - 'required' => false, - ], - 'ParentIdList' => [ - 'title' => '上级主题域Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '上级主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10232311', - ], - 'required' => false, - ], - 'Keyword' => [ - 'title' => '搜索关键词: 主题名称/编码/描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => true, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ComputeSourceInfo' => [ + 'title' => '', + 'description' => 'The compute source details.', 'type' => 'object', 'properties' => [ - 'DataDomainList' => [ - 'title' => '主题域详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '主题域详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '主题域Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30010010', - ], - 'LastModifierName' => [ - 'title' => '最近一次修改人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'ParentId' => [ - 'title' => '上级主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10232311', - ], - ], - ], - ], + 'Id' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12356'], + 'Name' => ['title' => '', 'description' => 'The name of the compute source.', 'type' => 'string', 'example' => 'dp_test'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'dp_test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'compute source for xxx.'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation timestamp.', 'type' => 'string', 'example' => '1681881607000'], + 'GmtModified' => ['title' => '', 'description' => 'The last modification timestamp.', 'type' => 'string', 'example' => '1711881607000'], + 'Owner' => ['title' => '', 'description' => 'The ID of the compute source owner.', 'type' => 'string', 'example' => '101101'], + 'Creator' => ['title' => '', 'description' => 'The ID of the compute source creator.', 'type' => 'string', 'example' => '101101'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the compute source owner.', 'type' => 'string', 'example' => 'test'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the compute source creator.', 'type' => 'string', 'example' => 'test'], + 'BindProjectName' => ['title' => '', 'description' => 'The name of the associated project.', 'type' => 'string', 'example' => 'dp_mctest'], + 'BindProjectId' => ['title' => '', 'description' => 'The ID of the associated project.', 'type' => 'integer', 'format' => 'int64', 'example' => '10101101'], + 'BindProject' => ['title' => '', 'description' => 'Indicates whether a project is associated.', 'type' => 'boolean', 'example' => 'true'], + 'Type' => ['title' => '', 'description' => 'The type of the compute source.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', + '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' => 'Get compute source details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], 'GetDataDomainInfo' => [ - 'summary' => '获取主题域详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17865,1328 +12972,955 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1241844456', - ], + 'schema' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'DataDomainInfo' => [ - 'title' => '主题域详情', - 'description' => '', + 'title' => '', + 'description' => 'The data domain details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '主题域Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30010010', - ], - 'LastModifierName' => [ - 'title' => '最近一次修改人', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'ParentId' => [ - 'title' => '上级主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10232311', - ], + 'Id' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the data domain belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'dm_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => '测试'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the data domain.', 'type' => 'string', 'example' => 'dm_code_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The ID of the business object owner.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The ID of the business object owner.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the data domain.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the data domain.', 'type' => 'string', 'example' => '张三'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the parent data domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '10232311'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query data domain details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteDataDomain' => [ - 'summary' => '删除主题域。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDataDomainInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDataServiceApiCallSummary' => [ + 'summary' => 'Service Monitoring: Retrieves the aggregate statistics of API calls.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'BizUnitId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '6798087749072704', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], [ - 'name' => 'Id', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1241844456', - ], + 'schema' => ['title' => '', 'description' => 'The start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The aggregate statistics of API calls.', + 'type' => 'object', + 'properties' => [ + 'CallCount' => ['title' => '', 'description' => 'The number of API calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '1021'], + 'ErrorCount' => ['title' => '', 'description' => 'The number of failed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + 'ErrorRate' => ['title' => '', 'description' => 'The error rate.', 'type' => 'number', 'format' => 'double', 'example' => '10.01'], + 'OfflineRate' => ['title' => '', 'description' => 'The offline percentage.', 'type' => 'number', 'format' => 'double', 'example' => '2.03'], + 'ErrorApiCount' => ['title' => '', 'description' => 'The number of APIs with call errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'ErrorAppCount' => ['title' => '', 'description' => 'The number of applications affected by errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve aggregate statistics of data service API calls', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateDataDomain' => [ - 'summary' => '创建主题域。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceApiCallTrend' => [ + 'summary' => 'Service Monitoring: Analyzes API access trends.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10232311', - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '新建结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The access trend data.', 'type' => 'object', 'properties' => [ - 'DataDomainId' => [ - 'title' => '主题域Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1241844456', + 'CallErrorTrendList' => [ + 'title' => '', + 'description' => 'The call error trends, sorted by minute in ascending order.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Minute' => ['title' => '', 'description' => 'The minute in the format of yyyy_MMdd_HHmm.', 'type' => 'string', 'example' => '3'], + 'CallCount' => ['title' => '', 'description' => 'The number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '1021'], + 'ErrorCount' => ['title' => '', 'description' => 'The number of call errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'CallErrorImpactTrendList' => [ + 'title' => '', + 'description' => 'The call error impact trends, sorted by minute in ascending order.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ErrorApiCount' => ['title' => '', 'description' => 'The number of APIs with call errors.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Minute' => ['title' => '', 'description' => 'The time scale in minutes, in the format of yyyy-MM-dd HH:mm.', 'type' => 'string', 'example' => '2025-06-30 08:00'], + 'ErrorAppCount' => ['title' => '', 'description' => 'The number of affected applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ApiIdList' => [ + 'title' => '', + 'description' => 'The API IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The API IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1203'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data service API access trend analysis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteBizEntity' => [ - 'summary' => '删除业务实体。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceApiDocument' => [ + 'summary' => 'Retrieves API documentation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'BizUnitId', - 'in' => 'query', - 'schema' => [ - 'title' => '所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '6798087749072704', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Type', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '业务类型: BIZ_OBJECT、BIZ_PROCESS', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIZ_OBJECT', - ], + 'schema' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102101'], ], [ - 'name' => 'Id', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'title' => '业务实体Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101001201', - ], + 'schema' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The API documentation.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The API name.', 'type' => 'string', 'example' => '测试'], + 'GroupId' => ['title' => '', 'description' => 'The API group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1011'], + 'GroupName' => ['title' => '', 'description' => 'The API group name.', 'type' => 'string', 'example' => '1011'], + 'RequestMethod' => ['title' => '', 'description' => 'The request method. Valid values:'."\n" + .'- 1: get'."\n" + .'- 2: list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UpdateRate' => ['title' => '', 'description' => 'The update frequency. Valid values:'."\n" + .'- 0: custom'."\n" + .'- 1: daily'."\n" + .'- 2: hourly'."\n" + .'- 3: every minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'ReturnType' => ['title' => '', 'description' => 'The return data type. Valid values:'."\n" + .'- 1: JSON.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Protocol' => ['title' => '', 'description' => 'The protocol. Valid values:'."\n" + .'- 1: HTTPS'."\n" + .'- 2: HTTP'."\n" + .'- 3: both HTTP and HTTPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Sql' => ['title' => '', 'description' => 'The SQL statement.', 'type' => 'string', 'example' => 'select col1 from table1;'], + 'RequestParamList' => [ + 'title' => '', + 'description' => 'The list of request parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => ['title' => '', 'description' => 'The default value.', 'type' => 'string', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'string'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '测试'], + 'IsRequired' => ['title' => '', 'description' => 'Specifies whether the request parameter is required. Valid values:'."\n" + .'- 1: Required.'."\n" + .'- 0: Optional.', 'type' => 'boolean', 'example' => ''], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ResponseParamList' => [ + 'title' => '', + 'description' => 'The list of response parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'string'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '测试'], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'PublicParamList' => [ + 'title' => '', + 'description' => 'The list of common parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'string'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '测试'], + 'IsRequired' => ['title' => '', 'description' => 'Specifies whether the request parameter is required. Valid values:'."\n" + .'- 1: Required.'."\n" + .'- 0: Optional.', 'type' => 'boolean', 'example' => ''], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'IsSpecialSql' => ['title' => '', 'description' => 'Specifies whether the SQL is special. Valid values:'."\n" + .'- 0: No.'."\n" + .'- 1: Yes.', 'type' => 'boolean', 'example' => ''], + 'CreateType' => ['title' => '', 'description' => 'The creation type. Valid values:'."\n" + .'- 0: custom mode'."\n" + .'- 1: wizard mode'."\n" + .'- 2: direct API.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ApiId' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '102101'], + 'Mode' => ['title' => '', 'description' => 'The mode. Valid values:'."\n" + .'- 0: basic'."\n" + .'- 1: dev_prod.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values:'."\n" + .'- 0: dev'."\n" + .'- 1: prod.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ResultSample' => ['title' => '', 'description' => 'The sample invocation result.', 'type' => 'string', 'example' => '{"count": 88}'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name. This parameter has a value only for logical tables.', 'type' => 'string', 'example' => 'bizUnit_test'], + 'TableName' => ['title' => '', 'description' => 'The logical table name. This parameter has a value only for logical tables.', 'type' => 'string', 'example' => 't_logical_test1'], + 'IsLogicalTable' => ['title' => '', 'description' => 'Indicates whether the table is a logical table.', 'type' => 'boolean', 'example' => ''], + 'DirectDatasourceId' => ['title' => '', 'description' => 'The data source ID of the direct API.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DirectDatasourceName' => ['title' => '', 'description' => 'The data source name of the direct API.', 'type' => 'string', 'example' => 'test'], + 'ApiTimeout' => ['title' => '', 'description' => 'The timeout period of the direct API, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'ReturnLimit' => ['title' => '', 'description' => 'The maximum number of records returned by the direct API.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'ProjectId' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '10201'], + 'ProjectName' => ['title' => '', 'description' => 'The data service project name.', 'type' => 'string', 'example' => 'test'], + 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => '10021'], + 'ResourceGroupName' => ['title' => '', 'description' => 'The resource group name.', 'type' => 'string', 'example' => 'test'], + 'OpenCache' => ['title' => '', 'description' => 'Specifies whether caching is enabled. Valid values:'."\n" + .'- 0: Disabled.'."\n" + .'- 1: Enabled.', 'type' => 'boolean', 'example' => ''], + 'CacheTime' => ['title' => '', 'description' => 'The cache duration, in seconds.', 'type' => 'string', 'example' => '600'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period, in seconds.', 'type' => 'string', 'example' => '60'], + 'ScriptType' => ['title' => '', 'description' => 'The script type. Valid values:'."\n" + .'- NORMAL_SQL: basic SQL'."\n" + .'- MYBATIS_SQL: advanced SQL'."\n" + .'- AVIATOR: Aviator expression.', 'type' => 'string', 'example' => 'NORMAL_SQL'], + 'ApiRegisterInfo' => [ + 'title' => '', + 'description' => 'The API registration information.', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => '', 'description' => 'The mode. Valid values:'."\n" + .'- 0: basic'."\n" + .'- 1: dev_prod.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HttpMethod' => ['title' => '', 'description' => 'The HTTP method for the registered API. Valid values:'."\n" + .'- 1: GET'."\n" + .'- 2: POST.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'DatasourceId' => ['title' => '', 'description' => 'The API data source ID.', 'type' => 'string', 'example' => '102311'], + 'DatasourceName' => ['title' => '', 'description' => 'The API data source name.', 'type' => 'string', 'example' => 'test'], + 'Url' => ['title' => '', 'description' => 'The API data source URL.', 'type' => 'string', 'example' => 'http://192.168.1.1:8080'], + 'AuthType' => ['title' => '', 'description' => 'The authentication method for the API data source. Valid values:'."\n" + .'- 1: BearToken'."\n" + .'- 2: ApiKey'."\n" + .'- 3: None'."\n" + .'- 4: AppKeyAuth'."\n" + .'- 5: BasicAuth.', 'type' => 'string', 'example' => '3'], + 'Protocol' => ['title' => '', 'description' => 'The request protocol for the API data source.', 'type' => 'string', 'example' => 'https'], + 'Path' => ['title' => '', 'description' => 'The service path.', 'type' => 'string', 'example' => '/api/test'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + ], + 'example' => '', + ], + 'Version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => '1.0'], + 'IsPagedQuery' => ['title' => '', 'description' => 'Indicates whether the query is a paged query. Valid values:'."\n" + .'- 1: Yes.'."\n" + .'- 0: No.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\n \\"Sample\\": \\"test\\",\\n \\"Name\\": \\"col1\\"\\n }\\n ],\\n \\"IsSpecialSql\\": false,\\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\\": false,\\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\\": false,\\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\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve API documentation details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateAdHocFile' => [ - 'summary' => '创建即席查询文件', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceApiErrorImpact' => [ + 'summary' => 'Retrieves the summary of API exception impacts.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'FileId' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1212313222', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The summary of call exception impacts.', + 'type' => 'object', + 'properties' => [ + 'ErrorAppList' => [ + 'title' => '', + 'description' => 'The list of apps affected by exceptions.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'appId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021'], + 'AppKey' => ['title' => '', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'example' => '100211'], + 'ErrorCount' => ['title' => '', 'description' => 'The number of exceptions for the app.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'AppName' => ['title' => '', 'description' => 'The app name.', 'type' => 'string', 'example' => 'app1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ErrorApiList' => [ + 'title' => '', + 'description' => 'The list of APIs affected by exceptions.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2012'], + 'ApiName' => ['title' => '', 'description' => 'The API name.', 'type' => 'string', 'example' => 'test'], + 'ErrorCount' => ['title' => '', 'description' => 'The number of exceptions for the API.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data service API exception impacts', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteAdHocFile' => [ - 'summary' => '删除菜单树即席查询文件', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceApiGroups' => [ + 'summary' => 'Queries the list of API groups in Data Service.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12132323', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12121111', - ], + 'schema' => ['title' => '', 'description' => 'The Data Service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ApiGroupList' => [ + 'title' => '', + 'description' => 'The list of API groups.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '101231'], + 'Name' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query data service API group list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateAdHocFile' => [ - 'summary' => '编辑即席查询文件。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceApp' => [ + 'summary' => 'Queries the details of a data service application, including the project, application name, authentication information, and IP whitelist. Only application members can view the details.'."\n" + .'Release version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1212313', - ], - 'FileId' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2311113', - ], - 'Content' => [ - 'title' => '文件内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'select 1;', - ], - ], - 'required' => true, - ], + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error message returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The details of the data service application.', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '12345'], + 'IpWhitelist' => ['title' => '', 'description' => 'The IP whitelist addresses. Specify IP addresses or CIDR blocks separated by semicolons (;). CIDR blocks end with a slash (/) followed by a number in the range of 1 to 32. Example: 192.168.3.12/24.', 'type' => 'string', 'example' => 'true'], + 'AppKey' => ['title' => '', 'description' => 'The AppKey of the application.', 'type' => 'string', 'example' => '默认应用'], + 'Scenarios' => ['title' => '', 'description' => 'The common scenarios.', 'type' => 'string', 'example' => '数据分析'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The list of owners.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AppSecret' => ['title' => '', 'description' => 'The AppSecret of the application.', 'type' => 'string', 'example' => '默认应用'], + 'AppGroup' => ['title' => '', 'description' => 'The application group name.', 'type' => 'string', 'example' => '默认分组'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => '默认应用'], + 'IpWhitelistStatus' => ['title' => '', 'description' => 'Indicates whether the IP whitelist is enabled. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The response code returned by the backend.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"AppId\\": 12345,\\n \\"IpWhitelist\\": \\"true\\",\\n \\"AppKey\\": \\"默认应用\\",\\n \\"Scenarios\\": \\"数据分析\\",\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"12345\\",\\n \\"Name\\": \\"张三\\"\\n }\\n ],\\n \\"AppSecret\\": \\"默认应用\\",\\n \\"AppGroup\\": \\"默认分组\\",\\n \\"AppName\\": \\"默认应用\\",\\n \\"IpWhitelistStatus\\": false\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query data service application details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetAdHocFile' => [ - 'summary' => '查询即席查询文件。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceAppAuthorizedUsers' => [ + 'summary' => 'Retrieves the list of users who have permissions on an application.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12132323', - ], + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], ], [ - 'name' => 'FileId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12121111', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1022'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'FileInfo' => [ - 'title' => '即席查询文件详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12121111', - ], - 'Name' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30002101'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve users with data service application permissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'StopAdHocTask' => [ - 'summary' => '终止即席查询任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceAppGroups' => [ + 'summary' => 'Queries the list of application groups for a data service project.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The data service project ID.'."\n" + .'>This field is deprecated..', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '102102'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'AppGroupList' => [ + 'title' => '', + 'description' => 'The list of application groups.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The group information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1022'], + 'Name' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'GetAdHocTaskResult' => [ - 'summary' => '获取即席查询的任务运行结果。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'List data service application groups', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetDataServiceAppMembers' => [ + 'summary' => 'Queries the member list of a data service application, including regular members and owners. Only application owners can call this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -19194,362 +13928,251 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SubTaskId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '子任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ExecuteResult' => [ - 'title' => '运行结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error message returned from the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The member list of the data service application.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], - 'ScheduleTaskId' => [ - 'title' => '对应调度任务ID', - 'description' => '', - 'type' => 'string', - 'example' => 't_2242892326444990464_20210125_2242892326444990465', - ], - 'Result' => [ - 'title' => '任务执行结果', - 'description' => '', - 'type' => 'string', - 'example' => '1', + 'MemberList' => [ + 'title' => '', + 'description' => 'The application member list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '', 'description' => 'The role of the user. Valid values:'."\n" + ."\n" + .'- general: regular member.'."\n" + .'- owner: application owner.', 'type' => 'string', 'example' => 'general'], + 'EffectiveEnd' => ['title' => '', 'description' => 'The authorization expiration time.', 'type' => 'string', 'example' => '2026-12-12'], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '200000245'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"MemberList\\": [\\n {\\n \\"Role\\": \\"general\\",\\n \\"EffectiveEnd\\": \\"2026-12-12\\",\\n \\"UserId\\": \\"200000245\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query member list of a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ExecuteAdHocTask' => [ - 'summary' => '执行即席查询任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceAppsByGroupId' => [ + 'summary' => 'Queries the list of applications in a group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ExecuteCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The application group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '202102'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '执行命令', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '任务脚本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'show tables;', - ], - 'ParamList' => [ - 'title' => '运行参数列表', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'AppInfoList' => [ + 'title' => '', + 'description' => 'The list of application groups.', 'type' => 'array', 'items' => [ - 'title' => '运行参数', + 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '运行参数名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'param1', - ], - 'Value' => [ - 'title' => '运行参数值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'value1', - ], + 'Id' => ['title' => '', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021'], + 'Name' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'test'], ], - 'required' => true, + 'example' => '', ], - 'required' => false, - ], - 'OperatorType' => [ - 'title' => '任务类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxCompute_SQL', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123222121', - ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'erp', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'List data service applications by application group ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetDataServiceAuthorizedAppsByGroupId' => [ + 'summary' => 'Queries the list of applications that the account has permissions to access based on the app group 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The app group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '202102'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ExecuteResult' => [ - 'title' => '执行结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], - 'SubTaskCount' => [ - 'title' => '任务解析, 拆分出来子任务个数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'AppInfoList' => [ + 'title' => '', + 'description' => 'The list of API groups.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021'], + 'Name' => ['title' => '', 'description' => 'The app name.', 'type' => 'string', 'example' => 'test'], + 'AppKey' => ['title' => '', 'description' => 'The application key.'."\n" + .'>Deprecated. Use AppKeyStr instead..', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '12345'], + 'AppKeyStr' => ['title' => '', 'description' => 'The application key.', 'type' => 'string', 'example' => 'app12345'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], - 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"}]', - ], - 'GetAdHocTaskLog' => [ - 'summary' => '获取即席查询任务运行日志。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"AppInfoList\\": [\\n {\\n \\"Id\\": 1021,\\n \\"Name\\": \\"test\\",\\n \\"AppKey\\": 12345,\\n \\"AppKeyStr\\": \\"app12345\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve data service applications accessible to the account', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetDataServiceAuthorizedProjects' => [ + 'summary' => 'Queries the list of projects that the current user has permissions to access.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -19557,523 +14180,302 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ProjectList' => [ + 'title' => '', + 'description' => 'The list of projects.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '', 'description' => 'The role of the user. Valid values:'."\n" + .'- 1: super administrator'."\n" + .'- 2: developer'."\n" + .'- 3: application member'."\n" + .'- 4: service project administrator'."\n" + .'- 5: O&M user.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1011'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query data service projects accessible to the current user', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetDataServiceMyProjects' => [ + 'summary' => 'Retrieves the list of projects for which the current user is the owner.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'SubTaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '子任务ID, 从0开始', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Offset', + 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '查询日志的偏移量, 根据返回的结果递增 初始值传0', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1021', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'LogInfo' => [ - 'title' => '日志详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'example' => 'MaxCompute_SQL_300000843_1611548758327', - ], - 'SubTaskId' => [ - 'title' => '子任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TaskStatus' => [ - 'title' => '任务运行状态: 等待资源 WAIT_RESOURCE', - 'description' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ProjectList' => [ + 'title' => '', + 'description' => 'The list of data service projects.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '', 'description' => 'The role. Valid values:'."\n" + .'- 1: super administrator'."\n" + .'- 2: developer'."\n" + .'- 3: application member'."\n" + .'- 4: service project administrator'."\n" + .'- 5: O&M engineer.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102011'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data service projects owned by the current user', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdatePipelineByAsync' => [ - 'summary' => '异步更新集成管道任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataServiceProjectAddableUsers' => [ + 'summary' => 'Retrieves the list of users who can be added as project members.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], - 'StepType' => [ - 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Key' => [ - 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysqlinput', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Hops' => [ - 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '集成管道输入输出组件关系配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '输出步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'odps_writer', - ], - 'SendTo' => [ - 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Source' => [ - 'title' => '输入步骤名称，即Steps[*].StepName', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'Directory' => [ - 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of project members.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30012011'], + 'DisplayName' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'test'], + 'AccountName' => ['title' => '', 'description' => 'The username of the user.', 'type' => 'string', 'example' => 'xx@aliyuncs.com'], ], + 'example' => '', ], - 'required' => true, - ], - 'PipelineType' => [ - 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Mode' => [ - 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PIPELINE', - ], - 'Submit' => [ - 'title' => '是否提交，默认提交', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'PipelineJson' => [ - 'title' => '脚本模式下：集成管道配置（json字符串格式）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Settings' => [ - 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve users available to add as data service project members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetDataSourceDependencies' => [ + 'summary' => 'Queries the integration tasks and database SQL tasks affected by data source changes.', + '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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1023211'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '异步执行查询Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'DependencyList' => [ + 'title' => '', + 'description' => 'The dependency records.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the dependency record.', 'type' => 'string', 'example' => 'pipeline'], + 'TypeCode' => ['title' => '', 'description' => 'The type code of the dependency record.', 'type' => 'string', 'example' => 'pipeline'], + 'Id' => ['title' => '', 'description' => 'The ID of the dependency record.', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The name of the dependency record.', 'type' => 'string', 'example' => 'jytest'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Get data source dependency list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'OfflinePipelineByAsync' => [ - 'summary' => '异步下线集成管道任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataset' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -20082,178 +14484,263 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7255013756724992'], ], [ - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '支持使用集成管道主键pipelineId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '支持使用集成任务文件fileId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7255018404425088'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '异步执行查询Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'DatasetDTO' => [ + 'title' => '', + 'description' => 'The dataset object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The dataset ID (business primary key).', 'type' => 'integer', 'format' => 'int64', 'example' => '7255018404425088'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the dataset belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '7255013756724992'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project to which the dataset belongs.', 'type' => 'string', 'example' => 'ds_tm'], + 'Name' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'audio_dataset'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7255018404650688'], + 'Directory' => ['title' => '', 'description' => 'The directory (retrieved from the file service by using the fileId).', 'type' => 'string', 'example' => '/'], + 'DataCellId' => ['title' => '', 'description' => 'The subject area ID.', 'type' => 'string', 'example' => '78201'], + 'DataCellName' => ['title' => '', 'description' => 'The subject area name.', 'type' => 'string', 'example' => '离线数据主题域'], + 'Type' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'HYBRID'], + 'StorageType' => ['title' => '', 'description' => 'The storage type.', 'type' => 'string', 'example' => 'OSS'], + 'MetadataStorageType' => ['title' => '', 'description' => 'The metastore type.', 'type' => 'string', 'example' => 'POSTGRESQL'], + 'Scenario' => ['title' => '', 'description' => 'The dataset scenarios. Valid values:'."\n" + .'- OFFLINE: offline (default).'."\n" + .'- REALTIME: real-time.', 'type' => 'string', 'example' => 'OFFLINE'], + 'ContentType' => ['title' => '', 'description' => 'The content type.', 'type' => 'string', 'example' => 'GENERAL'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The list of owners.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '300001391', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The creator ID.', 'type' => 'string', 'example' => '300001391'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2026-04-28 10:03:49'], + 'GmtModified' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2026-04-28 10:03:49'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试数据集'], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '300001413'], + 'VersionList' => [ + 'title' => '', + 'description' => 'The list of versions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7280840713415040'], + 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7280832407583104'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'example' => 'V4'], + 'DataVersionConfig' => [ + 'title' => '', + 'description' => 'The dataset version configuration.', + 'type' => 'object', + 'properties' => [ + 'VersionDescription' => ['title' => '', 'description' => 'The version description.', 'type' => 'string', 'example' => '测试数据集版本'], + 'FileStorageConfig' => [ + 'title' => '', + 'description' => 'The file storage configuration.', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7445343860022804608'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '测试数据源'], + 'DevPath' => ['title' => '', 'description' => 'The development path (not required for basic projects).', 'type' => 'string', 'example' => 'HTML正文提取/test423/'], + 'ProdPath' => ['title' => '', 'description' => 'The production path.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'MountPath' => ['title' => '', 'description' => 'The mount path.', 'type' => 'string', 'required' => true, 'example' => '/var/run/openresty/cache/corp'], + ], + 'example' => '', + ], + 'MetadataStorageConfig' => [ + 'title' => '', + 'description' => 'The metastore configuration.', + 'type' => 'object', + 'properties' => [ + 'MetadataStorageMode' => ['title' => '', 'description' => 'The storage destination (new table or existing table).', 'type' => 'string', 'required' => true, 'example' => 'CREATE'], + 'MetadataStorageType' => ['title' => '', 'description' => 'The metastore type.', 'type' => 'string', 'example' => 'MILVUS'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7429133693081710272'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '测试数据源'], + 'DevSchema' => ['title' => '', 'description' => 'The development database/schema.', 'type' => 'string', 'example' => 'HTML正文提取/test423/'], + 'ProdSchema' => ['title' => '', 'description' => 'The production database/schema.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 's_crm_all_plt_jala_shop'], + 'TableSchema' => [ + 'title' => '', + 'description' => 'The table schema configuration.', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'required' => true, 'example' => 'id'], + 'Type' => ['title' => '', 'description' => 'The column type.', 'type' => 'string', 'required' => true, 'example' => 'int8'], + 'ElementType' => ['title' => '', 'description' => 'The array element subtype. This parameter is valid only when type is set to ARRAY.', 'type' => 'string', 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => 'The maximum array capacity. This parameter is valid only when type is set to ARRAY. Default value: 4096.', 'type' => 'integer', 'format' => 'int32', 'example' => '35'], + 'Pk' => ['title' => '', 'description' => 'Indicates whether the column is a primary key.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'Comment' => ['title' => '', 'description' => 'The column comment.', 'type' => 'string', 'example' => '主键'], + 'Url' => ['title' => '', 'description' => 'Indicates whether the column is a URL.', 'type' => 'boolean', 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'MultiModal-Embedding'], + 'Dimension' => ['title' => '', 'description' => 'The embedding dimension.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance:mongodb'], + 'IndexType' => ['title' => '', 'description' => 'The index type. PG supports IVFFlat and HNSW. Milvus supports all types.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type. Default value: COSINE. COSINE corresponds to vector_cosine_ops, L2 corresponds to vector_l2_ops, and IP corresponds to vector_ip_ops.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters. Different parameters are required depending on the index type. For example, HNSW requires {M:30, efConstruction:360}, and IVF_FLAT requires {nlist:128}.', 'type' => 'object', 'example' => '{M:30, efConstruction:360}'], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'RealtimeMetaTableConfig' => [ + 'title' => '', + 'description' => 'The real-time meta table configuration. This parameter takes effect only when metadataStorageType is set to REALTIME_META_TABLE.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID to which the meta table belongs. Cross-project references are supported.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7255013756724992'], + 'MetaTableName' => ['title' => '', 'description' => 'The meta table name.', 'type' => 'string', 'required' => true, 'example' => '测试元表'], + 'DatasourceType' => ['title' => '', 'description' => 'The data source type of the meta table. Only KAFKA is supported in the current release.', 'type' => 'string', 'required' => true, 'example' => 'KAFKA'], + 'TableSchema' => [ + 'title' => '', + 'description' => 'The table schema configuration (reuses MetadataStorageConfigDTO.TableSchemaDTO).', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'required' => true, 'example' => 'happen_time'], + 'Type' => ['title' => '', 'description' => 'The column type.', 'type' => 'string', 'required' => true, 'example' => 'date'], + 'ElementType' => ['title' => '', 'description' => 'The array element subtype.', 'type' => 'string', 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => 'The maximum array capacity.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Pk' => ['title' => '', 'description' => 'Indicates whether the column is a primary key.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'Comment' => ['title' => '', 'description' => 'The column comment.', 'type' => 'string', 'example' => '录入时间'], + 'Url' => ['title' => '', 'description' => 'Indicates whether the column is a URL.', 'type' => 'boolean', 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'multimodal-embedding-v1'], + 'Dimension' => ['title' => '', 'description' => 'The embedding dimension.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance'], + 'IndexType' => ['title' => '', 'description' => 'The index type.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters.', 'type' => 'object', 'example' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The creator ID.', 'type' => 'string', 'example' => '***'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2025-11-13T02:11:56Z'], + 'GmtModified' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'format' => 'date-time', 'example' => '1749450490000'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'LockOwner' => ['title' => '', 'description' => 'The ID of the development owner.', 'type' => 'string', 'example' => '300001391'], + 'LockOwnerName' => ['title' => '', 'description' => 'The display name of the development owner on the interface.', 'type' => 'string', 'example' => '张三'."\n"], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get a dataset', + 'summary' => 'Retrieves a dataset. Release version: v6.2.0.', + 'description' => 'Queries the details of a tested connectivity task based on the data source ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"DatasetDTO\\": {\\n \\"Id\\": 7255018404425088,\\n \\"ProjectId\\": 7255013756724992,\\n \\"ProjectName\\": \\"ds_tm\\",\\n \\"Name\\": \\"audio_dataset\\",\\n \\"FileId\\": 7255018404650688,\\n \\"Directory\\": \\"/\\",\\n \\"DataCellId\\": \\"78201\\",\\n \\"DataCellName\\": \\"离线数据主题域\\",\\n \\"Type\\": \\"HYBRID\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"MetadataStorageType\\": \\"POSTGRESQL\\",\\n \\"Scenario\\": \\"OFFLINE\\",\\n \\"ContentType\\": \\"GENERAL\\",\\n \\"OwnerList\\": [\\n {\\n \\"UserId\\": \\"300001391\\",\\n \\"UserName\\": \\"张三\\"\\n }\\n ],\\n \\"Creator\\": \\"300001391\\",\\n \\"CreatorName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2026-04-28 10:03:49\\",\\n \\"GmtModified\\": \\"2026-04-28 10:03:49\\",\\n \\"Description\\": \\"测试数据集\\",\\n \\"TenantId\\": 300001413,\\n \\"VersionList\\": [\\n {\\n \\"Id\\": 7280840713415040,\\n \\"DatasetId\\": 7280832407583104,\\n \\"Version\\": \\"V4\\",\\n \\"DataVersionConfig\\": {\\n \\"VersionDescription\\": \\"测试数据集版本\\",\\n \\"FileStorageConfig\\": {\\n \\"DataSourceId\\": \\"7445343860022804608\\",\\n \\"DataSourceName\\": \\"测试数据源\\",\\n \\"DevPath\\": \\"HTML正文提取/test423/\\",\\n \\"ProdPath\\": \\"HTML正文提取/test423/\\",\\n \\"MountPath\\": \\"/var/run/openresty/cache/corp\\"\\n },\\n \\"MetadataStorageConfig\\": {\\n \\"MetadataStorageMode\\": \\"CREATE\\",\\n \\"MetadataStorageType\\": \\"MILVUS\\",\\n \\"DataSourceId\\": \\"7429133693081710272\\",\\n \\"DataSourceName\\": \\"测试数据源\\",\\n \\"DevSchema\\": \\"HTML正文提取/test423/\\",\\n \\"ProdSchema\\": \\"HTML正文提取/test423/\\",\\n \\"TableName\\": \\"s_crm_all_plt_jala_shop\\",\\n \\"TableSchema\\": {\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"id\\",\\n \\"Type\\": \\"int8\\",\\n \\"ElementType\\": \\"INT64\\",\\n \\"MaxCapacity\\": 35,\\n \\"Pk\\": true,\\n \\"Comment\\": \\"主键\\",\\n \\"Url\\": false,\\n \\"VectorIndexConfig\\": {\\n \\"EmbeddingModel\\": \\"MultiModal-Embedding\\",\\n \\"Dimension\\": 0,\\n \\"IndexType\\": \\"AUTOINDEX\\",\\n \\"SimilarityType\\": \\"COSINE\\",\\n \\"IndexParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n }\\n },\\n \\"RealtimeMetaTableConfig\\": {\\n \\"ProjectId\\": 7255013756724992,\\n \\"MetaTableName\\": \\"测试元表\\",\\n \\"DatasourceType\\": \\"KAFKA\\",\\n \\"TableSchema\\": {\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"happen_time\\",\\n \\"Type\\": \\"date\\",\\n \\"ElementType\\": \\"INT64\\",\\n \\"MaxCapacity\\": 5,\\n \\"Pk\\": false,\\n \\"Comment\\": \\"录入时间\\",\\n \\"Url\\": false,\\n \\"VectorIndexConfig\\": {\\n \\"EmbeddingModel\\": \\"multimodal-embedding-v1\\",\\n \\"Dimension\\": 0,\\n \\"IndexType\\": \\"AUTOINDEX\\",\\n \\"SimilarityType\\": \\"COSINE\\",\\n \\"IndexParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"Creator\\": \\"***\\",\\n \\"GmtCreate\\": \\"2025-11-13T02:11:56Z\\",\\n \\"GmtModified\\": \\"1749450490000\\"\\n }\\n ],\\n \\"LockOwner\\": \\"300001391\\",\\n \\"LockOwnerName\\": \\"张三\\\\n\\"\\n }\\n}","type":"json"}]', ], - 'GetPipelineById' => [ - 'summary' => '根据管道任务id查询管道任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'GetDevObjectDependency' => [ + 'summary' => 'Query upstream dependencies of development objects.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20261,893 +14748,631 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Object ID.', 'type' => 'string', 'required' => true, 'example' => '7026498387616064'], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Development object type.'."\n" + .'- FILE_ID: Task FileId'."\n" + .'- MODEL_ID: Logical table', 'type' => 'string', 'required' => true, 'example' => '7026498387616064'], + ], + [ + 'name' => 'ObjectFrom', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Development object source.'."\n" + .'- BLACK_BOX: Logical table'."\n" + .'- DATA_PROCESS: Compute task'."\n" + .'- PIPELINE: Integration task', 'type' => 'string', 'required' => true, 'example' => 'DATA_PROCESS'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7021037162911616L'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'title' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'DevObjectDependencyList' => [ + 'title' => '', + 'description' => 'Dependency list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Dependency.', + 'type' => 'object', + 'properties' => [ + 'ScheduleType' => ['title' => '', 'description' => 'Schedule type.'."\n" + .'- MINUTELY: Minute'."\n" + .'- HOURLY: Hour'."\n" + .'- DAILY: Day'."\n" + .'- WEEKLY: Week'."\n" + .'- MONTHLY: Month'."\n" + .'- YEARLY: Year', 'type' => 'string', 'example' => 'DAILY'], + 'NodeName' => ['title' => '', 'description' => 'Node name.', 'type' => 'string', 'example' => 'xx测试'], + 'ProjectName' => ['title' => '', 'description' => 'Project name.', 'type' => 'string', 'example' => 'xx测试'], + 'NodeOutputTableName' => ['title' => '', 'description' => 'Output table information.', 'type' => 'string', 'example' => 't_xx'], + 'DependencyPeriod' => [ + 'title' => '', + 'description' => 'Dependency period configuration.', + 'type' => 'object', + 'properties' => [ + 'PeriodType' => ['title' => '', 'description' => 'Dependency period type.'."\n" + .'- CURRENT_PERIOD'."\n" + .'- LAST_PERIOD'."\n" + .'- LAST_N_PERIOD'."\n" + .'- LAST_24_HOUR', 'type' => 'string', 'example' => 'CURRENT_PERIOD'], + 'PeriodOffset' => ['title' => '', 'description' => 'Period offset. This parameter is required when the dependency period type is LAST_N_PERIOD.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'NodeOutputName' => ['title' => '', 'description' => 'Node output name.', 'type' => 'string', 'example' => 'n_xx'], + 'ManuallyAdd' => ['title' => '', 'description' => 'Indicates whether the dependency is manually added.', 'type' => 'boolean', 'example' => 'false'], + 'BizUnitId' => ['title' => '', 'description' => 'Business unit ID.', 'type' => 'string', 'example' => '13111'], + 'CustomCronExpression' => ['title' => '', 'description' => 'Indicates whether a custom cron expression is used for the scheduling node.', 'type' => 'boolean', 'example' => 'true'], + 'DependencyStrategy' => ['title' => '', 'description' => 'Dependency strategy.'."\n" + .'- ALL'."\n" + .'- FIRST'."\n" + .'- LAST'."\n" + .'- NEAR', 'type' => 'string', 'example' => 'ALL'], + 'BizUnitName' => ['title' => '', 'description' => 'Business unit name.', 'type' => 'string', 'example' => 'xx测试'], + 'EffectFieldList' => [ + 'title' => '', + 'description' => 'Effect fields.', + 'type' => 'array', + 'items' => ['description' => 'Effect field.', 'type' => 'string', 'example' => '112', 'title' => ''], + 'example' => '', + ], + 'CronExpression' => ['title' => '', 'description' => 'Cron expression for the scheduling node.', 'type' => 'string', 'example' => '0 0 0 * * ?'], + 'SubBizType' => ['title' => '', 'description' => 'Sub-business type.'."\n" + .'- MAX_COMPUTE_SQL'."\n" + .'- HIVE_SQL'."\n" + .'- SHELL'."\n" + .'- PYTHON'."\n" + .'- ONE_SERVICE_SQL'."\n" + .'- DATABASE_SQL, etc.', 'type' => 'string', 'example' => 'SHELL'], + 'DimMidNode' => ['title' => '', 'description' => 'Indicates whether the node is a dimension table intermediate node.', 'type' => 'boolean', 'example' => 'true'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123131'], + 'BizType' => ['title' => '', 'description' => 'Business type.'."\n" + .'- SCRIPT: Script'."\n" + .'- LOGICAL_TABLE: Logical table', 'type' => 'string', 'example' => 'SCRIPT'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'Node owners.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => '11123'], + 'Name' => ['title' => '', 'description' => 'Node name.', 'type' => 'string', 'example' => 'xx测试'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'SelfDepend' => ['title' => '', 'description' => 'Indicates whether the node has a self-dependency.', 'type' => 'boolean', 'example' => 'true'], + 'DependFieldList' => [ + 'title' => '', + 'description' => 'Dependency fields.', + 'type' => 'array', + 'items' => ['description' => 'Dependency field.', 'type' => 'string', 'example' => '121', 'title' => ''], + 'example' => '', + ], + 'ExternalBizInfo' => ['title' => '', 'description' => 'Additional business information.', 'type' => 'string', 'example' => '所有字段信息/hasProd/hasDev等信息'], + 'PeriodDiff' => ['title' => '', 'description' => 'Dependency period difference.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Valid' => ['title' => '', 'description' => 'Indicates whether the configuration is valid.', 'type' => 'boolean', 'example' => 'true'], + 'NodeType' => ['title' => '', 'description' => 'Node type.'."\n" + .'- DATA_PROCESS: Code task'."\n" + .'- BBOX_LOGIC_TABLE_NODE: Black box logical table node'."\n" + .'- ONE_ID_LABEL: ID label node'."\n" + .'- ONE_ID_RULE: ID rule node'."\n" + .'- PIPELINE_NODE: Pipeline node', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'NodeId' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => 'n_13211'], + 'OutputContextParamList' => [ + 'title' => '', + 'description' => 'Cross-node output parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'Cross-node output parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Parameter key.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'xxtest', 'title' => ''], + 'DefaultValue' => ['description' => 'Default value.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AutoParse' => ['title' => '', 'description' => 'Indicates whether the task is automatically parsed.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Query Upstream Dependencies of Development Objects', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'QueryId', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '用户查询管道任务的Id', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeId' => [ - 'title' => '支持使用集成任务调度节点nodeId查询', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '支持使用集成管道主键pipelineId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '支持使用集成任务文件fileId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDevObjectDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, ], ], ], + ], + 'GetDirectoryTree' => [ + 'summary' => 'Retrieves the folder directory tree.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['Dataphin公共云'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Directory type.'."\n" + .'- Ad-hoc Query: tempCode'."\n" + .'- Code Task: codeManage'."\n" + .'- Offline Pipeline: offlinePipeline'."\n" + .'- Pipeline Custom Component: offlinePipelineCustomPlugin'."\n" + .'- Sync Task: dataX'."\n" + .'- Real-time Meta Table: streamMeta'."\n" + .'- Real-time Custom Source: streamCustomDataSource'."\n" + .'- Real-time Compute Template: streamTemplate'."\n" + .'- Resource Management: resourceManage'."\n" + .'- Offline Function: udfResource'."\n" + .'- Real-time Function: streamFunction', 'type' => 'string', 'required' => true, 'example' => 'codeManage'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ - 'title' => '管道任务详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ScheduleConfig' => [ - 'title' => '集成管道调度配置，json字符串，通过工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.vo.OAScheduleConfigVO进行反序列化', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'StepType' => [ - 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'example' => 'input', - ], - 'StepName' => [ - 'title' => '步骤名称，在同一个管道任务所有步骤名称不能重复', - 'description' => '', - 'type' => 'string', - 'example' => 'mysql_reader', - ], - 'IsDistribute' => [ - 'title' => '用于表示当前组件有多个下游组件时当前组件数据的分发方式：'."\n" - .'true-表示当前组件的数据轮流发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游各有50条数据，默认为true，'."\n" - .'false-表示当前组件的数据全量发送到所有下游，例如当前组件有100条数据，有两个下游，则两个下游都有100条数据', - 'description' => '', - 'type' => 'boolean', - ], - 'Key' => [ - 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'example' => 'mysqlinput', - ], - ], - ], - ], - 'Hops' => [ - 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '集成管道输入输出组件关系配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '输出步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'example' => 'odps_writer', - ], - 'SendTo' => [ - 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', - 'description' => '', - 'type' => 'boolean', - ], - 'Source' => [ - 'title' => '输入步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'example' => 'mysql_reader', - ], - ], - ], + 'title' => '', + 'description' => 'Directory tree information. Returns the directory tree with all edge information, traversed level by level from the root node.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Tree node pair.', + 'type' => 'object', + 'properties' => [ + 'Parent' => [ + 'title' => '', + 'description' => 'Parent node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Directory ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'StringId' => ['title' => '', 'description' => 'Directory string ID.', 'type' => 'string', 'example' => '3', 'default' => 'null'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7081229106458752'], + 'CategoryType' => ['title' => '', 'description' => 'Directory type.', 'type' => 'string', 'example' => 'codeManage'], + 'DataCellId' => ['title' => '', 'description' => 'Data cell ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3213', 'default' => 'null'], + 'DirName' => ['title' => '', 'description' => 'Directory path. Valid only for file or resource nodes.', 'type' => 'string', 'example' => '/'], + 'Name' => ['title' => '', 'description' => 'Display name of the object.', 'type' => 'string', 'example' => '代码管理'], + 'Type' => ['title' => '', 'description' => 'Object type.', 'type' => 'string', 'example' => 'codeManage'], + 'Creator' => ['title' => '', 'description' => 'Creator ID.', 'type' => 'string', 'example' => '300000907'], + 'CreatorName' => ['title' => '', 'description' => 'Creator name.', 'type' => 'string', 'example' => 'John'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time. Empty for non-entity object nodes.', 'type' => 'string', 'example' => '2024-11-01 18:08:17'], + 'GmtModified' => ['title' => '', 'description' => 'Modification time. Empty for non-entity object nodes.', 'type' => 'string', 'example' => '2024-11-01 18:08:17'], + 'LastModifier' => ['title' => '', 'description' => 'Last modifier ID.', 'type' => 'string', 'example' => '300000907'], + 'LastModifierName' => ['title' => '', 'description' => 'Last modifier name.', 'type' => 'string', 'example' => 'John'], ], + 'example' => '', ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'FileId' => [ - 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Directory' => [ - 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', - 'description' => '', - 'type' => 'string', - 'example' => '/', + 'Children' => [ + 'title' => '', + 'description' => 'Child node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Directory ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'StringId' => ['title' => '', 'description' => 'Directory string ID.', 'type' => 'string', 'example' => '3', 'default' => 'null'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7081229106458752'], + 'CategoryType' => ['title' => '', 'description' => 'Directory type.', 'type' => 'string', 'example' => 'codeManage'], + 'DataCellId' => ['title' => '', 'description' => 'Data cell ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '41342'], + 'DirName' => ['title' => '', 'description' => 'Directory path. Valid only for file or resource nodes.', 'type' => 'string', 'example' => '/'], + 'Name' => ['title' => '', 'description' => 'Display name of the object.', 'type' => 'string', 'example' => '代码管理'], + 'Type' => ['title' => '', 'description' => 'Object type.', 'type' => 'string', 'example' => 'codeManage'], + 'Creator' => ['title' => '', 'description' => 'Creator ID.', 'type' => 'string', 'example' => '300000907'], + 'CreatorName' => ['title' => '', 'description' => 'Creator name.', 'type' => 'string', 'example' => 'John'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time. Empty for non-entity object nodes.', 'type' => 'string', 'example' => '2024-11-01 18:08:17'], + 'GmtModified' => ['title' => '', 'description' => 'Modification time. Empty for non-entity object nodes.', 'type' => 'string', 'example' => '2024-11-01 18:08:17'], + 'LastModifier' => ['title' => '', 'description' => 'Last modifier ID.', 'type' => 'string', 'example' => '300000907'], + 'LastModifierName' => ['title' => '', 'description' => 'Last modifier name.', 'type' => 'string', 'example' => 'John'], ], + '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' => '', - 'type' => 'string', - 'example' => '{}', - ], + 'example' => '', ], - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Get Folder Directory Tree', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'OfflinePipeline' => [ - 'summary' => '下线集成管道任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDirectoryTree', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetFileStorageCredential' => [ + 'summary' => 'Obtains temporary read/write authorization for file storage.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID. This parameter is required when the temporary authorization is used to create resource files.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1030131021'], ], [ - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '支持使用集成管道主键pipelineId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '支持使用集成任务文件fileId查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, - ], + 'name' => 'UseVpcEndpoint', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to use an internal endpoint. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Purpose', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The purpose of the authorization. Valid values:'."\n" + ."\n" + .'- RESOURCE: creates resource files.'."\n" + .'- COMPUTE_SOURCE_SETTING: stores compute source configurations.'."\n" + .'- NONE: no specific purpose.'."\n" + ."\n" + .'Default value: NONE.', 'type' => 'string', 'required' => false, 'example' => 'RESOURCE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '管道下线结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'StorageCredential' => [ + 'title' => '', + 'description' => 'The details of the temporary read/write authorization.', 'type' => 'object', 'properties' => [ - 'SubmitId' => [ - 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'HostMachine' => [ - 'title' => '服务端执行机器名称和ip', - 'description' => '', - 'type' => 'string', - 'example' => 'hostName:hostIp', - ], - 'Version' => [ - 'title' => '提交后生成的版本号', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'NodeId' => [ - 'title' => '创建成功后的管道任务调度节点Id', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'PipelineId' => [ - 'title' => '创建成功后的管道ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'StorageType' => ['title' => '', 'description' => 'The storage cluster type. Valid values: oss and ceph.', 'type' => 'string', 'example' => 'oss'], + 'Endpoint' => ['title' => '', 'description' => 'The endpoint.', 'type' => 'string', 'example' => 'oss-cn-shanghai.aliyuncs.com'], + 'Bucket' => ['title' => '', 'description' => 'The file storage bucket.', 'type' => 'string', 'example' => 'dataphin'], + 'Region' => ['title' => '', 'description' => 'region', 'type' => 'string', 'example' => 'cn-shanghai'], + 'AccessId' => ['title' => '', 'description' => 'The temporary AccessKey ID.', 'type' => 'string', 'example' => 'temp.akId'], + 'AccessKey' => ['title' => '', 'description' => 'The temporary AccessKey ID.', 'type' => 'string', 'example' => 'temp.akKey'], + 'ObjectName' => ['title' => '', 'description' => 'The storage object.', 'type' => 'string', 'example' => '1023231111/abc'], + 'Expiration' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '17343434343434'], + 'SecurityToken' => ['title' => '', 'description' => 'The temporary security token.', 'type' => 'string', 'example' => 'temp.token'], ], - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Obtain temporary read/write authorization for file storage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreatePipeline' => [ - 'summary' => '创建集成管道任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'GetInstanceDownStream' => [ + 'summary' => 'Queries the downstream instances of a specified instance.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', + 'name' => 'InstanceGet', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], + 'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 't_5929472_20210411_9577721'], + 'NodeType' => ['title' => '', 'description' => 'Node type of the instance.'."\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, + 'title' => '', + 'example' => '', ], ], [ - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], - 'StepType' => [ - 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Key' => [ - 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysqlinput', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Hops' => [ - 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '集成管道输入输出组件关系配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '输出步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'odps_writer', - ], - 'SendTo' => [ - 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Source' => [ - 'title' => '输入步骤名称，即Steps[*].StepName', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'Directory' => [ - 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - ], - 'required' => true, - ], - 'PipelineType' => [ - 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Mode' => [ - 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PIPELINE', - ], - 'Submit' => [ - 'title' => '是否提交，默认提交', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'PipelineJson' => [ - 'title' => '脚本模式下：集成管道配置（json字符串格式）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Settings' => [ - 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - 'required' => true, - ], + 'name' => 'RunStatus', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Run status of the instance.'."\n" + .'- INIT'."\n" + .'- WATING'."\n" + .'- RUNNING'."\n" + .'- SUCCESS'."\n" + .'- FAILED', 'type' => 'string', 'example' => 'SUCCESS', 'required' => false], + ], + [ + 'name' => 'DownStreamDepth', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Number of levels to expand downstream in the DAG query. Valid values: 1 to 6.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Environment identifier.'."\n" + .'- DEV: Development environment.'."\n" + .'- PROD (default): Production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '集成管道任务创建结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SubmitId' => [ - 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'HostMachine' => [ - 'title' => '服务端执行机器名称和ip', - 'description' => '', - 'type' => 'string', - 'example' => 'hostName:hostIp', - ], - 'Version' => [ - 'title' => '提交后生成的版本号', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'NodeId' => [ - 'title' => '创建成功后的管道任务调度节点Id', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'PipelineId' => [ - 'title' => '创建成功后的管道ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'InstanceRelationList' => [ + 'title' => '', + 'description' => 'Downstream instances and dependency relationships.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Downstream instances and dependency relationships.', + 'type' => 'object', + 'properties' => [ + 'InstanceInfo' => [ + 'title' => '', + 'description' => 'Instance information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 't_232411'], + 'Name' => ['title' => '', 'description' => 'Instance name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'Node type.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + ], + 'example' => '', + ], + 'SelectStatus' => ['title' => '', 'description' => 'Selection status of the instance, primarily used for logical fields.'."\n" + .'- OPTIONAL: Optional.'."\n" + .'- SELECTED: Required.'."\n" + .'- DISABLE: Not selectable.'."\n" + .'- GROUP_SELECTED: Select all or deselect all.', 'type' => 'string', 'example' => 'OPTIONAL'], + 'SelectStatusCause' => ['title' => '', 'description' => 'Reason why the instance is selected.'."\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' => '', 'description' => 'Run status of the instance.', 'type' => 'string', 'example' => 'RUNNING'], + 'FieldInstanceList' => [ + 'description' => 'Field instance list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SelectStatus' => ['description' => 'Selection status of the instance.', 'type' => 'string', 'example' => 'OPTIONAL', 'title' => ''], + 'FieldInstanceId' => ['description' => 'Field instance ID.', 'type' => 'string', 'example' => 't_23211', 'title' => ''], + 'RunStatus' => ['description' => 'Run status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DownStreamDepth' => ['title' => '', 'description' => 'Depth level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExtendInfo' => ['title' => '', 'description' => 'Extended information of the node instance.', 'type' => 'string', 'example' => '{"a":"x"}'], ], + 'example' => '', ], - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Get Downstream Instance List', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetPipelineAsyncResult' => [ - 'summary' => '查询异步操作管道任务的执行结果。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetInstanceDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'GetInstanceUpDownStream' => [ + 'summary' => 'Queries the dag of an instance. Logical tables and code nodes are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21155,887 +15380,843 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', + 'name' => 'InstanceId', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'title' => '', + 'description' => 'The center node.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 't_123456'], + 'FieldInstanceIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs. This parameter can be specified when the node is a logical table instance ID. If this parameter is not specified, the full table is used by default.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123'], + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'AsyncId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '异步执行Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1001121'], + ], + [ + 'name' => 'UpStreamDepth', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of upstream node levels. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DownStreamDepth', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of downstream node levels. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '异步执行结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'InstanceDagInfo' => [ + 'title' => '', + 'description' => 'The instance dag data, including the current instance and its upstream and downstream instances.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '当前执行状态：SUCCESS-执行成功，FAILED-执行失败，RUNNING-执行中', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'SubmitId' => [ - 'title' => '管道任务提交后的带发布ID，通过发布域进行发布', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'n_123', - ], - 'AsyncId' => [ - 'title' => '异步执行查询Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'PipelineId' => [ - 'title' => '管道主键ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'StartInstanceList' => [ + 'title' => '', + 'description' => 'The center instances.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The center instances.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 't_1234567'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1234567'], + 'NodeType' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- DATA_PROCESS: code node.'."\n" + .'- BBOX_LOGIC_TABLE_NODE: logical table node.'."\n" + .'- PIPELINE_NODE: pipeline node.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldInstanceIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'example' => '1011', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], - 'ErrorCode' => [ - 'title' => '执行异常时异常码', - 'description' => '', - 'type' => 'string', - 'example' => 'DPN.Pipeline.InnerError', + 'UpInstanceList' => [ + 'title' => '', + 'description' => 'The upstream instances.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The upstream instances.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 't_1234567'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1234567'], + 'NodeType' => ['title' => '', 'description' => 'The node type.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldInstanceIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'example' => '1021', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], - 'ErrorMessage' => [ - 'title' => '执行异常时异常信息', - 'description' => '', - 'type' => 'string', - 'example' => 'NullPointException', + 'DownInstanceList' => [ + 'title' => '', + 'description' => 'The downstream instances.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The downstream instances.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 't_1234567'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1234567'], + 'NodeType' => ['title' => '', 'description' => 'The node type.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldInstanceIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'example' => '1031', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], ], - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query the dag of an instance', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreatePipelineByAsync' => [ - 'summary' => '异步创建集成管道任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetInstanceUpDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'GetLatestSubmitDetail' => [ + 'summary' => 'Retrieves the details of the latest pending submit record.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', + 'name' => 'SubmitDetailQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'title' => '', + 'description' => 'The pending submit query request.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], + 'ObjectId' => ['title' => '', 'description' => 'The object ID.', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'ObjectType' => ['title' => '', 'description' => 'The object type.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE_SQL'], ], 'required' => true, + 'example' => '', ], ], - [ - 'name' => 'CreateCommand', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '创建管道任务配置', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'ScheduleConfig' => [ - 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"cronExpression":"0 0 0 * * ?"}', - ], - 'Comment' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], - 'PipelineConfig' => [ - 'title' => '集成管道组件配置', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'SubmitDetailResult' => [ + 'title' => '', + 'description' => 'The pending submit details.', '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], - 'StepType' => [ - 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Key' => [ - 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysqlinput', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Hops' => [ - 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '集成管道输入输出组件关系配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '输出步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'odps_writer', - ], - 'SendTo' => [ - 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Source' => [ - 'title' => '输入步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysql_reader', + 'Id' => ['title' => '', 'description' => 'The submit record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'SubmitStatus' => ['title' => '', 'description' => 'The submit status. Valid values: '."\n" + ."\n" + .'- TO_BE_PUBLISHED: pending.'."\n" + ."\n" + .'- PUBLISHED: published.'."\n" + ."\n" + .'- PUBLISHING: publishing.', 'type' => 'string', 'example' => 'TO_BE_PUBLISHED'], + 'PublishStatus' => ['title' => '', 'description' => 'The publish status. Valid values: '."\n" + .'- NOT_VERIFIED: not verified.'."\n" + .'- APPROVING: approval in progress.'."\n" + .'- APPROVE_FAILED: approval failed.'."\n" + .'- APPROVE_SUCCESS: approval succeeded.'."\n" + .'- APPROVE_REVOKED: approval revoked.'."\n" + .'- CHECKING: publish verification in progress.'."\n" + .'- CHECK_FAILED: publish verification failed.'."\n" + .'- CHECK_SUCCESS: publish verification succeeded.'."\n" + .'- PUBLISHING: publishing in progress.'."\n" + .'- FAILED: publish failed.'."\n" + .'- SUCCESS: publish succeeded.', 'type' => 'string', 'example' => 'SUCCESS'], + 'Tag' => ['title' => '', 'description' => 'The record tag.', 'type' => 'string', 'example' => 'tag'], + 'ReleaseObject' => [ + 'title' => '', + 'description' => 'The pending submit record object.', + 'type' => 'object', + 'properties' => [ + 'ObjectVersion' => ['title' => '', 'description' => 'The object version.', 'type' => 'string', 'example' => '1'], + 'ChangeType' => ['title' => '', 'description' => 'The change type. Valid values: CREATE, UPDATE, and DELETE.', 'type' => 'string', 'example' => 'DELETE'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_1234'], + 'SubmitComment' => ['title' => '', 'description' => 'The submit comment.', 'type' => 'string', 'example' => '提交说明'], + 'SubmitObject' => [ + 'title' => '', + 'description' => 'The submit object.', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => ['title' => '', 'description' => 'The object ID.', 'type' => 'string', 'example' => '1234'], + 'ObjectType' => ['title' => '', 'description' => 'The object type.', 'type' => 'string', 'example' => 'MAX_COMPUTE_SQL'], + 'ObjectName' => ['title' => '', 'description' => 'The object name.', 'type' => 'string', 'example' => 'abc'], ], + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'Directory' => [ - 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/', + 'example' => '', ], ], - 'required' => true, - ], - 'PipelineType' => [ - 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Mode' => [ - 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PIPELINE', - ], - 'Submit' => [ - 'title' => '是否提交，默认提交', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'PipelineJson' => [ - 'title' => '脚本模式下：集成管道配置（json字符串格式）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Settings' => [ - 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'example' => '', ], ], - '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', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '异步执行查询Id', - 'description' => '', - '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.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Get latest submit details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetLatestSubmitDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetMyRoles' => [ + 'summary' => 'Retrieves the list of roles for the current user.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'RoleList' => [ + 'description' => 'The list of roles.', + 'type' => 'array', + 'items' => [ + 'description' => 'The role.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The role ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '300047957'], + 'Name' => ['title' => '', 'description' => 'The role name.', 'type' => 'string', 'example' => 'dataphinAdmin'], + 'Description' => ['title' => '', 'description' => 'The role description.', 'type' => 'string', 'example' => 'dataphin管理员'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve the role list of the current user', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdatePipeline' => [ - 'summary' => '更新集成管道任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetMyRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'GetMyTenants' => [ + 'summary' => 'Retrieves the tenants to which the current user belongs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Context', + 'name' => 'FeatureCodeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '请求上下文信息', - 'description' => '', + 'title' => '', + 'description' => 'The feature codes owned by the tenant.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The feature code.', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_STREAM'], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '集成管道任务所属项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'Env' => [ - 'title' => '当前操作环境env：DEV-表示操作开发环境，PROD-表示操作生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'TenantList' => [ + 'title' => '', + 'description' => 'The list of tenants.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The tenant details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '132311'], + 'Name' => ['title' => '', 'description' => 'The tenant name.', 'type' => 'string', 'example' => 'xx测试'], + 'OwnerId' => ['title' => '', 'description' => 'The ID of the user to whom the tenant belongs.', 'type' => 'string', 'example' => '21323231'], + 'Description' => ['title' => '', 'description' => 'The tenant description.', 'type' => 'string', 'example' => 'xx 测试'], + 'Deleted' => ['title' => '', 'description' => 'Indicates whether the tenant is deleted.', 'type' => 'boolean', 'example' => 'false'], + 'DeleteTime' => ['title' => '', 'description' => 'The time when the tenant was deleted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'TitleType' => ['title' => '', 'description' => 'The title type of the tenant.', 'type' => 'string', 'example' => 'icon'], + 'OpsTenant' => ['title' => '', 'description' => 'Indicates whether the tenant is an O&M tenant.', 'type' => 'boolean', 'example' => 'false'], + 'ResourceLimited' => ['title' => '', 'description' => 'Indicates whether resource quota calculation is performed.', 'type' => 'boolean', 'example' => 'false'], + 'Visible' => ['title' => '', 'description' => 'Indicates whether the tenant is visible.', 'type' => 'boolean', 'example' => 'true'], + 'TenantTypeList' => [ + 'title' => '', + 'description' => 'The tenant types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The tenant types.', 'type' => 'string', 'example' => 'application'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], ], - 'required' => true, + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Retrieve tenants of the current user', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:36:14.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetMyTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetNodeUpDownStream' => [ + 'summary' => 'Queries the dag of a node. This is a general-purpose operation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'UpdateCommand', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'NodeId', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新管道任务配置', - 'description' => '', + 'title' => '', + 'description' => 'The node ID.', 'type' => 'object', 'properties' => [ - 'ScheduleConfig' => [ - 'title' => '调度配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"cronExpression":"0 0 0 * * ?"}', - ], - 'Comment' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], - 'PipelineConfig' => [ - 'title' => '集成管道组件配置', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => '11313'], + 'FieldIdList' => ['title' => '', 'description' => 'This parameter can be specified when the node ID is a logical table node ID. If this parameter is not specified, the full table is used by default.', 'type' => 'string', 'required' => false, 'example' => '12'], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '113123'], + ], + [ + 'name' => 'UpStreamDepth', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The upstream depth. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DownStreamDepth', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The downstream depth. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'NodeDagInfo' => [ + 'title' => '', + 'description' => 'The dag data of the node.', 'type' => 'object', 'properties' => [ - 'Steps' => [ - 'title' => '组件配置：包含所有用到的组件详细配置', - 'description' => '', + 'StartNodeList' => [ + 'title' => '', + 'description' => 'The center nodes.', 'type' => 'array', 'items' => [ - 'title' => '组件具体配置', - 'description' => '', + 'title' => '', + 'description' => 'The node.', 'type' => 'object', 'properties' => [ - 'PluginConfig' => [ - 'title' => '具体组件配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig相关子类的toJsonString方法。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], - 'StepType' => [ - 'title' => '组件类型：input-表示输入组件，output-表示输出组件，transfrom-表示转换组件，process-表示流程控制组件，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Key' => [ - 'title' => '插件ID，每个插件都有唯一的标志，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey。开发者应继承该组件配置类，实现相应组件配置，每个组件配置与Dataphin页面创建的管道配置结构相同', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysqlinput', + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- DATA_PROCESS: code task.'."\n" + .'- BBOX_LOGIC_TABLE_NODE: logical table node.'."\n" + .'- PIPELINE_NODE: pipeline node.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => '123'], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], - 'required' => true, + 'example' => '', ], - 'Hops' => [ - 'title' => 'DAG有向无环图链接配置：描述所有组件的连接关系', - 'description' => '', + 'UpStreamNodeList' => [ + 'title' => '', + 'description' => 'The upstream nodes.', 'type' => 'array', 'items' => [ - 'title' => '集成管道输入输出组件关系配置', - 'description' => '', + 'title' => '', + 'description' => 'The node.', 'type' => 'object', 'properties' => [ - 'Target' => [ - 'title' => '输出步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'odps_writer', - ], - 'SendTo' => [ - 'title' => '针对条件分发组件，连接下游条件为true时设置为true，否则设置为false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- DATA_PROCESS: code task.'."\n" + .'- BBOX_LOGIC_TABLE_NODE: black box logical table node.'."\n" + .'- PIPELINE_NODE: pipeline node.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => '123'], + 'example' => '', ], - 'Source' => [ - 'title' => '输入步骤名称，即Steps[*].StepName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mysql_reader', + ], + 'example' => '', + ], + 'example' => '', + ], + 'DownStreamNodeList' => [ + 'title' => '', + 'description' => 'The downstream nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- DATA_PROCESS: code task.'."\n" + .'- BBOX_LOGIC_TABLE_NODE: logical table node.'."\n" + .'- PIPELINE_NODE: pipeline node.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => '123'], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], - 'required' => true, + 'example' => '', ], ], - 'required' => true, - ], - 'NodeInfo' => [ - 'title' => '集成管道任务基本信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeName' => [ - 'title' => '集成管道任务名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'NodeId' => [ - 'title' => '管道任务调度节点ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_123', - ], - 'PipelineId' => [ - 'title' => '管道任务ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'FileId' => [ - 'title' => '管道文件ID，首次创建为空，更新管道任务时，pipelineId、fileId、nodeId至少配置一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'Directory' => [ - 'title' => '集成管道任务节点目录（默认为根目录），该目录必须存在，如若不存在，则需要调用相关接口创建类型为offlinePipeline的目录', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - ], - 'required' => true, - ], - 'PipelineType' => [ - 'title' => '管道任务类型：0-表示离线集成（默认），1-表示实时集成', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Mode' => [ - 'title' => '集成管道配置模式：PIPELINE-表示管道模式（默认），JSON-表示脚本模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PIPELINE', - ], - 'Submit' => [ - 'title' => '是否提交，默认提交', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'PipelineJson' => [ - 'title' => '脚本模式下：集成管道配置（json字符串格式）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Settings' => [ - 'title' => '通道配置，格式为JSON字符串，参考工具类：com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting#toJsonString方法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Get node dag', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetNodeUpDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetOperationRecordById' => [ + 'summary' => 'Queries an operation log by ID. Available since v6.2.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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'DetailCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The query command.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'OperationId' => ['title' => '', 'description' => 'The operation log ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '987654321'], + ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '管道任务更新结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'OperationLogDTO' => [ + 'title' => '', + 'description' => 'The operation log details.', 'type' => 'object', 'properties' => [ - 'SubmitId' => [ - 'title' => '提交管道生成的待发布列表的submitId，通过发布域进行发布', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'HostMachine' => [ - 'title' => '服务端执行机器名称和ip', - 'description' => '', - 'type' => 'string', - 'example' => 'hostName:hostIp', - ], - 'Version' => [ - 'title' => '提交后生成的版本号', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'NodeId' => [ - 'title' => '创建成功后的管道任务调度节点Id', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'PipelineId' => [ - 'title' => '创建成功后的管道ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'Id' => ['title' => '', 'description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => '测试任务'], + 'ObjectType' => ['title' => '', 'description' => 'The object type.', 'type' => 'string', 'example' => 'onedata-ide'], + 'CodeType' => ['title' => '', 'description' => 'The code type. Valid values:'."\n" + .'- SQL0: SQL'."\n" + .'- shell1: Shell'."\n" + .'- Python2: Python'."\n" + .'- MR3: MR'."\n" + .'- Spark4: Spark', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Status' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + .'- 4: Running.'."\n" + .'- 5: Succeeded.'."\n" + .'- 6: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'BeginTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2025-01-15 10:30:00'], + 'Runner' => ['title' => '', 'description' => 'The ID of the runner.', 'type' => 'string', 'example' => '30231123'], + 'RunnerName' => ['title' => '', 'description' => 'The name of the runner.', 'type' => 'string', 'example' => '张三'], + 'RelationTables' => [ + 'title' => '', + 'description' => 'The list of related tables.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'ods_test_table'], + 'example' => '', ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211'], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'], + 'OperationId' => ['title' => '', 'description' => 'The operation log ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '987654321'], + 'Duration' => ['title' => '', 'description' => 'The execution duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], ], - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get an operation log by ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"OperationLogDTO\\": {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"测试任务\\",\\n \\"ObjectType\\": \\"onedata-ide\\",\\n \\"CodeType\\": 0,\\n \\"Status\\": 5,\\n \\"BeginTime\\": \\"2025-01-15 10:30:00\\",\\n \\"Runner\\": \\"30231123\\",\\n \\"RunnerName\\": \\"张三\\",\\n \\"RelationTables\\": [\\n \\"ods_test_table\\"\\n ],\\n \\"ProjectId\\": 131211211,\\n \\"TenantId\\": 10001,\\n \\"OperationId\\": 987654321,\\n \\"Duration\\": 120\\n }\\n}","type":"json"}]', ], - 'CreatePipelineNode' => [ - 'summary' => '创建数据集成任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetOperationRecordDetail' => [ + 'summary' => 'Queries the details of an execution record. Released in version v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -22043,216 +16224,101 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreatePipelineNodeCommand', + 'name' => 'RecordDetailCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建pipeline管道,支持离线管道和实时管道', - 'description' => '', + 'title' => '', + 'description' => 'The query command.', 'type' => 'object', 'properties' => [ - 'PipelineName' => [ - 'title' => '管道名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_pipeline', - ], - 'PipelineType' => [ - 'title' => '管道类型[OFFLINE_PIPELINE,REAL_TIME_PIPELINE]', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'REAL_TIME_PIPELINE', - 'enum' => [ - 'OFFLINE_PIPELINE', - 'REAL_TIME_PIPELINE', - ], - ], - 'NodeType' => [ - 'title' => '管道类型[NORMAL,MANUAL,REAL_TIME]', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7091124176569088', - ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'OperationId' => ['title' => '', 'description' => 'The operation record ID.', 'type' => 'string', 'required' => true, 'example' => '987654321'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '管道节点信息', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'OperationRecordDetailResponse' => [ + 'title' => '', + 'description' => 'The execution record detail response.', 'type' => 'object', 'properties' => [ - 'PipelineId' => [ - 'title' => '创建成功后的管道ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33749', - ], - 'ErrorCodeList' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'DPN.Pipeline.Config.ErrorReason', - ], - ], - 'ErrorMessageList' => [ - 'title' => '异常信息', - 'description' => '', + 'OperationId' => ['title' => '', 'description' => 'The operation record ID.', 'type' => 'string', 'example' => '987654321'], + 'LogContent' => ['title' => '', 'description' => 'The log content.', 'type' => 'string', 'example' => 'Task started...'."\n" + .'Executing SQL...'."\n" + .'Task finished successfully.'], + 'Results' => [ + 'title' => '', + 'description' => 'The list of execution results.', 'type' => 'array', 'items' => [ - 'title' => '异常消息', - 'description' => '', - 'type' => 'string', - 'example' => '管道配置错误：{0}', + 'title' => '', + 'description' => 'The execution result entry.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'The result content.', 'type' => 'string', 'example' => '{"count":100,"data":[{"id":1}]}'], + 'Index' => ['title' => '', 'description' => 'The result index.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Title' => ['title' => '', 'description' => 'The result title.', 'type' => 'string', 'example' => '查询结果'], + 'Sql' => ['title' => '', 'description' => 'The result SQL statement.', 'type' => 'string', 'example' => 'SELECT * FROM test_table'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'task_123456'], + ], + 'example' => '', ], + 'example' => '', ], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query execution record details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"OperationRecordDetailResponse\\": {\\n \\"OperationId\\": \\"987654321\\",\\n \\"LogContent\\": \\"Task started...\\\\nExecuting SQL...\\\\nTask finished successfully.\\",\\n \\"Results\\": [\\n {\\n \\"Result\\": \\"{\\\\\\"count\\\\\\":100,\\\\\\"data\\\\\\":[{\\\\\\"id\\\\\\":1}]}\\",\\n \\"Index\\": 0,\\n \\"Title\\": \\"查询结果\\",\\n \\"Sql\\": \\"SELECT * FROM test_table\\",\\n \\"TaskId\\": \\"task_123456\\"\\n }\\n ],\\n \\"FileId\\": 12113111\\n }\\n}","type":"json"}]', ], - 'UpdateBatchTaskUdfLineages' => [ - 'summary' => '编辑离线计算任务自定义血缘。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetOperationRecordRunCode' => [ + 'summary' => 'Queries the execution code of an operation log. Online version: v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -22260,1101 +16326,670 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'CodeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '编辑指令', - 'description' => '', + 'title' => '', + 'description' => 'The query command.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '任务所属项目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dev', - ], - 'FullTable' => [ - 'title' => '是否选择全表', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - ], - 'ColumnList' => [ - 'title' => '血缘字段列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘相关字段集合: 跟FullTable二选一，默认全表', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dev', - ], - 'FullTable' => [ - 'title' => '是否选择全表', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - ], - 'ColumnList' => [ - 'title' => '血缘字段列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘相关字段集合: 跟FullTable二选一，默认全表', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'column1', - ], - 'required' => true, - ], - ], - 'required' => true, - ], - 'required' => true, - ], - ], - 'required' => true, - ], - 'required' => true, + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'OperationId' => ['title' => '', 'description' => 'The operation log ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '987654321'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'OperationLogCodeResponse' => [ + 'title' => '', + 'description' => 'The operation log code response.', + 'type' => 'object', + 'properties' => [ + 'OperatorId' => ['title' => '', 'description' => 'The operator ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'Code' => ['title' => '', 'description' => 'The code content.', 'type' => 'string', 'example' => 'SELECT * FROM test_table WHERE id = 1;'], + 'OperatorName' => ['title' => '', 'description' => 'The operator name.', 'type' => 'string', 'example' => 'SQL查询节点'], + 'SqlNum' => ['title' => '', 'description' => 'The number of SQL statements.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query operation log execution code', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"OperationLogCodeResponse\\": {\\n \\"OperatorId\\": 123,\\n \\"Code\\": \\"SELECT * FROM test_table WHERE id = 1;\\",\\n \\"OperatorName\\": \\"SQL查询节点\\",\\n \\"SqlNum\\": 1\\n }\\n}","type":"json"}]', + ], + 'GetOperationSubmitStatus' => [ + 'summary' => 'Queries the submit status of a data backfill request.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The job ID returned after submission in batch mode.', 'type' => 'string', 'required' => true, 'example' => '1324444131'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: Development environment. '."\n" + .'- PROD (default): Production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'OperationSubmitJob' => [ + 'title' => '', + 'description' => 'The submit status of the operation.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['title' => '', 'description' => 'The submit ID of the data backfill request.', 'type' => 'string', 'example' => '123456'], + 'Progress' => ['title' => '', 'description' => 'The progress.', 'type' => 'string', 'example' => '80'], + 'Operation' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n" + .'- SUPPLY_DATA: data backfill.', 'type' => 'string', 'example' => 'SUPPLY_DATA'], + 'OperationStatus' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS'], + 'ExternalBizId' => ['title' => '', 'description' => 'The business ID. If the operation is a data backfill, this value is the data backfill workflow ID.', 'type' => 'string', 'example' => 'f_122_232342'], + 'Operator' => ['title' => '', 'description' => 'The user ID of the submitter.', 'type' => 'string', 'example' => '132344'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Get data backfill workflow submit status', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateBatchTask' => [ - 'summary' => '编辑离线计算任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetOperationSubmitStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPhysicalInstance' => [ + 'summary' => 'Gets instance information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 't_23231'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2323131'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Environment identifier.'."\n" + .'DEV: Development environment.'."\n" + .'PROD (default): Production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '编辑请求', - 'description' => '', + 'title' => '', + 'description' => 'Response', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '任务所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10121101', - ], - 'Name' => [ - 'title' => '离线任务名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test111', - ], - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PYTHON3_7', - ], - 'SchedulePeriod' => [ - 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], - 'CronExpression' => [ - 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 1 * * ?', - ], - 'CustomScheduleConfig' => [ - 'title' => '自定义调度间隔配置', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'Instance' => [ + 'title' => '', + 'description' => 'Instance details', 'type' => 'object', 'properties' => [ - 'SchedulePeriod' => [ - 'title' => '调度周期', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAILY', + 'Id' => ['title' => '', 'description' => 'Instance ID', 'type' => 'string', 'example' => 't_23231'], + 'BizDate' => ['title' => '', 'description' => 'Business date', 'type' => 'string', 'example' => '2023-06-25'], + 'DueTime' => ['title' => '', 'description' => 'Scheduled time', 'type' => 'string', 'example' => '2023-06-27 00:30:00'], + 'StatusList' => [ + 'title' => '', + 'description' => 'Status list', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Status', 'type' => 'string', 'example' => 'SUCCESS'], + 'example' => '', ], - 'Interval' => [ - 'title' => '自定义间隔', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'IntervalUnit' => [ - 'title' => '间隔单位：MINUTE、HOUR', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOUR', - ], - 'StartTime' => [ - 'title' => '开始时间: HH:mm', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '08:00', - ], - 'EndTime' => [ - 'title' => '结束时间: HH:mm', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'NodeStatus' => [ - 'title' => '节点状态: 正常 1、暂停 2、空跑 3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'TaskType' => [ - 'title' => '任务类型: Hive_SQL: 1、MaxCompute_SQL: 5、Shell 10、Python 21', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '21', - ], - 'UpStreamList' => [ - 'title' => '上游依赖', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点关联', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeType' => [ - 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PHYSICAL', - ], - 'SourceNodeId' => [ - 'title' => '上游节点Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CURRENT_PERIOD', - ], - 'PeriodOffset' => [ - 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'DependStrategy' => [ - 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LAST', - ], - 'SourceNodeEnabled' => [ - 'title' => '上游节点是否生效', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - ], - 'required' => true, - ], - 'required' => false, - ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'erp', - ], - 'PythonModuleList' => [ - 'title' => '任务依赖python三方包', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'python三方包', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'numpy', - ], - 'required' => false, - ], - 'SparkClientInfo' => [ - 'title' => 'spark客户端', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SparkClientVersion' => [ - 'title' => 'spark客户端版本名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'StartExecuteTime' => ['title' => '', 'description' => 'Start execution time', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-27 01:30:00'], + 'EndExecuteTime' => ['title' => '', 'description' => 'End execution time', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-27 02:30:00'], + 'Duration' => ['title' => '', 'description' => 'Execution duration', 'type' => 'string', 'example' => '3600s'], + 'Index' => ['title' => '', 'description' => 'Running instance index', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'Node details', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Node ID', 'type' => 'string', 'example' => 'n_3232312'], + 'From' => ['title' => '', 'description' => 'Source system of the node', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'Type' => ['title' => '', 'description' => 'Node type'."\n" + .'- BBOX_LOGIC_TABLE_NODE: Logical table node'."\n" + .'- BBOX_LOGIC_FIELD_NODE: Logical field node'."\n" + .'- BBOX_LOGIC_FIELD_GROUP_NODE: Field group node'."\n" + .'- BBOX_INNER_TEMP_NODE: Logical table temp node'."\n" + .'- DATA_PROCESS: Code task'."\n" + .'- STREAM_TASK_NODE: Real-time task'."\n" + .'- PIPELINE_NODE: Pipeline node'."\n" + .'- FLINK_BATCH: Flink batch task'."\n" + .'- ODM_NODE: ODM node', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'Name' => ['title' => '', 'description' => 'Node name', 'type' => 'string', 'example' => 'xx测试'], + 'SubDetailType' => ['title' => '', 'description' => 'Sub-business type'."\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' => 'Description', 'type' => 'string', 'example' => 'xx 测试'], + 'DryRun' => ['title' => '', 'description' => 'Indicates whether this is a dry run.', 'type' => 'boolean', 'example' => 'false'], + 'SchedulePaused' => ['title' => '', 'description' => 'Indicates whether scheduling is paused.', 'type' => 'boolean', 'example' => 'false'], + 'HasProd' => ['title' => '', 'description' => 'Indicates whether the production environment exists.', 'type' => 'boolean', 'example' => 'true'], + 'HasDev' => ['title' => '', 'description' => 'Indicates whether the development environment exists.', 'type' => 'boolean', 'example' => 'true'], + 'PriorityList' => [ + 'title' => '', + 'description' => 'Priority'."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Priority', 'type' => 'string', 'example' => 'MIDDLE'], + 'example' => '', + ], + 'ResourceGroupList' => [ + 'title' => '', + 'description' => 'Resource group list', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Resource group', 'type' => 'string', 'example' => 'rs_group_test'], + 'example' => '', + ], + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'Scheduling period'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Scheduling period', 'type' => 'string', 'example' => 'DAILY'], + 'example' => '', + ], + 'BizUnitName' => ['title' => '', 'description' => 'Business unit name', 'type' => 'string', 'example' => 'xx'], + 'Creator' => [ + 'title' => '', + 'description' => 'Creator', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '2323111'], + 'Name' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'Modifier' => [ + 'title' => '', + 'description' => 'Modifier', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '2323111'], + 'Name' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'OwnerList' => [ + 'title' => '', + 'description' => 'Owner list', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Owner', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '2323111'], + 'Name' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2023-02-02 23:53:17'], + 'LastModifiedTime' => ['title' => '', 'description' => 'Last modified time', 'type' => 'string', 'example' => '2024-02-02 23:53:17'], + ], + 'example' => '', ], + 'ExtendInfo' => ['title' => '', 'description' => 'Extended information', 'type' => 'string', 'example' => 'xx'], ], - 'required' => false, + 'example' => '', ], ], - 'required' => true, + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Get instance information', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetPhysicalInstanceLog' => [ + 'summary' => 'Retrieves the execution logs of an instance. If the instance has been rerun multiple times, multiple log entries are returned.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 't_5929472_20210411_9577721'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123131'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: Development environment. '."\n" + .'- PROD (default): Production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'UpdateResult' => [ - 'title' => '编辑结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12113111', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'TaskrunLogList' => [ + 'title' => '', + 'description' => 'All execution logs of the instance, including logs from multiple reruns.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskrunId' => ['title' => '', 'description' => 'The task ID for each run.', 'type' => 'string', 'example' => 'tr_23231'], + 'StartTime' => ['title' => '', 'description' => 'The time when the task started running.', 'type' => 'string', 'example' => '2024-05-30 16:47:13'], + 'EndTime' => ['title' => '', 'description' => 'The time when the task finished running.', 'type' => 'string', 'example' => '2024-05-30 16:48:13'], + 'LogContent' => ['title' => '', 'description' => 'The execution log content. This value is empty if the task has not been run.', 'type' => 'string', 'example' => 'xx'], + 'Status' => ['title' => '', 'description' => 'The execution status.', 'type' => 'string', 'example' => 'SUCCESS'], + 'Duration' => ['title' => '', 'description' => 'The execution duration of the task. Unit: seconds.', 'type' => 'string', 'example' => '60s'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve instance execution logs', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'SubmitBatchTask' => [ - 'summary' => '提交离线计算任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPhysicalNode' => [ + 'summary' => 'Queries a physical schedule resource.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SubmitCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_232132'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '编辑请求', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '任务所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10121101', - ], - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PYTHON3_7', - ], - 'SchedulePeriod' => [ - 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], - 'CronExpression' => [ - 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 1 * * ?', - ], - 'CustomScheduleConfig' => [ - 'title' => '自定义调度间隔配置', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'The node details.', 'type' => 'object', 'properties' => [ - 'SchedulePeriod' => [ - 'title' => '调度周期', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAILY', - ], - 'Interval' => [ - 'title' => '自定义间隔', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'IntervalUnit' => [ - 'title' => '间隔单位：MINUTE、HOUR', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOUR', - ], - 'StartTime' => [ - 'title' => '开始时间: HH:mm', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10:00', - ], - 'EndTime' => [ - 'title' => '结束时间: HH:mm', - 'description' => '', - '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', + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_232132'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => '节点名称'], + 'Description' => ['title' => '', 'description' => 'The node description.', 'type' => 'string', 'example' => 'xx测试'], + 'OperatorType' => ['title' => '', 'description' => 'The node subtype. Valid values:'."\n" + .'- MAX_COMPUTE_SQL'."\n" + .'- HIVE_SQL'."\n" + .'- SHELL'."\n" + .'- PYTHON'."\n" + .'- ONE_SERVICE_SQL'."\n" + .'- DATABASE_SQL and others.', 'type' => 'string', 'example' => 'SHELL'], + 'ScheduleType' => ['title' => '', 'description' => 'The scheduling cycle type. Valid values:'."\n" + .'- MINUTELY'."\n" + .'- HOURLY'."\n" + .'- DAILY'."\n" + .'- WEEKLY'."\n" + .'- MONTHLY'."\n" + .'- QUARTERLY.', 'type' => 'string', 'example' => 'DAILY'], + 'Priority' => ['title' => '', 'description' => 'The scheduling priority. Valid values:'."\n" + ."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST.', 'type' => 'string', 'example' => 'MIDDLE'], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'The project to which the node belongs.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'example' => '102132'], + 'Name' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'xx测试'], ], + 'example' => '', ], - 'required' => true, - ], - 'required' => false, - ], - 'Priority' => [ - 'title' => '任务调度优先级, 1-9值越大表示优先级越低', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'NodeStatus' => [ - 'title' => '节点状态: 正常 1、暂停 2、空跑 3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'UpStreamList' => [ - 'title' => '上游依赖', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点关联', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeType' => [ - 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PHYSICAL', - ], - 'SourceNodeId' => [ - 'title' => '上游节点Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CURRENT_PERIOD', - ], - 'PeriodOffset' => [ - 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, + 'Creator' => [ + 'title' => '', + 'description' => 'The node creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '101312'], + 'Name' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], ], + 'example' => '', ], - 'required' => true, - ], - 'required' => false, - ], - 'PythonModuleList' => [ - 'title' => '任务依赖python三方包', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'python三方包', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'numpy', - ], - 'required' => false, - ], - 'SparkClientInfo' => [ - 'title' => 'spark客户端', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SparkClientVersion' => [ - 'title' => 'spark客户端版本名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'Owner' => [ + 'title' => '', + 'description' => 'The node owner.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '101312', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'SubmitResult' => [ - 'title' => '编辑结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeId' => [ - 'title' => '任务调度节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_12113111', + 'Modifier' => [ + 'title' => '', + 'description' => 'The user who last modified the node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '101312', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', ], - 'SubmitId' => [ - 'title' => '待发布对象Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1010312911', + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'LastModifiedTime' => ['title' => '', 'description' => 'The time of the last modification.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'Status' => ['title' => '', 'description' => 'The scheduling status.', 'type' => 'string', 'example' => 'SUCCESS'], + 'TriggerConfig' => ['title' => '', 'description' => 'The trigger configuration, which is used to implement field-level dependencies on logical tables.', 'type' => 'string', 'example' => '{"expression":"any_success"}'], + 'From' => ['title' => '', 'description' => 'The node source. Valid values:'."\n" + .'- DATA_PROCESS: code development.'."\n" + .'- BLACK_BOX: modeling development.'."\n" + .'- PIPELINE: pipeline.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression used to calculate the scheduling time.', 'type' => 'string', 'example' => '0 0 10 * * *'], + 'OutputNameList' => [ + 'title' => '', + 'description' => 'The list of output names.', + 'type' => 'array', + 'items' => ['description' => 'The output name.', 'type' => 'string', 'example' => 'xxtest', 'title' => ''], + 'example' => '', ], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The data source schema. This parameter takes effect only for data source types that require a schema, such as Oracle. If set to "default", the value is null.', 'type' => 'string', 'example' => 'null'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query a physical schedule resource', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ParseBatchTaskDependency' => [ - 'summary' => '解析离线计算任务的逻辑表依赖，注意解析结果上游依赖信息中可能包含自依赖节点（上游节点ID和解析代码的任务节点ID相同）需要用户自己进行处理。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPhysicalNodeByOutputName' => [ + 'summary' => 'Queries a physical node by output name. Only offline code nodes and integration task nodes are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23362,399 +16997,254 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], - 'Code' => [ - 'title' => '待解析的SQL代码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'select * from t_test limit 1;', - ], - 'IncludeAllInputTables' => [ - 'title' => '包含未找到对应节点的输入表的依赖信息, 默认 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'NeedQueryLineages' => [ - 'title' => '查询上游依赖时是否查询血缘数据, 默认 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'OperatorType' => [ - 'title' => '任务类型: MAX_COMPUTE_SQL等', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxCompute_SQL', - ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'erp', - ], - ], - 'required' => true, - ], + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Node output name', 'type' => 'string', 'required' => true, 'example' => 't_test'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Environment identifier'."\n" + .'- DEV: Development environment'."\n" + .'- PROD (default): Production environment', 'type' => 'string', 'required' => false, 'example' => 'PROD'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ParseResult' => [ - 'title' => '解析结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'Node details', 'type' => 'object', 'properties' => [ - 'DependNodeList' => [ - 'title' => '依赖节点', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '依赖节点', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeIoType' => [ - 'title' => '输入输出类型: 依赖节点 input、节点输出名 output', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '201122301', - ], - 'OwnerName' => [ - 'title' => '节点owner, 当未找到对应输入表的节点时为空', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'NodeId' => [ - 'title' => '节点名称, 当未找到对应输入表的节点时为-1', - 'description' => '', - 'type' => 'string', - 'example' => 'n_11013121', - ], - 'NodeName' => [ - 'title' => '节点名称, 当未找到对应输入表的节点时为空', - 'description' => '', - 'type' => 'string', - 'example' => 'test11', - ], - ], - ], - ], - ], + 'Id' => ['title' => '', 'description' => 'Node ID', 'type' => 'string', 'example' => 'n_2321'], + 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'xx测试'], + 'OperatorType' => ['title' => '', 'description' => 'Node subtype'."\n" + .'- MAX_COMPUTE_SQL'."\n" + .'- HIVE_SQL'."\n" + .'- SHELL'."\n" + .'- PYTHON'."\n" + .'- ONE_SERVICE_SQL'."\n" + .'- DATABASE_SQL, etc.', 'type' => 'string', 'example' => 'SHELL'], + 'ScheduleType' => ['title' => '', 'description' => 'Scheduling period type'."\n" + .'- MINUTELY'."\n" + .'- HOURLY'."\n" + .'- DAILY'."\n" + .'- WEEKLY'."\n" + .'- MONTHLY'."\n" + .'- YEARLY', 'type' => 'string', 'example' => 'DAILY'], + 'Priority' => ['title' => '', 'description' => 'Priority'."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST', 'type' => 'string', 'example' => 'MIDDLE'], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'Project to which the node belongs', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Project ID', 'type' => 'string', 'example' => '1324211', 'title' => ''], + 'Name' => ['description' => 'Project name', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'Creator' => [ + 'title' => '', + 'description' => 'Node creator', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'User ID', 'type' => 'string', 'example' => '1311131', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'Owner' => [ + 'title' => '', + 'description' => 'Node owner', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'User ID', 'type' => 'string', 'example' => '1311131', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'Modifier' => [ + 'title' => '', + 'description' => 'Node modifier', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'User ID', 'type' => 'string', 'example' => '1311131', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], ], + 'example' => '', ], + 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'LastModifiedTime' => ['title' => '', 'description' => 'Last modified time', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'Status' => ['title' => '', 'description' => 'Node scheduling status', 'type' => 'string', 'example' => 'SUCCESS'], + 'TriggerConfig' => ['title' => '', 'description' => 'Trigger configuration, used to implement field dependencies on logical tables', 'type' => 'string', 'example' => '{"expression":"any_success"}'], + 'From' => ['title' => '', 'description' => 'Node source'."\n" + .'- DATA_PROCESS: Code development'."\n" + .'- BLACK_BOX: Black box'."\n" + .'- ONE_ID: Extraction'."\n" + .'- PIPELINE: Pipeline', 'type' => 'string', 'example' => 'DATA_PROCESS'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query a physical node by output name', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'OfflineBatchTask' => [ - 'summary' => '下线离线计算任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeByOutputName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPhysicalNodeContent' => [ + 'summary' => 'Queries the code content of a schedule resource node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FileId', + 'name' => 'NodeId', 'in' => 'query', - 'schema' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12113111', - ], + 'schema' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_232411'], ], [ - 'name' => 'Comment', + 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'title' => '下线操作备注', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test xx', - ], + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: Development environment. '."\n" + .'- PROD (default): Production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'OfflineResult' => [ - 'title' => '下线结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The node information.', 'type' => 'object', 'properties' => [ - 'PublishObjectId' => [ - 'title' => '待发布对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10211123', - ], + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_232411'], + 'NodeName' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'CodeContent' => ['title' => '', 'description' => 'The node code content.', 'type' => 'string', 'example' => 'select 1;'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query schedule resource node code content', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBatchTaskUdfLineages' => [ - 'summary' => '获取离线任务自定义血缘。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPhysicalNodeOperationLog' => [ + 'summary' => 'Queries the operation logs of a node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23762,411 +17252,109 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', + 'name' => 'NodeId', 'in' => 'query', - 'schema' => [ - 'title' => '任务所属项目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], + 'schema' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_231131'], ], [ - 'name' => 'FileId', + 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12113111', - ], + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '103111231', - ], - 'BizUnitName' => [ - 'title' => '板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'Env' => [ - 'title' => '环境 prod/dev', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'SubType' => [ - 'title' => '表子类型: 维度逻辑表 dim', - 'description' => '', - 'type' => 'string', - 'example' => 'dim', - ], - 'FullTable' => [ - 'title' => '是否选择全表', - 'description' => '', - 'type' => 'boolean', - ], - 'ColumnList' => [ - 'title' => '血缘字段列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘字段', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '字段Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '103111231', - ], - 'BizUnitName' => [ - 'title' => '板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'Env' => [ - 'title' => '环境 prod/dev', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'SubType' => [ - 'title' => '表子类型: 维度逻辑表 dim', - 'description' => '', - 'type' => 'string', - 'example' => 'dim', - ], - 'FullTable' => [ - 'title' => '是否选择全表', - 'description' => '', - 'type' => 'boolean', - ], - 'ColumnList' => [ - 'title' => '血缘字段列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘字段', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '字段Id', - 'description' => '', - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'OperationLogList' => [ + 'title' => '', + 'description' => 'The node operation logs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node operation log information.', + 'type' => 'object', + 'properties' => [ + 'Context' => ['title' => '', 'description' => 'The log details.', 'type' => 'string', 'example' => 'xx'], + 'OperationType' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n" + .'- TASK_UPDATE_PRIORITY: updates the node priority.'."\n" + .'- PAUSE_TASK: pauses scheduling.'."\n" + .'- RESUME_TASK: resumes scheduling.'."\n" + .'- CREATE_NODE: creates a node.'."\n" + .'- FORCE_DELETE_NODE: force deletes a node.'."\n" + .'- UPDATE_NODE: updates a node.'."\n" + .'- DELETE_NODE: deletes a node.'."\n" + .'- CHANGE_NODE_OWNER: changes the node owner.', 'type' => 'string', 'example' => 'PAUSE_TASK'], + 'Operator' => ['title' => '', 'description' => 'The operator ID.', 'type' => 'string', 'example' => '132222'], + 'OperationTime' => ['title' => '', 'description' => 'The operation time.', 'type' => 'string', 'example' => '2024-05-30 16:47:13'], + 'OperatorName' => ['title' => '', 'description' => 'The operator name.', 'type' => 'string', 'example' => 'xx测试'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query node operation logs', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBatchTaskVersions' => [ - 'summary' => '获取离线计算任务版本列表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeOperationLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPipelineAsyncResult' => [ + 'summary' => 'Queries the execution result of an asynchronous pipeline task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -24174,195 +17362,97 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '任务所属项目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline task belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The current operation environment. Valid values:'."\n" + .'- DEV: development environment.'."\n" + .'- PROD: production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '131211211', + 'example' => '', ], ], [ - 'name' => 'FileId', + 'name' => 'AsyncId', 'in' => 'query', - 'schema' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12113111', - ], + 'schema' => ['title' => '', 'description' => 'The asynchronous execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ - 'title' => '请求结果', - 'description' => '', + 'title' => '', + 'description' => 'The asynchronous execution result.', 'type' => 'object', 'properties' => [ - 'BatchTaskVersionList' => [ - 'title' => '离线计算任务版本列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '离线计算任务版本', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeId' => [ - 'title' => '节点Id', - 'description' => '', - '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' => '', - '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', - ], - ], - ], - ], + 'Status' => ['title' => '', 'description' => 'The current execution status. Valid values:'."\n" + .'- SUCCESS: execution succeeded.'."\n" + .'- FAILED: execution failed.'."\n" + .'- RUNNING: execution in progress.', 'type' => 'string', 'example' => 'SUCCESS'], + 'SubmitId' => ['title' => '', 'description' => 'The publish ID generated after the pipeline task is submitted. You can use this ID to publish the task through the publish domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'HostMachine' => ['title' => '', 'description' => 'The information about the server host that processes the execution request.', 'type' => 'string', 'example' => 'hostName:hostIp'], + 'Version' => ['title' => '', 'description' => 'The version number generated when the pipeline task is submitted.', 'type' => 'string', 'example' => '1'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline task.', 'type' => 'string', 'example' => 'n_123'], + 'AsyncId' => ['title' => '', 'description' => 'The asynchronous execution query ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'PipelineId' => ['title' => '', 'description' => 'The primary key ID of the pipeline.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code returned when the execution fails.', 'type' => 'string', 'example' => 'DPN.Pipeline.InnerError'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message returned when the execution fails.', 'type' => 'string', 'example' => 'NullPointException'], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Query asynchronous execution result', + 'extraInfo' => 'For usage details, refer to the demo in the utility toolkit: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetBatchTaskInfoByVersion' => [ - 'summary' => '获取离线计算任务指定版本任务详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetPipelineById' => [ + 'summary' => 'Queries a pipeline task by pipeline task ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -24370,493 +17460,167 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务所属项目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '131211211', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FileId', - 'in' => 'query', + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline task belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The current operating environment. Valid values:'."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '12113111', + 'example' => '', ], ], [ - 'name' => 'VersionId', - 'in' => 'query', + 'name' => 'QueryId', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The ID used to query the pipeline task.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'Supports querying by the integration task scheduling node ID (nodeId).', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'Supports querying by the integration pipeline primary key (pipelineId).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'Supports querying by the integration task file ID (fileId).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'TaskInfo' => [ - 'title' => '任务详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The pipeline task details.', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12113111', - ], - 'Name' => [ - 'title' => '任务名称', - 'description' => '', - 'type' => 'string', - 'example' => '测试任务1', - ], - 'Status' => [ - 'title' => '发布状态: 草稿0、已提交1、开发中100', - 'description' => '', - 'type' => 'string', - 'example' => '测试任务1', - ], - 'Published' => [ - 'title' => '是否已发布', - 'description' => '', - 'type' => 'boolean', - ], - 'NeedPublish' => [ - 'title' => '是否需要发布', - 'description' => '', - 'type' => 'boolean', - ], - 'HasDevNode' => [ - 'title' => '是否有开发环境节点', - 'description' => '', - 'type' => 'boolean', - ], - 'NodeId' => [ - 'title' => '节点Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30231123', - ], - 'OwnerName' => [ - 'title' => '节点负责人名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'OperatorUserId' => [ - 'title' => '当前操作的用户id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SchedulePeriod' => [ - 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'CronExpression' => [ - 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', - 'description' => '', - 'type' => 'string', - 'example' => '0 0 1 * * ?', - ], - 'CustomScheduleConfig' => [ - 'title' => '自定义调度间隔配置', - 'description' => '', + 'ScheduleConfig' => ['title' => '', 'description' => 'The schedule configuration of the integration pipeline. The value is a JSON string. Deserialize it by using the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.vo.OAScheduleConfigVO.', 'type' => 'string', 'example' => '{}'], + 'PipelineConfig' => [ + 'title' => '', + 'description' => 'The component configuration of the integration pipeline.', 'type' => 'object', 'properties' => [ - 'SchedulePeriod' => [ - 'title' => '调度周期', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'Interval' => [ - 'title' => '自定义间隔', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IntervalUnit' => [ - 'title' => '间隔单位：MINUTE、HOUR', - 'description' => '', - 'type' => 'string', - 'example' => 'HOUR', - ], - 'StartTime' => [ - 'title' => '开始时间: HH:mm', - 'description' => '', - 'type' => 'string', - 'example' => '08:00', - ], - 'EndTime' => [ - 'title' => '结束时间: HH:mm', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NodeStatus' => [ - 'title' => '节点状态: 正常 1、暂停 2、空跑 3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Paused' => [ - 'title' => '节点是否被暂停调度', - 'description' => '', - 'type' => 'boolean', - ], - 'NodeFrom' => [ - 'title' => '节点来源,节点由某个组织或应用创建的', - 'description' => '', - 'type' => 'string', - 'example' => 'openapi', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '131211211', - ], - 'UpStreamList' => [ - 'title' => '上游依赖', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点关联', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeType' => [ - 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', - 'description' => '', - 'type' => 'string', - 'example' => 'PHYSICAL', - ], - 'SourceNodeId' => [ - 'title' => '上游节点Id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FieldList' => [ - 'title' => '依赖的逻辑表字段', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '依赖的逻辑表字段', - 'description' => '', - 'type' => 'string', - 'example' => 'column1', + 'Steps' => [ + 'title' => '', + 'description' => 'The component configurations, including detailed configurations of all components used.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The specific component configuration.', + 'type' => 'object', + 'properties' => [ + 'PluginConfig' => ['title' => '', 'description' => 'The specific component configuration in JSON string format. Refer to the toJsonString method of the subclasses of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig. Developers should inherit this component configuration class and implement the corresponding component configuration. Each component configuration has the same structure as the pipeline configuration created on the Dataphin console.', 'type' => 'string', 'example' => '{}'], + 'StepType' => ['title' => '', 'description' => 'The component type. Valid values:'."\n" + .'- input: an input component.'."\n" + .'- output: an output component.'."\n" + .'- transfrom: a transformation component.'."\n" + .'- process: a flow control component.'."\n" + .'Refer to the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType. Developers should inherit this component configuration class and implement the corresponding component configuration. Each component configuration has the same structure as the pipeline configuration created on the Dataphin console.', 'type' => 'string', 'example' => 'input'], + 'StepName' => ['title' => '', 'description' => 'The step name. Step names must be unique within the same pipeline task.', 'type' => 'string', 'example' => 'mysql_reader'], + 'IsDistribute' => ['title' => '', 'description' => 'Specifies the data distribution method when the current component has multiple downstream components. Valid values:'."\n" + .'- true: The data of the current component is sent to all downstream components in a round-robin manner. For example, if the current component has 100 records and two downstream components, each downstream component receives 50 records. Default value: true.'."\n" + .'- false: The full data of the current component is sent to all downstream components. For example, if the current component has 100 records and two downstream components, each downstream component receives 100 records.', 'type' => 'boolean', 'example' => ''], + 'Key' => ['title' => '', 'description' => 'The plugin ID. Each plugin has a unique identifier. Refer to the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey. Developers should inherit this component configuration class and implement the corresponding component configuration. Each component configuration has the same structure as the pipeline configuration created on the Dataphin console.', 'type' => 'string', 'example' => 'mysqlinput'], ], + 'example' => '', ], - 'DependPeriod' => [ - 'title' => '依赖周期', - 'description' => '', + 'example' => '', + ], + 'Hops' => [ + 'title' => '', + 'description' => 'The DAG (directed acyclic graph) link configuration that describes the connections between all components.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The input-output component relationship configuration of the integration pipeline.', 'type' => 'object', 'properties' => [ - 'PeriodType' => [ - 'title' => '依赖周期类型: CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', - 'description' => '', - 'type' => 'string', - 'example' => 'CURRENT_PERIOD', - ], - 'PeriodOffset' => [ - 'title' => '周期偏移量, LAST_N_PERIOD时须传值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Target' => ['title' => '', 'description' => 'The output step name, which corresponds to Steps[*].StepName.', 'type' => 'string', 'example' => 'odps_writer'], + 'SendTo' => ['title' => '', 'description' => 'For conditional distribution components, set this parameter to true when the downstream condition is true. Otherwise, set it to false.', 'type' => 'boolean', 'example' => ''], + 'Source' => ['title' => '', 'description' => 'The input step name, which corresponds to Steps[*].StepName.', 'type' => 'string', 'example' => 'mysql_reader'], ], + 'example' => '', ], - 'DependStrategy' => [ - 'title' => '依赖策略: ALL,FIRST,LAST,NEAR', - 'description' => '', - 'type' => 'string', - 'example' => 'LAST', - ], - 'SourceNodeEnabled' => [ - 'title' => '上游节点是否生效', - 'description' => '', - 'type' => 'boolean', - ], + 'example' => '', ], ], + 'example' => '', ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'string', - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'example' => 'erp', - ], - 'SparkClientInfo' => [ - 'title' => 'spark客户端信息', - 'description' => '', + 'NodeInfo' => [ + 'title' => '', + 'description' => 'The basic information of the pipeline task.', 'type' => 'object', 'properties' => [ - 'SparkClientVersion' => [ - 'title' => 'spark客户端版本名称', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], + 'Desc' => ['description' => 'The task description.', 'type' => 'string', 'title' => '', 'example' => 'comment'], + 'NodeName' => ['title' => '', 'description' => 'The name of the integration pipeline task.', 'type' => 'string', 'example' => 'test'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline task. This parameter is empty when the task is first created. When updating a pipeline task, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'string', 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The pipeline task ID. This parameter is empty when the task is first created. When updating a pipeline task, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'The pipeline file ID. This parameter is empty when the task is first created. When updating a pipeline task, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Directory' => ['title' => '', 'description' => 'The folder of the integration pipeline task node. The default value is the root folder. The folder must exist. If it does not exist, call the relevant API operation to create a folder of the offlinePipeline type.', 'type' => 'string', 'example' => '/'], ], + 'example' => '', ], + 'PipelineType' => ['title' => '', 'description' => 'The pipeline task type.', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'Mode' => ['title' => '', 'description' => 'The configuration mode of the integration pipeline.', 'type' => 'string', 'example' => 'PIPELINE'], + 'PipelineJson' => ['title' => '', 'description' => 'The script mode configuration of the integration pipeline.', 'type' => 'string', 'example' => '{}'], + 'Settings' => ['title' => '', 'description' => 'The channel configuration of the integration pipeline. The value is a JSON string. Deserialize it by using the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting.', 'type' => 'string', 'example' => '{}'], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false,\\n \\"Key\\": \\"mysqlinput\\"\\n }\\n ],\\n \\"Hops\\": [\\n {\\n \\"Target\\": \\"odps_writer\\",\\n \\"SendTo\\": false,\\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' => 'Query a pipeline task by ID', + 'extraInfo' => 'For usage details, refer to the demo in the supporting tool package: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetBatchTaskInfo' => [ - 'summary' => '获取离线计算任务详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProject' => [ + 'summary' => 'Get project details by project ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -24864,871 +17628,300 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant 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', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12113111', - ], + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12356'], ], [ 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'title' => '环境标识: dev、prod，默认值为dev', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dev', - ], - ], - [ - 'name' => 'IncludeAllUpStreams', - 'in' => 'query', - 'schema' => [ - 'title' => '是否包含完整的上游节点（包括无效依赖），默认false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Project environment. Valid values:'."\n" + .' - DEV: development environment.'."\n" + .' - PROD: production environment.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'TaskInfo' => [ - 'title' => '任务详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'The project details.', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12113111', - ], - 'Name' => [ - 'title' => '任务名称', - 'description' => '', - 'type' => 'string', - 'example' => '测试任务1', - ], - 'Status' => [ - 'title' => '发布状态: 草稿0、已提交1、开发中100', - 'description' => '', - 'type' => 'string', - 'example' => '测试任务1', - ], - 'Published' => [ - 'title' => '是否已发布', - 'description' => '', - 'type' => 'boolean', - ], - 'NeedPublish' => [ - 'title' => '是否需要发布', - 'description' => '', - 'type' => 'boolean', - ], - 'HasDevNode' => [ - 'title' => '是否有开发环境节点', - 'description' => '', - 'type' => 'boolean', - ], - 'NodeId' => [ - 'title' => '节点Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30231123', - ], - 'OwnerName' => [ - 'title' => '节点负责人名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'OperatorUserId' => [ - 'title' => '当前操作的用户id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SchedulePeriod' => [ - 'title' => '调度周期: 年 YEARLY、月 MONTHLY、周 WEEKLY、日 DAILY、小时 HOURLY、分钟 MINUTELY', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'CronExpression' => [ - 'title' => '自动调度的cron表达式, 可参考Linux cron表达式', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'HOUR', - ], - 'StartTime' => [ - 'title' => '开始时间: HH:mm', - 'description' => '', - 'type' => 'string', - 'example' => '08:00', - ], - 'EndTime' => [ - 'title' => '结束时间: HH:mm', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NodeStatus' => [ - 'title' => '节点状态: 正常 1、暂停 2、空跑 3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Paused' => [ - 'title' => '节点是否被暂停调度', - 'description' => '', - 'type' => 'boolean', - ], - 'NodeFrom' => [ - 'title' => '节点来源,节点由某个组织或应用创建的', - 'description' => '', - 'type' => 'string', - 'example' => 'openapi', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '131211211', - ], - 'UpStreamList' => [ - 'title' => '上游依赖', - 'description' => '', + 'BizUnitId' => ['title' => '', 'description' => 'The dependent data module ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '业务板块Id'], + 'BizUnitDisplayName' => ['title' => '', 'description' => 'The dependent data module display name.', 'type' => 'string', 'example' => '业务板块显示名'], + 'ComputeSourceId' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '项目依赖计算源Id'], + 'ComputeSourceName' => ['title' => '', 'description' => 'The compute source name.', 'type' => 'string', 'example' => '项目依赖计算源名'], + 'StreamComputeSourceId' => ['title' => '', 'description' => 'The stream compute source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '项目依赖实时计算源Id'], + 'StreamComputeSourceName' => ['title' => '', 'description' => 'The stream compute source name.', 'type' => 'string', 'example' => '项目依赖实时计算源名'], + 'NameSpaceTag' => ['title' => '', 'description' => 'The project tag.', 'type' => 'string', 'example' => 'GENERAL'], + 'Env' => ['title' => '', 'description' => 'The environment.', 'type' => 'string', 'example' => 'DEV'], + 'WhiteLists' => [ + 'title' => '', + 'description' => 'The whitelists.', 'type' => 'array', 'items' => [ - 'title' => '节点关联', - 'description' => '', + 'title' => '', + 'description' => 'The whitelist.', 'type' => 'object', 'properties' => [ - 'SourceTableName' => [ - 'title' => '输入表名称', - 'description' => '', - 'type' => 'string', - 'example' => 't_input1', - ], - 'SourceNodeId' => [ - 'title' => '上游节点Id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_2001', - ], - 'PeriodDiff' => [ - 'title' => '周期差:0表示同周期依赖，正数表示依赖前N个周期', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NodeType' => [ - 'title' => '上游依赖节点类型，PHYSICAL 物理节点，LOGICAL 逻辑表依赖', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CURRENT_PERIOD', - ], - 'PeriodOffset' => [ - 'title' => '周期偏移量, LAST_N_PERIOD时须传值', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'LAST', - ], - 'FieldList' => [ - 'title' => '依赖的逻辑表字段', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '依赖的逻辑表字段', - 'description' => '', - 'type' => 'string', - 'example' => 'column1', - ], - ], - ], - ], - ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'string', - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'example' => 'erp', - ], - 'SparkClientInfo' => [ - 'title' => 'spark客户端信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SparkClientVersion' => [ - 'title' => 'spark客户端版本名称', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', + 'Description' => ['title' => '', 'description' => 'The whitelist description.', 'type' => 'string', 'example' => 'whitelist for xxx'], + 'Ip' => ['title' => '', 'description' => 'The IP address.', 'type' => 'string', 'example' => '10.209.47.198'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'string', 'example' => '3306'], ], + 'example' => '', ], + 'example' => '', ], - 'DevelopOwnerId' => [ - 'title' => '开发负责人用户id', - 'type' => 'string', - 'example' => '30231123', - ], - 'DevelopOwnerName' => [ - 'title' => '开发负责人名称', - 'type' => 'string', - 'example' => '张三', - ], - 'OpsOwnerId' => [ - 'title' => '运维负责人用户id', - 'type' => 'string', - 'example' => '30231123', - ], - 'OpsOwnerName' => [ - 'title' => '运维负责人名称', - 'type' => 'string', - 'example' => '张三', - ], + 'Mode' => ['title' => '', 'description' => 'The project mode. Valid values:'."\n" + .'- BASIC'."\n" + .'- DEV_PROD', 'type' => 'string', 'example' => 'BASIC'], + 'Type' => ['title' => '', 'description' => 'The project type.', 'type' => 'string', 'example' => 'GENERAL'], + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12356'], + 'Name' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'dp_test'], + 'DisplayName' => ['title' => '', 'description' => 'The project display name.', 'type' => 'string', 'example' => '项目显示名'], + 'Description' => ['title' => '', 'description' => 'The project description.', 'type' => 'string', 'example' => 'project for xxx'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '1703048484000'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '1703048484000'], + 'Owner' => ['title' => '', 'description' => 'The project owner ID.', 'type' => 'string', 'example' => '101111'], + 'OwnerName' => ['title' => '', 'description' => 'The project owner.', 'type' => 'string', 'example' => '测试用户'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'GetProjectDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteBatchTask' => [ - 'summary' => '删除离线计算任务，如果任务还没下线需要先下线再删除。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProjectByName' => [ + 'summary' => 'Retrieves project details by project name.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12113111', - ], - 'Comment' => [ - 'title' => '删除操作说明', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test task', - ], - ], - 'required' => true, - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'The project details.', + 'type' => 'object', + 'properties' => [ + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the project belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '101131'], + 'BizUnitDisplayName' => ['title' => '', 'description' => 'The display name of the business unit to which the project belongs.', 'type' => 'string', 'example' => '测试'], + 'ComputeSourceId' => ['title' => '', 'description' => 'The ID of the associated compute source.', 'type' => 'integer', 'format' => 'int64', 'example' => '101711'], + 'ComputeSourceName' => ['title' => '', 'description' => 'The name of the associated compute source.', 'type' => 'string', 'example' => 'ds1'], + 'StreamComputeSourceId' => ['title' => '', 'description' => 'The ID of the associated real-time compute source.', 'type' => 'integer', 'format' => 'int64', 'example' => '201711'], + 'StreamComputeSourceName' => ['title' => '', 'description' => 'The name of the associated real-time compute source.', 'type' => 'string', 'example' => 'ds2'], + 'NameSpaceTag' => ['title' => '', 'description' => 'The namespace type. Valid values:'."\n" + .'- PUBLIC: public type'."\n" + .'- APPLICATION: application type'."\n" + .'- BASE: base type.', 'type' => 'string', 'example' => 'BASE'], + 'Env' => ['title' => '', 'description' => 'The environment identifier.', 'type' => 'string', 'example' => 'DEV'], + 'WhiteLists' => [ + 'title' => '', + 'description' => 'The whitelists.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'xx 白名单'], + 'Ip' => ['title' => '', 'description' => 'Ip', 'type' => 'string', 'example' => '10.11.1.21'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'string', 'example' => '5432'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Mode' => ['title' => '', 'description' => 'The project mode.', 'type' => 'string', 'example' => 'BASIC'], + 'Type' => ['title' => '', 'description' => 'The project type. Valid values:'."\n" + .'- DISTILL: distillation project'."\n" + .'- GENERAL: general project.', 'type' => 'string', 'example' => 'GENERAL'], + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'Name' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the project.', 'type' => 'string', 'example' => 'xx test'], + 'Description' => ['title' => '', 'description' => 'The project description.', 'type' => 'string', 'example' => '测试'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time, in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'GmtModified' => ['title' => '', 'description' => 'The update time, in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'Owner' => ['title' => '', 'description' => 'The project owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The project owner.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Get project details by project name', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateBatchTask' => [ - 'summary' => '创建离线计算任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProjectProduceUser' => [ + 'summary' => 'Retrieves the production account of a project. Only a super administrator (SuperAdmin) can call this API operation.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10121101', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xx test.', - ], - 'ScheduleType' => [ - 'title' => '调度类型: 周期任务:1、手动任务:3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], - 'TaskType' => [ - 'title' => '任务类型: Hive_SQL: 1、MaxCompute_SQL: 5、Shell 10、Python 21', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', - ], - 'Engine' => [ - 'title' => '任务执行引擎: PYTHON2_7,PYTHON3_7,PYTHON3_11', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PYTHON3_7', - ], - 'DataSourceId' => [ - 'title' => '数据库sql任务，数据源Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12131111', - ], - 'DataSourceCatalog' => [ - 'title' => '数据库sql任务，仅对如Presto等需要设置Catalog的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_catalog', - ], - 'DataSourceSchema' => [ - 'title' => '数据库sql任务，仅对如Oracle等需要设置Schema的数据源类型生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'erp', - ], - 'PythonModuleList' => [ - 'title' => '任务依赖python三方包', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'python三方包', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'numpy', - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131311111321'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'CreateResult' => [ - 'title' => '新建结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'User' => [ + 'title' => '', + 'description' => 'The producer user.', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'title' => '任务目录树节点Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12113111', - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123131'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve project production account', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetStreamJobs' => [ - 'summary' => '获取dataphin实时研发任务集合', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetProjectProduceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetProjectWhiteLists' => [ + 'summary' => 'Retrieves the whitelist of a project.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -25737,179 +17930,75 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => 'dataphin项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7162269257990111', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Env', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => 'dataphin环境，DEV或者PROD', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'WhiteLists' => [ + 'title' => '', + 'description' => 'The project whitelist.', 'type' => 'array', 'items' => [ + 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '任务状态', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Type' => [ - 'title' => '任务类型，FLINK_SQL或者FLINK_DATASTREAM', - 'description' => '', - 'type' => 'string', - 'example' => 'FLINK_SQL', - ], - 'OwnerId' => [ - 'title' => '创建者id', - 'description' => '', - 'type' => 'string', - 'example' => '300006788', - ], - 'JobName' => [ - 'title' => '实时任务名', - 'description' => '', - 'type' => 'string', - 'example' => 'flink_order_detail', - ], - 'ProjectId' => [ - 'title' => 'dataphin项目id', - 'description' => '', - 'type' => 'string', - 'example' => '7162269257990111', - ], - 'Id' => [ - 'title' => '实时任务的mapping id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '716555', - ], - 'Env' => [ - 'title' => '环境标识：DEV 开发、PROD 生产', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'ModifierId' => [ - 'title' => '最近一次变更人的id', - 'description' => '', - 'type' => 'string', - 'example' => '300006788', - ], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试'], + 'Ip' => ['title' => '', 'description' => 'ip', 'type' => 'string', 'example' => '10.1.0.2'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'string', 'example' => '5432'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve project whitelist', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'GetQueueEngineVersionByEnv' => [ - 'summary' => '根据集群ID获取集群版本', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'Dataphin公共云', - ], + 'GetQualityAlertOfAllRuleScopeByWatchId' => [ + 'summary' => 'Retrieves alert settings by monitored object ID. Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -25917,167 +18006,122 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7081229106458752', - ], - ], - [ - 'name' => 'StreamBatchMode', - 'in' => 'query', - 'schema' => [ - 'title' => '流批模式'."\n", - 'description' => '', - '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', + 'name' => 'WatchId', 'in' => 'query', - 'schema' => [ - 'title' => '集群Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d', - ], + 'schema' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityAlertInfo' => [ + 'title' => '', + 'description' => 'The alert settings details.', + 'type' => 'object', + 'properties' => [ + 'WatchId' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AlertUserChannelList' => [ + 'title' => '', + 'description' => 'The user alert channels.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user alert channels.', 'type' => 'string', 'example' => 'test'], + 'example' => '', + ], + 'AlertUserList' => [ + 'title' => '', + 'description' => 'The user alert list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30012011'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AlertDutyList' => [ + 'title' => '', + 'description' => 'The duty roster alert list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The alert duty roster ID.', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The alert duty roster name.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AlertDutyChannelList' => [ + 'title' => '', + 'description' => 'The duty roster alert channels.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The duty roster alert channels.', 'type' => 'string', 'example' => 'test'], + 'example' => '', + ], + 'EnableAlertQualityOwner' => ['title' => '', 'description' => 'Indicates whether alerting is enabled for the quality owner.', 'type' => 'boolean', 'example' => ''], + 'AlertQualityOwnerChannelList' => [ + 'title' => '', + 'description' => 'The quality owner alert channels.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The quality owner alert channels.', 'type' => 'string', 'example' => 'test'], + 'example' => '', + ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"AlertQualityOwnerChannelList\\": [\\n \\"test\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve alert settings by monitored object ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetClusterQueueInfoByEnv' => [ - 'summary' => '根据环境获取集群信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'Dataphin公共云', - ], + 'GetQualityRule' => [ + 'summary' => 'Retrieves a quality rule object.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -26085,446 +18129,394 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7081229106458752', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'StreamBatchMode', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '流批模式'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BOTH', - 'enum' => [ - 'STREAM', - 'BATCH', - 'BOTH', - ], - ], + 'schema' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'default' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '返回结果'."\n", - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '集群详细信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ClusterId' => [ - 'title' => '集群clusterId', - 'description' => '', - 'type' => 'string', - 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d', - ], - 'QueueName' => [ - 'title' => '队列名，唯一标示，k8s是资源组名称', - 'description' => '', - 'type' => 'string', - 'example' => 'default-queue', - ], - 'MaxVcore' => [ - 'title' => '每个队列最大提供VCORE', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PREJOB', - ], - 'FlinkVersion' => [ - 'title' => 'Flink版本', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityRuleInfo' => [ + 'title' => '', + 'description' => 'The quality rule details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The quality rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The quality rule name.', 'type' => 'string', 'example' => 'test'], + 'Status' => ['title' => '', 'description' => 'The quality rule status. Valid values:'."\n" + .'- ENABLE'."\n" + .'- DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Strength' => ['title' => '', 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG'."\n" + .'- WEAK.', 'type' => 'string', 'example' => 'STRONG'], + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule categories. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule categories. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CONSISTENT'], + 'example' => '', + ], + 'TemplateType' => ['title' => '', 'description' => 'The templatetype. Valid values:'."\n" + .' - FIELD_NULL_VALUE_VALIDATE: field null value check'."\n" + .' - FIELD_EMPTY_STRING_VALIDATE: field empty character string check'."\n" + .' - FIELD_UNIQUE_VALIDATE: field uniqueness check'."\n" + .' - FIELD_GROUP_COUNT_VALIDATE: field unique value count check'."\n" + .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count check'."\n" + .' - FUNCTION_TIME_COMPARE: time function comparison'."\n" + .' - SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison'."\n" + .' - DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison'."\n" + .' - FIELD_FORMAT_VALIDATE: field format check'."\n" + .' - FIELD_LENGTH_VALIDATE: field length check'."\n" + .' - FIELD_VALUE_RANGE_VALIDATE: field value range check'."\n" + .' - CODE_TABLE_COMPARE: lookup table reference comparison'."\n" + .' - STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison'."\n" + .' - SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison'."\n" + .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison'."\n" + .' - SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison'."\n" + .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison'."\n" + .' - TABLE_STABILITY_VALIDATE: table stability check'."\n" + .' - TABLE_FLUCTUATION_VALIDATE: table fluctuation check'."\n" + .' - FIELD_STABILITY_VALIDATE: field stability check'."\n" + .' - FIELD_FLUCTUATION_VALIDATE: field fluctuation check'."\n" + .' - CUSTOM_STATISTICAL_VALIDATE: custom statistical metric check'."\n" + .' - CUSTOM_DATA_DETAILS_VALIDATE: custom data details check'."\n" + .' - DATASOURCE_AVAILABLE_CHECK: data source connectivity monitoring'."\n" + .' - TABLE_SCHEMA_CHECK: table schema change monitoring'."\n" + .' - REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison'."\n" + .' - REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring'."\n" + .' - REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison, and more.', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '1'], + 'TemplateScope' => ['title' => '', 'description' => 'The templatetype group. Valid values:'."\n" + .'- SYSTEM: system preset'."\n" + .'- CUSTOM: custom template'."\n" + .'- TEMPLATE: union of SYSTEM and CUSTOM'."\n" + .'- CUSTOM_SQL: custom SQL template.', 'type' => 'string', 'example' => 'CUSTOM'], + 'WatchId' => ['title' => '', 'description' => 'The ID of the associated monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnableErrorArchive' => ['title' => '', 'description' => 'Indicates whether exception archiving is enabled.', 'type' => 'boolean', 'example' => ''], + 'ValidateConditionList' => [ + 'title' => '', + 'description' => 'The list of validation conditions.', + 'type' => 'array', + 'items' => [ + 'title' => '', 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.15', - 'default' => 'null', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The condition node ID.', 'type' => 'string', 'example' => '268'], + 'Type' => ['title' => '', 'description' => 'The condition type. Valid values:'."\n" + .'- RELATION: relationship'."\n" + .'- EXPRESSION: expression.', 'type' => 'string', 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'The operator. Valid values: EQUAL, NOT_EQUAL, LARGER, SMALLER, LARGE_OR_EQUAL, SMALLER_OR_EQUAL, AND, OR.', 'type' => 'string', 'example' => 'AND'], + 'OperatorName' => ['title' => '', 'description' => 'The operator name.', 'type' => 'string', 'example' => '且'], + 'Metric' => ['title' => '', 'description' => 'The metric.', 'type' => 'string', 'example' => 'test'], + 'MetricName' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The value.', 'type' => 'string', 'example' => '1'], + 'ParentId' => ['title' => '', 'description' => 'The parent condition node ID.', 'type' => 'string', 'example' => '123'], + ], + 'example' => '', ], - 'FlinkImageRegistry' => [ - 'title' => 'Flink镜像地址', + 'example' => '', + ], + 'TestRunRuleTaskId' => ['title' => '', 'description' => 'The ID of the most recent test run task.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'TestRunRuleTaskStatus' => ['title' => '', 'description' => 'The status of the most recent test run task. Valid values: NOT_RUN, WAITING, RUNNING, SUCCESS, FAILED.', 'type' => 'string', 'example' => 'SUCCESS'], + 'TestRunRuleValidateResult' => ['title' => '', 'description' => 'Indicates whether the test run validation passed.', 'type' => 'boolean', 'example' => ''], + 'ScheduleBindList' => [ + 'title' => '', + 'description' => 'The list of schedules bound to the rule.', + 'type' => 'array', + 'items' => [ + 'title' => '', 'description' => '', - 'type' => 'string', - 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com/xxxx/flink:1.15.4-scala_2.12', - 'default' => 'null', + 'type' => 'object', + 'properties' => [ + 'ScheduleId' => ['title' => '', 'description' => 'The schedule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ScheduleName' => ['title' => '', 'description' => 'The schedule name.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', ], - 'FlinkImageRepository' => [ - 'title' => 'Flink镜像仓库', + 'example' => '', + ], + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'The rule configuration key-value pairs. These vary by templatetype. Different templatetypes return different form key-value pair configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', 'description' => '', - 'type' => 'string', - 'example' => 'xxxx-registry-vpc.cn-shanghai.cr.aliyuncs.com', - 'default' => 'null', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['title' => '', 'description' => 'The control type.', 'type' => 'string', 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'The property name.', 'type' => 'string', 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'The property value.', 'type' => 'string', 'example' => 'abc'], + ], + 'example' => '', ], - 'FlinkImageTag' => [ - 'title' => 'Flink镜像标签', - 'description' => '', - 'type' => 'string', - 'example' => '1.15.4', - 'default' => 'null', + 'example' => '', + ], + 'ValidateObject' => [ + 'title' => '', + 'description' => 'The validation object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The validation object type. Valid values: UNKNOWN, TABLE, COLUMN, DATASOURCE, DATASOURCE_TABLE, REALTIME, INDEX, CHAIN.', 'type' => 'string', 'example' => 'TABLE'], + 'Name' => ['title' => '', 'description' => 'The validation object name.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], - ], + 'AttributeWithValueList' => [ + 'title' => '', + 'description' => 'The rule business attribute configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AttributeInfo' => [ + 'title' => '', + 'description' => 'The attribute details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '612415804007'], + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'attr01'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Enabled' => ['title' => '', 'description' => 'Indicates whether the attribute is enabled.', 'type' => 'boolean', 'example' => ''], + 'Required' => ['title' => '', 'description' => 'Indicates whether the attribute is required.', 'type' => 'boolean', 'example' => ''], + 'Searchable' => ['title' => '', 'description' => 'Indicates whether the attribute is searchable.', 'type' => 'boolean', 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The attribute value configuration details.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value input method. Valid values:'."\n" + .'- CUSTOMIZED: custom input'."\n" + .'- SINGLE_ENUM: single-select dropdown'."\n" + .'- MULTIPLE_ENUMS: multi-select dropdown'."\n" + .'- RANGE: range interval.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The attribute field data type. Valid values:'."\n" + .'- STRING: text'."\n" + .'- BIGINT: integer'."\n" + .'- DOUBLE: floating-point'."\n" + .'- BOOLEAN: Boolean'."\n" + .'- DATE: date'."\n" + .'- DATETIME: datetime.', 'type' => 'string', 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The attribute field length. This constrains the maximum length of text-type attribute values.', 'type' => 'integer', 'format' => 'int32', 'example' => '6921666'], + 'ValueEnumList' => [ + 'title' => '', + 'description' => 'The attribute option values. This applies only to attributes with a single-select dropdown or multi-select dropdown input method.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute option values. This applies only to attributes with a single-select dropdown or multi-select dropdown input method.', 'type' => 'string', 'example' => 'test'], + 'example' => '', + ], + 'DefaultValue' => [ + 'title' => '', + 'description' => 'The attribute default value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The list of attribute values. This applies to attributes with custom input, single-select dropdown, or multi-select dropdown input methods.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of attribute values. This applies to attributes with custom input, single-select dropdown, or multi-select dropdown input methods.', 'type' => 'string', 'example' => 'abc'], + 'example' => '', + ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'AttributeValue' => [ + 'title' => '', + 'description' => 'The property value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The list of attribute values. This applies to attributes with custom input, single-select dropdown, or multi-select dropdown input methods.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of attribute values. This applies to attributes with custom input, single-select dropdown, or multi-select dropdown input methods.', 'type' => 'string', 'example' => 'abc'], + 'example' => '', + ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'Modifier' => ['title' => '', 'description' => 'The ID of the user who last modified the rule.', 'type' => 'string', 'example' => '30012011'], + 'ModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the rule.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\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\\": false,\\n \\"Required\\": false,\\n \\"Searchable\\": false,\\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\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\n }\\n }\\n },\\n \\"AttributeValue\\": {\\n \\"ValueList\\": [\\n \\"abc\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\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' => 'Retrieve a quality rule object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStreamBatchJobMapping' => [ - 'summary' => '创建流批一体任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'Dataphin公共云', - ], + 'GetQualityRuleTask' => [ + 'summary' => 'Retrieves the details of a quality node task object. Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vvr-8.0.9-flink-1.17', - ], - 'ClusterId' => [ - 'title' => '集群ID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7081229106458752', - ], - 'VvpClusterType' => [ - 'title' => 'SESSION 或PREJOB,vvp专用，如果没有就不传或者为空', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PREJOB', - ], - 'Description' => [ - 'title' => '描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '这是一段任务的描述信息', - ], - ], - 'required' => true, - ], + 'name' => 'RuleTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The rule task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '任务创建成功的返回结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'RuleTaskInfo' => [ + 'title' => '', + 'description' => 'The rule task details.', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'title' => '作业文件ID', - 'description' => '', - 'type' => 'string', - 'example' => '7083701105376640', - ], - 'Url' => [ - 'title' => '跳转相对路径', - 'description' => '', - 'type' => 'string', - 'example' => '/dev/streamJob/7083701105376640?env=DEV&projectId=7081229106458752&tenantId=300001420', - ], - 'JobId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], + 'WatchId' => ['title' => '', 'description' => 'The ID of the associated monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'WatchTaskId' => ['title' => '', 'description' => 'The monitor task ID. This ID is empty for trial-run rule tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Id' => ['title' => '', 'description' => 'The rule task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RuleId' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Status' => ['title' => '', 'description' => 'The task status.', 'type' => 'string', 'example' => 'running'], + 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ValidatePartition' => ['title' => '', 'description' => 'The validation partition.', 'type' => 'string', 'example' => '20251011'], + 'ValidateObjectType' => ['title' => '', 'description' => 'The validation object type.', 'type' => 'string', 'example' => 'column'], + 'ValidateObjectName' => ['title' => '', 'description' => 'The validation object name.', 'type' => 'string', 'example' => 'test'], + 'ValidateSuccess' => ['title' => '', 'description' => 'Indicates whether the validation passed.', 'type' => 'boolean', 'example' => ''], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'BizDateFormat' => ['title' => '', 'description' => 'The business date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The ID of the user who last modified the task.', 'type' => 'string', 'example' => '30012011'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'Retrieve quality node task object details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetResource' => [ - 'summary' => '获取资源文件详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetQualityRuleTaskLog' => [ + 'summary' => 'Retrieves the log content of a quality node task object.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -26533,204 +18525,59 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Name', + 'name' => 'RuleTaskId', 'in' => 'query', - 'schema' => [ - 'title' => '资源文件名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'udf_sleep.jar', - ], + 'schema' => ['title' => '', 'description' => 'The rule task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10200121011', - ], - 'Name' => [ - 'title' => '资源文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'udf_sleep.jar', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102400', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'GmtCreate' => [ - 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The log content.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"test\\"\\n}","type":"json"}]', + 'title' => 'Retrieve quality node task object log content', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetResourceByVersion' => [ - 'summary' => '获取资源文件指定版本详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetQualitySchedule' => [ + 'summary' => 'Retrieves a quality schedule object.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -26739,375 +18586,244 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - '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', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the schedule object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'ResourceInfo' => [ - 'title' => '资源文件详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityScheduleInfo' => [ + 'title' => '', + 'description' => 'The details of the schedule object.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '资源id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10200121011', - ], - 'Name' => [ - 'title' => '资源文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'udf_sleep.jar', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102400', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'GmtCreate' => [ - 'title' => '创建时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'ComputeEngineType' => [ - 'title' => '计算引擎源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30011021', + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Id' => ['title' => '', 'description' => 'The ID of the schedule object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The name of the schedule object.', 'type' => 'string', 'example' => 'test'], + 'IsRefByRule' => ['title' => '', 'description' => 'Indicates whether the schedule object is referenced by a rule.', 'type' => 'boolean', 'example' => ''], + 'Type' => ['title' => '', 'description' => 'The schedule type. Valid values:'."\n" + .'- PERIOD_SCHEDULE: timed scheduling.'."\n" + .'- MANUAL_SCHEDULE: manual trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- DEPENDENCY_SCHEDULE: dependency scheduling.', 'type' => 'string', 'example' => 'PERIOD_SCHEDULE'], + 'PartitionType' => ['title' => '', 'description' => 'The partition type. Valid values:'."\n" + .'- EVERY_DAY: every day.'."\n" + .'- PRE_DAY: yesterday.'."\n" + .'- TODAY: today.'."\n" + .'- FIRST_DAY_OF_WEEK: first day of the week (Sunday).'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CUSTOM'], + 'PartitionExpression' => ['title' => '', 'description' => 'The custom partition expression.', 'type' => 'string', 'example' => 'ds=${yyyyMMdd}'], + 'TriggerType' => ['title' => '', 'description' => 'The trigger type for trigger-based scheduling. Valid values:'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.', 'type' => 'string', 'example' => 'STATIC_TASK_TRIGGER'], + 'TriggerNodeList' => [ + 'title' => '', + 'description' => 'The list of trigger nodes for trigger-based scheduling.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of trigger nodes for trigger-based scheduling.', 'type' => 'string', 'example' => 'n_1121'], + 'example' => '', ], - 'LastModifier' => [ - 'title' => '更新者', - 'description' => '', - 'type' => 'string', - 'example' => '30011021', + 'StaticTaskTriggerType' => ['title' => '', 'description' => 'The trigger type for fixed task triggers. Valid values:'."\n" + .'- ALL_TASKS_FINISHED: triggered when all tasks are finished.'."\n" + .'- ONE_TASKS_FINISHED: triggered when one task is finished.'."\n" + .'- PRE_ONE_TASKS_START: triggered when the previous task starts.', 'type' => 'string', 'example' => 'ONE_TASKS_FINISHED'], + 'PeriodScheduleIntervalType' => ['title' => '', 'description' => 'The interval type for timed scheduling. Valid values:'."\n" + .'- DAILY: day.'."\n" + .'- WEEKLY: week.'."\n" + .'- MONTHLY: month.'."\n" + .'- HOURLY: hour.'."\n" + .'- MINUTELY: minute.', 'type' => 'string', 'example' => 'DAILY'], + 'PeriodScheduleParamList' => [ + 'title' => '', + 'description' => 'The interval values for timed scheduling.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The interval values for timed scheduling.', 'type' => 'string', 'example' => 'DAILY'], + 'example' => '', ], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for timed scheduling.', 'type' => 'string', 'example' => '* * 1/* * * *'], + 'ValidatePartitionType' => ['title' => '', 'description' => 'The validation scope. Valid values:'."\n" + .'- TASK_REFERRED_PARTITION: partition updated by the task.'."\n" + .'- USER_DEFINED_PARTITION: custom partition.', 'type' => 'string', 'example' => 'TASK_REFERRED_PARTITION'], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012011'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityScheduleInfo\\": {\\n \\"WatchId\\": 22,\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"IsRefByRule\\": false,\\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' => 'Retrieve a quality schedule object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateResource' => [ - 'summary' => '编辑资源文件。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetQualitySchedulesByWatchId' => [ + 'summary' => 'Retrieves a list of schedule settings by monitored object ID.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], - 'ComputeEngineType' => [ - 'title' => '计算引擎类型: MAX_COMPUTE、HADOOP', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAX_COMPUTE', - ], - ], - 'required' => true, - ], + 'name' => 'WatchId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityScheduleList' => [ + 'title' => '', + 'description' => 'The list of schedule objects.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WatchId' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Id' => ['title' => '', 'description' => 'The schedule object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The schedule object name.', 'type' => 'string', 'example' => 'test'], + 'IsRefByRule' => ['title' => '', 'description' => 'Indicates whether the schedule is referenced by a rule.', 'type' => 'boolean', 'example' => ''], + 'Type' => ['title' => '', 'description' => 'The schedule type. Valid values:'."\n" + .'- PERIOD_SCHEDULE: timed scheduling.'."\n" + .'- MANUAL_SCHEDULE: manual trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- DEPENDENCY_SCHEDULE: dependency scheduling.', 'type' => 'string', 'example' => 'PERIOD_SCHEDULE'], + 'PartitionType' => ['title' => '', 'description' => 'The partition type. Valid values:'."\n" + .'- EVERY_DAY: every day.'."\n" + .'- PRE_DAY: yesterday.'."\n" + .'- TODAY: today.'."\n" + .'- FIRST_DAY_OF_WEEK: first day of the week (Sunday).'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CUSTOM'], + 'PartitionExpression' => ['title' => '', 'description' => 'The partition expression. A custom expression.', 'type' => 'string', 'example' => 'ds=${yyyyMMdd}'], + 'TriggerType' => ['title' => '', 'description' => 'The trigger method for trigger-based scheduling. Valid values:'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.', 'type' => 'string', 'example' => 'STATIC_TASK_TRIGGER'], + 'TriggerNodeList' => [ + 'title' => '', + 'description' => 'The list of trigger nodes for trigger-based scheduling.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of trigger nodes for trigger-based scheduling.', 'type' => 'string', 'example' => 'n_1121'], + 'example' => '', + ], + 'StaticTaskTriggerType' => ['title' => '', 'description' => 'The trigger method for fixed task triggers. Valid values:'."\n" + .'- ALL_TASKS_FINISHED'."\n" + .'- ONE_TASKS_FINISHED'."\n" + .'- PRE_ONE_TASKS_START.', 'type' => 'string', 'example' => 'ONE_TASKS_FINISHED'], + 'PeriodScheduleIntervalType' => ['title' => '', 'description' => 'The interval type for timed scheduling. Valid values:'."\n" + .'- DAILY: day.'."\n" + .'- WEEKLY: week.'."\n" + .'- MONTHLY: month.'."\n" + .'- HOURLY: hour.'."\n" + .'- MINUTELY: minute.', 'type' => 'string', 'example' => 'DAILY'], + 'PeriodScheduleParamList' => [ + 'title' => '', + 'description' => 'The interval values for timed scheduling.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The interval values for timed scheduling.', 'type' => 'string', 'example' => 'DAILY'], + 'example' => '', + ], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for timed scheduling.', 'type' => 'string', 'example' => '* * 1/* * * *'], + 'ValidatePartitionType' => ['title' => '', 'description' => 'The validation scope. Valid values:'."\n" + .'- TASK_REFERRED_PARTITION: task-updated partition.'."\n" + .'- USER_DEFINED_PARTITION: custom partition.', 'type' => 'string', 'example' => 'TASK_REFERRED_PARTITION'], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012011'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"QualityScheduleList\\": [\\n {\\n \\"WatchId\\": 22,\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"IsRefByRule\\": false,\\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' => 'Retrieve schedule settings by monitored object ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetFileStorageCredential' => [ - 'summary' => '获取文件存储临时读写授权。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetQualityTemplate' => [ + 'summary' => 'Retrieves a quality template object.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -27116,690 +18832,835 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '项目Id，临时授权用于创建资源文件时必填', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1030131021', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityTemplateInfo' => [ + 'title' => '', + 'description' => 'The details of the template object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The templatetype. Valid values:'."\n" + .'- FIELD_NULL_VALUE_VALIDATE: field null value check.'."\n" + .'- FIELD_EMPTY_STRING_VALIDATE: field empty character string check.'."\n" + .'- FIELD_UNIQUE_VALIDATE: field uniqueness check.'."\n" + .'- FIELD_GROUP_COUNT_VALIDATE: field unique value count check.'."\n" + .'- FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count check.'."\n" + .'- FUNCTION_TIME_COMPARE: time function comparison.'."\n" + .'- SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison.'."\n" + .'- DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison.'."\n" + .'- FIELD_FORMAT_VALIDATE: field format check.'."\n" + .'- FIELD_LENGTH_VALIDATE: field length check.'."\n" + .'- FIELD_VALUE_RANGE_VALIDATE: field value range check.'."\n" + .'- CODE_TABLE_COMPARE: lookup table reference comparison.'."\n" + .'- STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison.'."\n" + .'- SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison.'."\n" + .'- SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison.'."\n" + .'- SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison.'."\n" + .'- DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison.'."\n" + .'- DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison.'."\n" + .'- CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison.'."\n" + .'- DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison.'."\n" + .'- TABLE_STABILITY_VALIDATE: table stability check.'."\n" + .'- TABLE_FLUCTUATION_VALIDATE: table fluctuation check.'."\n" + .'- FIELD_STABILITY_VALIDATE: field stability check.'."\n" + .'- FIELD_FLUCTUATION_VALIDATE: field fluctuation check.'."\n" + .'- CUSTOM_STATISTICAL_VALIDATE: custom statistical metric check.'."\n" + .'- CUSTOM_DATA_DETAILS_VALIDATE: custom data details check.'."\n" + .'- DATASOURCE_AVAILABLE_CHECK: data source connectivity monitoring.'."\n" + .'- TABLE_SCHEMA_CHECK: table schema change monitoring.'."\n" + .'- REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison.'."\n" + .'- REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring.'."\n" + .'- REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison.', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'TypeName' => ['title' => '', 'description' => 'The display name of the templatetype.', 'type' => 'string', 'example' => '字段空值校验'], + 'Description' => ['title' => '', 'description' => 'The template description.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'Catalog' => ['title' => '', 'description' => 'The template category. Valid values:'."\n" + .'- CONSISTENT: consistency.'."\n" + .'- EFFECTIVE: validity.'."\n" + .'- TIMELINESE: timeliness.'."\n" + .'- ACCURATE: accuracy.'."\n" + .'- UNIQUENESS: uniqueness.'."\n" + .'- COMPLETENESS: completeness.'."\n" + .'- STABILITY: stability.'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CONSISTENT'], + 'CatalogName' => ['title' => '', 'description' => 'The display name of the template category.', 'type' => 'string', 'example' => '一致性'], + 'SupportAllDataSourceType' => ['title' => '', 'description' => 'Indicates whether all data source types are supported.', 'type' => 'boolean', 'example' => ''], + 'SupportDataSourceTypeList' => [ + 'title' => '', + 'description' => 'The list of supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', 'type' => 'string', 'example' => 'MySQL'], + 'example' => '', + ], + 'IsSystemTemplate' => ['title' => '', 'description' => 'Indicates whether the template is a system template.', 'type' => 'boolean', 'example' => ''], + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'The key-value pairs of the rule configuration.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['title' => '', 'description' => 'The control type.', 'type' => 'string', 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'The property name.', 'type' => 'string', 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'The property value.', 'type' => 'string', 'example' => 'abc'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + 'ModifierName' => ['title' => '', 'description' => 'The name of the last modifier.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"SupportDataSourceTypeList\\": [\\n \\"MySQL\\"\\n ],\\n \\"IsSystemTemplate\\": false,\\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' => 'Retrieve a quality template object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetQualityWatch' => [ + 'summary' => 'Retrieves a quality monitored object.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'UseVpcEndpoint', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '使用内网地址, 默认：false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Purpose', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '用途: RESOURCE 创建资源文件、COMPUTE_SOURCE_SETTING 存储计算源配置、NONE 无明确用途；默认：NONE', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RESOURCE', - ], + 'schema' => ['title' => '', 'description' => 'The monitor ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'StorageCredential' => [ - 'title' => '临时读写授权详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'QualityWatchInfo' => [ + 'title' => '', + 'description' => 'The details of the monitored object.', 'type' => 'object', 'properties' => [ - 'StorageType' => [ - 'title' => '存储集群类型: oss、ceph', - 'description' => '', - 'type' => 'string', - 'example' => 'oss', - ], - 'Endpoint' => [ - 'title' => '连接地址', - 'description' => '', - 'type' => 'string', - 'example' => 'oss-cn-shanghai.aliyuncs.com', - ], - 'Bucket' => [ - 'title' => '文件存储bucket', - 'description' => '', - 'type' => 'string', - 'example' => 'dataphin', - ], - 'Region' => [ - 'title' => 'region', - 'description' => 'region', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'AccessId' => [ - 'title' => '临时AK', - 'description' => '', - 'type' => 'string', - 'example' => 'temp.akId', - ], - 'AccessKey' => [ - 'title' => '临时AK', - 'description' => '', - 'type' => 'string', - 'example' => 'temp.akKey', - ], - 'ObjectName' => [ - 'title' => '存储对象', - 'description' => '', - 'type' => 'string', - 'example' => '1023231111/abc', + 'Type' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: full-domain table.'."\n" + .'- DATASOURCE: data source.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'TABLE'], + 'Id' => ['title' => '', 'description' => 'The monitor ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Name' => ['title' => '', 'description' => 'The monitor name.', 'type' => 'string', 'example' => 'test'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- ENABLE'."\n" + .'- DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'DataSourceInfo' => [ + 'title' => '', + 'description' => 'The datasource config details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The data source type. Valid values:'."\n" + .'- MAX_COMPUTE'."\n" + .'- HADOOP.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- PROD'."\n" + .'- DEV.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', ], - 'Expiration' => [ - 'title' => '到期时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17343434343434', + 'TableInfo' => [ + 'title' => '', + 'description' => 'The monitored table object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: logical fact table.'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table.'."\n" + .'- LOGIC_LABEL_TABLE: logical label table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE'], + 'Catalog' => ['title' => '', 'description' => 'The table catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'DataSourceType' => ['title' => '', 'description' => 'The data source type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'example' => '22'], + 'IsPartitionTable' => ['title' => '', 'description' => 'Indicates whether the table is a partitioned table.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], - 'SecurityToken' => [ - 'title' => '临时授权证书', - 'description' => '', - 'type' => 'string', - 'example' => 'temp.token', + 'IndexInfo' => [ + 'title' => '', + 'description' => 'The metric details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'Catalog' => ['title' => '', 'description' => 'The metric catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The metric ID.', 'type' => 'string', 'example' => '11'], + 'Guid' => ['title' => '', 'description' => 'The metric GUID.', 'type' => 'string', 'example' => '1121'], + 'Name' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'logic'], + 'DisplayName' => ['title' => '', 'description' => 'The metric display name.', 'type' => 'string', 'example' => 'logic'], + 'GranularityId' => ['title' => '', 'description' => 'The statistical granularity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764'], + 'GranularityDisplayName' => ['title' => '', 'description' => 'The statistical granularity name.', 'type' => 'string', 'example' => '全站汇总表'], + 'ComputeType' => ['title' => '', 'description' => 'The metric computation type. Valid values:'."\n" + .'- AUTO'."\n" + .'- CUSTOM'."\n" + .'- MOUNT'."\n" + .'- COMBINE.', 'type' => 'string', 'example' => 'AUTO'], + 'CellSumLogicTableName' => ['title' => '', 'description' => 'The cell aggregate table name.', 'type' => 'string', 'example' => 'dws_all'], + 'Type' => ['title' => '', 'description' => 'The metric type. Valid values:'."\n" + .'- INDEX.', 'type' => 'string', 'example' => 'INDEX'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'DateType' => ['title' => '', 'description' => 'The metric data type.', 'type' => 'string', 'example' => 'bigint'], + ], + 'example' => '', ], + 'QualityOwner' => ['title' => '', 'description' => 'The user ID of the quality owner.', 'type' => 'string', 'example' => '30012011'], + 'QualityOwnerName' => ['title' => '', 'description' => 'The display name of the quality owner.', 'type' => 'string', 'example' => 'test'], + 'LatestWatchTaskId' => ['title' => '', 'description' => 'The ID of the most recent quality watchtask for the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LatestWatchTaskStatus' => ['title' => '', 'description' => 'The status of the most recent quality watchtask for the monitored object.', 'type' => 'string', 'example' => 'SUCCESS'], + 'RuleCount' => ['title' => '', 'description' => 'The number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'EnabledRuleCount' => ['title' => '', 'description' => 'The number of enabled rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'DeleteResource' => [ - 'summary' => '删除资源文件。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false\\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' => 'Retrieve a quality monitored object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQualityWatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetQualityWatchByObjectId' => [ + 'summary' => 'Retrieves a quality watchtask record by the original ID of the monitored object, such as the ID of a datasource, table, or metric.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'WatchType', 'in' => 'query', - 'schema' => [ - 'title' => '资源文件Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10300010201', - ], + 'schema' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: global table.'."\n" + .'- DATASOURCE: datasource.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], ], [ - 'name' => 'Comment', + 'name' => 'WatchObjectId', 'in' => 'query', - 'schema' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '测试', - ], + 'schema' => ['title' => '', 'description' => 'The object ID, such as a table ID, datasource ID, or metric ID.', 'type' => 'string', 'required' => true, 'example' => 'cc'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error details from the backend.', 'type' => 'string', 'example' => 'internal error'], + 'QualityWatchInfo' => [ + 'title' => '', + 'description' => 'The details of the monitored object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: global table.'."\n" + .'- DATASOURCE: datasource.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'TABLE'], + 'Id' => ['title' => '', 'description' => 'The monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Name' => ['title' => '', 'description' => 'The monitoring name.', 'type' => 'string', 'example' => 'test'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- ENABLE'."\n" + .'- DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'DataSourceInfo' => [ + 'title' => '', + 'description' => 'The datasource details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The datasource name.', 'type' => 'string', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The datasource type. Valid values:'."\n" + .'- MAX_COMPUTE'."\n" + .'- HADOOP.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- PROD'."\n" + .'- DEV.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', + ], + 'TableInfo' => [ + 'title' => '', + 'description' => 'The monitored table object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: logical fact table.'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table.'."\n" + .'- LOGIC_LABEL_TABLE: logical label table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE'], + 'Catalog' => ['title' => '', 'description' => 'The table catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'DataSourceType' => ['title' => '', 'description' => 'The datasource type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'DataSourceId' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'string', 'example' => '22'], + 'IsPartitionTable' => ['title' => '', 'description' => 'Indicates whether the table is a partitioned table.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'IndexInfo' => [ + 'title' => '', + 'description' => 'The metric details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'Catalog' => ['title' => '', 'description' => 'The metric catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The metric ID.', 'type' => 'string', 'example' => '11'], + 'Guid' => ['title' => '', 'description' => 'The metric GUID.', 'type' => 'string', 'example' => '1121'], + 'Name' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'logic'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the metric.', 'type' => 'string', 'example' => 'logic'], + 'GranularityId' => ['title' => '', 'description' => 'The statistical granularity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764'], + 'GranularityDisplayName' => ['title' => '', 'description' => 'The display name of the statistical granularity.', 'type' => 'string', 'example' => '全站汇总表'], + 'ComputeType' => ['title' => '', 'description' => 'The computation type of the metric. Valid values:'."\n" + .'- AUTO'."\n" + .'- CUSTOM'."\n" + .'- MOUNT'."\n" + .'- COMBINE.', 'type' => 'string', 'example' => 'AUTO'], + 'CellSumLogicTableName' => ['title' => '', 'description' => 'The name of the cell aggregate table.', 'type' => 'string', 'example' => 'dws_all'], + 'Type' => ['title' => '', 'description' => 'The metric type. Valid values:'."\n" + .'- INDEX.', 'type' => 'string', 'example' => 'INDEX'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'DateType' => ['title' => '', 'description' => 'The data type of the metric.', 'type' => 'string', 'example' => 'bigint'], + ], + 'example' => '', + ], + 'QualityOwner' => ['title' => '', 'description' => 'The user ID of the quality owner.', 'type' => 'string', 'example' => '30012011'], + 'QualityOwnerName' => ['title' => '', 'description' => 'The display name of the quality owner.', 'type' => 'string', 'example' => 'test'], + 'LatestWatchTaskId' => ['title' => '', 'description' => 'The ID of the most recent quality watchtask for the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LatestWatchTaskStatus' => ['title' => '', 'description' => 'The status of the most recent quality watchtask for the monitored object.', 'type' => 'string', 'example' => 'SUCCESS'], + 'RuleCount' => ['title' => '', 'description' => 'The number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'EnabledRuleCount' => ['title' => '', 'description' => 'The number of enabled rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false\\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' => 'Retrieve a quality watchtask record by monitored object original ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateResource' => [ - 'summary' => '创建资源文件。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetQualityWatchTask' => [ + 'summary' => 'Retrieves a monitoring node task object.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAX_COMPUTE', - ], - ], - 'required' => true, - ], + 'name' => 'WatchTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The quality watchtask ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10112101', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'WatchTaskInfo' => [ + 'title' => '', + 'description' => 'The details of the monitoring node task object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The quality watchtask ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'WatchId' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StartTime' => ['title' => '', 'description' => 'The start time. Time format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time. Time format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 20:00:00'], + 'QualityOwner' => ['title' => '', 'description' => 'The user ID of the quality owner.', 'type' => 'string', 'example' => '30012011'], + 'QualityOwnerName' => ['title' => '', 'description' => 'The name of the quality owner.', 'type' => 'string', 'example' => 'test'], + 'RuleCountInfo' => [ + 'title' => '', + 'description' => 'The quality rule count information.', + 'type' => 'object', + 'properties' => [ + 'ValidateRuleCount' => [ + 'title' => '', + 'description' => 'The validation rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + 'StrongRuleCount' => [ + 'title' => '', + 'description' => 'The strong rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + 'WeakRuleCount' => [ + 'title' => '', + 'description' => 'The weak rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'RuleIdList' => [ + 'title' => '', + 'description' => 'The list of quality rule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of quality rule IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'example' => '', + ], + 'Status' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: executing.'."\n" + .'- SUCCESS: executed successfully.'."\n" + .'- FAILED: execution failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'example' => 'RUNNING'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'BizDateFormat' => ['title' => '', 'description' => 'The business date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'GetUdf' => [ - 'summary' => '获取自定义函数详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve a monitoring node task object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQualityWatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetQualityWatchTaskLog' => [ + 'summary' => 'Retrieves the log content of a monitoring task object.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'WatchTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the quality watchtask.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The log content.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"test\\"\\n}","type":"json"}]', + 'title' => 'Retrieve log content of a monitoring task object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetQueueEngineVersionByEnv' => [ + 'summary' => 'Retrieves the cluster version based on the cluster 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment.', 'type' => 'string', 'required' => true, 'example' => 'PROD'], + ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7081229106458752'], ], [ - 'name' => 'Id', + 'name' => 'StreamBatchMode', 'in' => 'query', 'schema' => [ - 'title' => '自定义函数Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The stream-batch mode.', + 'type' => 'string', 'required' => true, - 'example' => '1123', + 'example' => 'BOTH', + 'enum' => ['BOTH', 'STREAM', 'BATCH'], ], ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'required' => true, 'example' => 'default-queue'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => '61187014-a3ba-4cdd-8609-1f0aa3df4a3d'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1030111021', - ], - 'Name' => [ - 'title' => '函数名', - 'description' => '', - 'type' => 'string', - 'example' => 'udf_to_lower', - ], - 'ComputeEngineType' => [ - 'title' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30012110', - ], - 'LastModifier' => [ - 'title' => '最后更新人', - 'description' => '', - 'type' => 'string', - 'example' => '30012110', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The DPI engine version information.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The DPI engine version information.', 'type' => 'string', 'example' => 'vvr-8.0.9-flink-1.17'], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n \\"vvr-8.0.9-flink-1.17\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve cluster engine version information', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:34:01.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetUdfByVersion' => [ - 'summary' => '查询自定义函数版本详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQueueEngineVersionByEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetResource' => [ + 'summary' => 'Retrieves the details of a resource file.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -27808,708 +19669,345 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义函数Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1123', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], ], [ - 'name' => 'VersionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the resource file.', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'UdfInfo' => [ - 'title' => '自定义函数详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ResourceInfo' => [ + 'title' => '', + 'description' => 'The resource file details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '自定义函数Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1030111021', - ], - 'Name' => [ - 'title' => '函数名', - 'description' => '', - 'type' => 'string', - 'example' => 'udf_to_lower', - ], - 'ComputeEngineType' => [ - 'title' => '计算引擎，支持 HADOOP、MAX_COMPUTE、FLINK', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'GmtModified' => [ - 'title' => '更新时间, 格式：yyyy-MM-d HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-10 10:01:01', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30012110', - ], - 'LastModifier' => [ - 'title' => '最后更新人', - 'description' => '', - 'type' => 'string', - 'example' => '30012110', - ], + 'Id' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10200121011'], + 'Name' => ['title' => '', 'description' => 'The name of the resource file.', 'type' => 'string', 'example' => 'udf_sleep.jar'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'ResourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'JAR'], + 'Directory' => ['title' => '', 'description' => 'The directory where the resource is stored.', 'type' => 'string', 'example' => '/'], + 'StorageAddress' => ['title' => '', 'description' => 'The storage address of the resource.', 'type' => 'string', 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c'], + 'Size' => ['title' => '', 'description' => 'The size of the resource, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '102400'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'GmtModified' => ['title' => '', 'description' => 'The last modification time, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30011021'], + 'LastModifier' => ['title' => '', 'description' => 'The last modifier.', 'type' => 'string', 'example' => '30011021'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Get resource file details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateUdf' => [ - 'summary' => '编辑自定义函数。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetResourceByVersion' => [ + 'summary' => 'Gets the details of a specified version of a resource file.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Resource file name.', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep.jar'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Version ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '创建命令', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '自定义函数Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1123', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], - 'RefResourceIdList' => [ - 'title' => '引用资源id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '引用资源id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10200121011', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend error details.', 'type' => 'string', 'example' => 'internal error'], + 'ResourceInfo' => [ + 'title' => '', + 'description' => 'Resource file details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10200121011'], + 'Name' => ['title' => '', 'description' => 'Resource file name.', 'type' => 'string', 'example' => 'udf_sleep.jar'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'ResourceType' => ['title' => '', 'description' => 'Resource type.', 'type' => 'string', 'example' => 'JAR'], + 'Directory' => ['title' => '', 'description' => 'Storage directory.', 'type' => 'string', 'example' => '/'], + 'StorageAddress' => ['title' => '', 'description' => 'Resource storage address.', 'type' => 'string', 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c'], + 'Size' => ['title' => '', 'description' => 'Resource size, unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '102400'], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => '测试'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time, format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'GmtModified' => ['title' => '', 'description' => 'Modification time, format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'ComputeEngineType' => ['title' => '', 'description' => 'Compute engine type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '30011021'], + 'LastModifier' => ['title' => '', 'description' => 'Last modifier.', 'type' => 'string', 'example' => '30011021'], ], - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Get details of a specified version of a resource file', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteUdf' => [ - 'summary' => '删除自定义函数。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'GetRowPermissionByTableGuids' => [ + 'summary' => 'Release version: v5.4.2.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1030111021', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义函数Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10300010201', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Comment', - 'in' => 'query', + 'name' => 'GetRowPermissionByTableGuidsQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Request command', + 'type' => 'object', + 'properties' => [ + 'TableGuids' => [ + 'title' => '', + 'description' => 'List of table GUIDs', + 'type' => 'array', + 'items' => ['description' => 'Table GUID', 'type' => 'string', 'required' => true, 'example' => 'odps.300199897.project_name.table_name', 'title' => ''], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => '测试', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code of the backend response', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates that the request was successful', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'description' => 'Response data', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RowPermissionId' => ['title' => '', 'description' => 'Row permission ID', 'type' => 'string', 'example' => '300000001'], + 'RowPermissionName' => ['title' => '', 'description' => 'Row permission name', 'type' => 'string', 'example' => 'Region'], + 'RowPermissionDesc' => ['title' => '', 'description' => 'Row permission description', 'type' => 'string', 'example' => 'Restrict query region'."\n"], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"RowPermissionId\\": \\"300000001\\",\\n \\"RowPermissionName\\": \\"Region\\",\\n \\"RowPermissionDesc\\": \\"Restrict query region\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Row Permissions by Table GUIDs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateUdf' => [ - 'summary' => '创建自定义函数。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetSecurityClassify' => [ + 'summary' => 'Retrieves the details of a data classification. Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '711833', - ], - 'ComputeEngineType' => [ - 'title' => '计算引擎类型: MAX_COMPUTE、HADOOP', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAX_COMPUTE', - ], - 'Directory' => [ - 'title' => '存放目录, 默认：/', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - 'RefResourceIdList' => [ - 'title' => '引用资源id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '引用资源id', - 'description' => '', - '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' => '', - '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, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The classification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10212101', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'SecurityClassifyInfo' => [ + 'title' => '', + 'description' => 'The data classification details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The data classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'example' => 'test'], + 'Abbreviation' => ['title' => '', 'description' => 'The classification abbreviation.', 'type' => 'string', 'example' => 'test'], + 'Path' => ['title' => '', 'description' => 'The classification path.', 'type' => 'string', 'example' => '/a/b/c'], + 'LevelIndex' => ['title' => '', 'description' => 'The security level index.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LevelName' => ['title' => '', 'description' => 'The security level name.', 'type' => 'string', 'example' => 'lv_teat'], + 'LevelAbbreviation' => ['title' => '', 'description' => 'The security level abbreviation.', 'type' => 'string', 'example' => 'lv_test'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data classification details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListSubmitRecords' => [ - 'summary' => '分页获取待发布记录列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetSecurityIdentifyResult' => [ + 'summary' => 'Retrieves the details of an identification result.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -28517,303 +20015,113 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '项目id', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '变更类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'required' => false, - ], - 'SubmitStartTime' => [ - 'title' => '提交开始时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-10-10 10:00:00', - ], - 'SubmitEndTime' => [ - 'title' => '提交结束时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The identification result ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ListResult' => [ - 'title' => '查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'SecurityIdentifyResultInfo' => [ + 'title' => '', + 'description' => 'The identification result details.', '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1241844456', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'example' => '1241844456', - ], - 'Submitter' => [ - 'title' => '提交人id', - 'description' => '', - 'type' => 'string', - 'example' => '307999999', - ], - 'SubmitterName' => [ - 'title' => '提交人名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'GmtCreate' => [ - 'title' => '创建时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-10 10:00:00', - ], - 'GmtModify' => [ - 'title' => '修改时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-10 10:00:00', - ], - 'ChangeType' => [ - 'title' => '变更类型 0:新增/1:更新/2:删除', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1234567', - ], - 'NodeId' => [ - 'title' => '节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_123456', - ], - 'ObjectVersion' => [ - 'title' => '对象版本', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SubmitComment' => [ - 'title' => '提交信息', - 'description' => '', - 'type' => 'string', - 'example' => '提交信息', - ], - ], - ], - ], + 'Id' => ['title' => '', 'description' => 'The identification result ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ScanTaskId' => ['title' => '', 'description' => 'The scan task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'TableTaskId' => ['title' => '', 'description' => 'The identification table task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'ClassifyId' => ['title' => '', 'description' => 'The classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'ClassifyName' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'example' => 'test'], + 'ClassifyAbbreviation' => ['title' => '', 'description' => 'The classification abbreviation.', 'type' => 'string', 'example' => 'test'], + 'LevelIndex' => ['title' => '', 'description' => 'The sensitivity level index.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LevelName' => ['title' => '', 'description' => 'The sensitivity level name.', 'type' => 'string', 'example' => 'test'], + 'LevelAbbreviation' => ['title' => '', 'description' => 'The sensitivity level abbreviation.', 'type' => 'string', 'example' => 'test'], + 'LevelColor' => ['title' => '', 'description' => 'The sensitivity level color.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'LD_test'], + 'BizUnitDisplayName' => ['title' => '', 'description' => 'The display name of the business unit in Chinese.', 'type' => 'string', 'example' => 'LD_test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectDisplayName' => ['title' => '', 'description' => 'The display name of the project in Chinese.', 'type' => 'string', 'example' => 'test'], + 'DatasourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101121'], + 'DatasourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => 'ds1'], + 'TableEnv' => ['title' => '', 'description' => 'The table environment.', 'type' => 'string', 'example' => 'DEV'], + 'TableType' => ['title' => '', 'description' => 'The table type. Valid values:'."\n" + .'- LOGIC_TABLE: logical table.'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: fact logical table.'."\n" + .'- LOGIC_SUM_TABLE: aggregate logical table.'."\n" + .'- LOGIC_ODM_SOURCE: source table.'."\n" + .'- LOGIC_LABEL_TABLE: label logical table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REAL_TIME_LOGIC_TABLE: real-time configured logical table.', 'type' => 'string', 'example' => 'LOGIC_TABLE'], + 'TableCatalog' => ['title' => '', 'description' => 'The table catalog.', 'type' => 'string', 'example' => 'testdb'], + 'TableId' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'example' => '1'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 't_test'], + 'TableDescription' => ['title' => '', 'description' => 'The table description.', 'type' => 'string', 'example' => 'test'], + 'FieldId' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => 't_test.col1'], + 'FieldName' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'example' => 'col1'], + 'FieldDescription' => ['title' => '', 'description' => 'The field description.', 'type' => 'string', 'example' => 'test'], + 'IsCustomIdentify' => ['title' => '', 'description' => 'Indicates whether a custom tagging rule is used.', 'type' => 'boolean', 'example' => ''], + 'IsLocked' => ['title' => '', 'description' => 'Indicates whether the result is locked.', 'type' => 'boolean', 'example' => ''], + 'HasBetterRule' => ['title' => '', 'description' => 'Indicates whether a better matching result exists.', 'type' => 'boolean', 'example' => ''], + 'IdentifyRecordId' => ['title' => '', 'description' => 'The identification record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'example' => 'ENABLE'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 10:30:30'], + 'Modifier' => ['title' => '', 'description' => 'The modifier.', 'type' => 'string', 'example' => '30012011'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 10:30:30'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"IsLocked\\": false,\\n \\"HasBetterRule\\": false,\\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' => 'Retrieve identification result details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetLatestSubmitDetail' => [ - 'summary' => '获取最新的待发布记录详情', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetSecurityLevel' => [ + 'summary' => 'Retrieves the details of a data classification level. Available since v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -28821,380 +20129,267 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'ObjectType' => [ - 'title' => '对象类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAX_COMPUTE_SQL', - ], - ], - 'required' => true, - ], + 'name' => 'Index', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The sensitivity level of the data classification.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'SubmitDetailResult' => [ - 'title' => '待发布详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'SecurityLevelInfo' => [ + 'title' => '', + 'description' => 'The data classification level details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '提交记录id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'SubmitStatus' => [ - 'title' => '待发布记录状态 待发布:TO_BE_PUBLISHED/已发布:PUBLISHED/发布中:PUBLISHING', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Tag' => [ - 'title' => '记录Tag', - 'description' => '', - 'type' => 'string', - 'example' => 'tag', - ], - 'ReleaseObject' => [ - 'title' => '待发布记录对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ObjectVersion' => [ - 'title' => '对象版本', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ChangeType' => [ - 'title' => '变更类型列表（新增:CREATE/更新:UPDATE/删除:DELETE', - 'description' => '', - 'type' => 'string', - 'example' => 'DELETE', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'NodeId' => [ - 'title' => '节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_1234', - ], - 'SubmitComment' => [ - 'title' => '提交说明', - 'description' => '', - 'type' => 'string', - 'example' => '提交说明', - ], - 'SubmitObject' => [ - 'title' => '发布对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ObjectId' => [ - 'title' => '对象id', - 'description' => '', - 'type' => 'string', - 'example' => '1234', - ], - 'ObjectType' => [ - 'title' => '对象类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE_SQL', - ], - 'ObjectName' => [ - 'title' => '对象名称', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], + 'Name' => ['title' => '', 'description' => 'The name of the data classification level.', 'type' => 'string', 'example' => 'test'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviated name of the data classification level.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description of the data classification level.', 'type' => 'string', 'example' => 'test'], + 'Index' => ['title' => '', 'description' => 'The sensitivity level of the data classification.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RelatedClassifyIdList' => [ + 'title' => '', + 'description' => 'The list of data categorization IDs associated with the current data classification level.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of data categorization IDs associated with the current data classification level.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data classification level details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'PublishObjectList' => [ - 'summary' => '批量发布对象', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetSecuritySecretKey' => [ + 'summary' => 'Retrieves a key value by key name. Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'PublishCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The key name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '发布指令', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], - 'SubmitIdList' => [ - 'title' => '要发布的待发布项，待发布记录ID列表（submitIds个数限制50)', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '待发布记录id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'SecuritySecretKeyInfo' => [ + 'title' => '', + 'description' => 'The security key details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The key name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The key type. Valid values:'."\n" + .'- HASH: hashing and masking.'."\n" + .'- ENCRYPT: encryption and decryption.', 'type' => 'string', 'example' => 'HASH'], + 'AlgorithmType' => ['title' => '', 'description' => 'The algorithm type. Valid values: AES, DES, DESEDE, SM2, SM4, RSA, and FF1.', 'type' => 'string', 'example' => 'AES'], + 'GenerationType' => ['title' => '', 'description' => 'The generation method. Valid values:'."\n" + .'- SYSTEM_GENERATION: system-generated.'."\n" + .'- USER_GENERATION: user-generated.', 'type' => 'string', 'example' => 'SYSTEM_GENERATION'], + 'SubKeyCount' => ['title' => '', 'description' => 'The number of sub-keys.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'SecretKeyList' => [ + 'title' => '', + 'description' => 'The key values.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The key values.', 'type' => 'string', 'example' => 'abc123456'], + 'example' => '', + ], + 'IsOwnerManageOnly' => ['title' => '', 'description' => 'Indicates whether only the owner can manage the key.', 'type' => 'boolean', 'example' => ''], + 'EnableOpenapiQuery' => ['title' => '', 'description' => 'Indicates whether OpenAPI query is supported.', 'type' => 'boolean', 'example' => ''], + 'AlgorithmTypeAlias' => ['title' => '', 'description' => 'The alias of the algorithm type.', 'type' => 'string', 'example' => 'AES'], + 'Owner' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The owner name.', 'type' => 'string', 'example' => '张三'], ], - 'required' => true, - ], - 'Comment' => [ - 'title' => '发布信息(字符串长度限制1024)', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '发布', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"EnableOpenapiQuery\\": false,\\n \\"AlgorithmTypeAlias\\": \\"AES\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"OwnerName\\": \\"张三\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve key value by key name', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetSparkLocalClientInfo' => [ + 'summary' => 'Retrieves the Spark client information of the cluster associated with a compute source.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '232432343'], + ], + [ + 'name' => 'EnvEnum', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + ."\n" + .'- DEV: development environment.'."\n" + .'- PROD: production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'PublishResult' => [ - 'title' => '发布结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SubmitIdList' => [ - 'title' => '待发布记录id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '待发布记录id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'ClientName' => ['description' => 'The client name.', 'type' => 'string', 'example' => 'spark-clinet', 'title' => ''], + 'ClientFileResourceName' => ['description' => 'The client file name.', 'type' => 'string', 'example' => 'spark-cleint.zip', 'title' => ''], + 'ClientFileResourceId' => ['description' => 'The client file ID.', 'type' => 'string', 'example' => 'XXXX-XXXX-XXXX-XXXX', 'title' => ''], + 'Editable' => ['description' => 'Indicates whether the client information is editable.', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Retrieve spark client information of a compute source cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', - ], - 'ListPublishRecords' => [ - 'summary' => '分页获取发布记录列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:GetSparkLocalClientInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetStandard' => [ + 'summary' => 'Retrieves the details of a standard.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -29202,2386 +20397,2128 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'StandardGetQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询指令', - 'description' => '', + 'title' => '', + 'description' => 'The query command.', 'type' => 'object', 'properties' => [ - 'Keyword' => [ - 'title' => '搜索关键字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'SearchFilter' => [ - 'title' => '发布记录过滤器', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectIdList' => [ - 'title' => '项目id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890', - ], - 'required' => true, - ], - 'SubmitterList' => [ - 'title' => '提交人id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '提交人id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30897000', - ], - 'required' => false, - ], - 'ChangeTypeList' => [ - 'title' => '变更类型列表（0:新增/1:更新/2:删除', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '变更类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'required' => false, - ], - 'PublishStatusList' => [ - 'title' => '发布状态列表（0:失败/1:成功/2:发布中', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '发布状态', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'required' => false, - ], - 'PublishStartTime' => [ - 'title' => '发布开始时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-10-10 10:00:00', - ], - 'PublishEndTime' => [ - 'title' => '发布结束时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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, - ], + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Nullable' => ['title' => '', 'description' => 'Specifies whether to return a null value when the standard does not exist. If set to false, an exception is thrown. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Version' => ['title' => '', 'description' => 'The version number. If left empty, the latest version is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'StandardStage' => ['title' => '', 'description' => 'The stage to which the standard belongs. Valid values:'."\n" + .'- dev: development stage.'."\n" + .'- prod: production stage.'."\n" + ."\n" + .'Default value: prod.', 'type' => 'string', 'required' => false, 'example' => 'dev'], + 'NeedRelation' => ['title' => '', 'description' => 'Specifies whether to return associated standards and associated lookup tables. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ListResult' => [ - 'title' => '查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'StandardInfo' => [ + 'title' => '', + 'description' => 'The standard details.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'Id' => ['title' => '', 'description' => 'The lookup table.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'The status of the standard.', 'type' => 'string', 'example' => 'draft'], + 'Stage' => ['title' => '', 'description' => 'The stage to which the standard belongs.', 'type' => 'string', 'example' => 'dev'], + 'StandardTemplate' => [ + 'title' => '', + 'description' => 'The standard template on which the current standard depends.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The standard template name.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'The standard template code.', 'type' => 'string', 'example' => '1121'], + 'TemplateFrom' => ['title' => '', 'description' => 'The source of the standard template. Valid values:'."\n" + .'- CUSTOM: Custom standard template.'."\n" + .'- SYSTEM: System built-in standard template.', 'type' => 'string', 'example' => 'SYSTEM'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', ], - 'Data' => [ - 'title' => '发布记录列表查询结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '发布记录', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '发布记录id（非对象ID，在发布列表中全局唯一', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1241844456', - ], - 'PublishName' => [ - 'title' => '发布名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test_lc__20241118171502', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'example' => '1241844456', - ], - 'Publisher' => [ - 'title' => '发布人id', - 'description' => '', - 'type' => 'string', - 'example' => '307999999', - ], - 'PublisherName' => [ - 'title' => '发布人名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - 'GmtCreate' => [ - 'title' => '创建时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-10 10:00:00', - ], - 'GmtModify' => [ - 'title' => '修改时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-10 10:00:00', - ], - 'ChangeType' => [ - 'title' => '变更类型 0:新增/1:更新/2:删除', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1234567', - ], - 'NodeId' => [ - 'title' => '节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_123456', - ], - 'ObjectVersion' => [ - 'title' => '对象版本', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'FinishTime' => [ - 'title' => '发布完成时间 yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-10 10:10:10', - ], - 'ErrorMessage' => [ - 'title' => '发布错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'error', + 'StandardSet' => [ + 'title' => '', + 'description' => 'The standard set on which the current standard depends.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The standard set name.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'The standard set code.', 'type' => 'string', 'example' => 'cc'], + 'Directory' => ['title' => '', 'description' => 'The folder to which the standard set belongs.', 'type' => 'string', 'example' => '/dir1'], + ], + 'example' => '', + ], + 'EffectiveTimeConfig' => [ + 'title' => '', + 'description' => 'The effective period configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The effective period type. Valid values:'."\n" + .'- FOREVER: permanent.'."\n" + .'- TIME_PERIOD: time period.', 'type' => 'string', 'example' => 'TIME_PERIOD'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the effective period.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time of the effective period.', 'type' => 'string', 'example' => '2025-12-30 00:00:00'], + ], + 'example' => '', + ], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Owner' => [ + 'title' => '', + 'description' => 'The owner.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'Name' => ['title' => '', 'description' => 'The standard name.', 'type' => 'string', 'example' => 'test'], + 'EnglishName' => ['title' => '', 'description' => 'The English name of the standard.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'The standard code.', 'type' => 'string', 'example' => 'zz'], + 'Type' => ['title' => '', 'description' => 'The standard type.', 'type' => 'string', 'example' => 'zz'], + 'ModifyTime' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'LastModifier' => [ + 'title' => '', + 'description' => 'The last modifier.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'Creator' => [ + 'title' => '', + 'description' => 'The creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'AttributeWithValueList' => [ + 'title' => '', + 'description' => 'The attribute value configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '', + 'description' => 'The attribute details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'attr1'], + 'Code' => ['title' => '', 'description' => 'The attribute code.', 'type' => 'string', 'example' => 'test_attr'], + 'Type' => ['title' => '', 'description' => 'The attribute type. Valid values:'."\n" + .'- BIZ_ATTRIBUTE: business attribute.'."\n" + .'- TECH_ATTRIBUTE: technical attribute.'."\n" + .'- MANAGEMENT_ATTRIBUTE: management attribute.'."\n" + .'- QUALITY_ATTRIBUTE: quality attribute.'."\n" + .'- MASTER_DATA_ATTRIBUTE: master data attribute.'."\n" + .'- LIFECYCLE_ATTRIBUTE: lifecycle attribute.'."\n" + .'- SECURITY_ATTRIBUTE: security attribute.', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE'], + 'Required' => ['title' => '', 'description' => 'Indicates whether the attribute is required.', 'type' => 'boolean', 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The value configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value type. Valid values:'."\n" + .'- CUSTOMIZED: custom input.'."\n" + .'- SINGLE_ENUM: single enumeration value.'."\n" + .'- MULTIPLE_ENUMS: multiple enumeration values.'."\n" + .'- RANGE: range value.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The data type of the attribute value. Valid values:'."\n" + .'- STRING: string.'."\n" + .'- BIGINT: numeric type.'."\n" + .'- DOUBLE: floating-point type.'."\n" + .'- DATE: date, accurate to the day.'."\n" + .'- DATETIME: date, accurate to milliseconds.'."\n" + .'- BOOLEAN: Boolean.', 'type' => 'string', 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The length of the attribute value. If empty or -1, the length is not limited. Typically, only string types have a length limit for attribute values.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ValueRange' => [ + 'title' => '', + 'description' => 'The value range.', + 'type' => 'object', + 'properties' => [ + 'ValueConstraint' => ['title' => '', 'description' => 'The value source. Valid values:'."\n" + .'- NONE: no constraint.'."\n" + .'- LIST: obtained from a list.'."\n" + .'- LOOKUP_TABLE: lookup table.'."\n" + .'- MIN_MAX: value between the minimum and maximum.'."\n" + .'- DATAPHIN_ATTRIBUTE: Dataphin system property.'."\n" + .'- BUILT_IN_DATA_TYPES: built-in data types.'."\n" + .'- BUILT_IN_DATA_CLASSIFICATION: built-in data categorization.'."\n" + .'- BUILT_IN_DATA_LEVEL: built-in data security classification.', 'type' => 'string', 'example' => 'NONE'], + 'ValueList' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', 'type' => 'string', 'example' => '1'], + 'example' => '', + ], + 'MinMaxValueConfig' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to MIN_MAX.', + 'type' => 'object', + 'properties' => [ + 'MinValue' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'string', 'example' => '0'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'LookupTableReference' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LOOKUP_TABLE.', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Column' => ['title' => '', 'description' => 'The referenced lookup table field.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'DataphinAttributeType' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to DATAPHIN_ATTRIBUTE. Valid values:'."\n" + .'- BIZ_UNIT: business unit.'."\n" + .'- PROJECT: project.'."\n" + .'- USER: user.'."\n" + .'- USER_GROUP: user group.', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE'], + ], + 'example' => '', + ], + 'DefaultValue' => ['title' => '', 'description' => 'The default value.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'MonitorConfig' => [ + 'title' => '', + 'description' => 'The monitoring configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitoring method. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'The field to check.', 'type' => 'string', 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Indicates whether the check is case-sensitive.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'EnableMonitorConfig' => ['title' => '', 'description' => 'Indicates whether the monitoring configuration is enabled.', 'type' => 'boolean', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'RefAttribute' => [ + 'title' => '', + 'description' => 'The referenced attribute information.', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'AttributeFromInfo' => [ + 'title' => '', + 'description' => 'The attribute source.', + 'type' => 'object', + 'properties' => [ + 'AttributeFrom' => ['title' => '', 'description' => 'The attribute source. Valid values:'."\n" + .'- SYSTEM: system attribute.'."\n" + .'- CUSTOM: custom attribute.'."\n" + .'- STANDARD: standard.', 'type' => 'string', 'example' => 'CUSTOM'], + 'StandardReference' => [ + 'title' => '', + 'description' => 'The corresponding standard. This parameter takes effect when the attribute source is set to STANDARD.', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Id' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + ], + 'example' => '', ], - 'PublishStatus' => [ - 'title' => '发布状态 0：失败/1：成功/2：发布中', + 'Value' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'StandardGeneralMonitorConfig' => [ + 'title' => '', + 'description' => 'The standard monitoring configuration.', + 'type' => 'object', + 'properties' => [ + 'StandardMonitorConfigList' => [ + 'title' => '', + 'description' => 'The list of standard monitoring configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The monitoring configuration ID. If empty, a new monitoring configuration is created. If an existing monitoring configuration ID is specified, the corresponding monitoring configuration is updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The rule description.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The monitoring type. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'example' => 'METADATA'], + 'MonitorFrom' => ['title' => '', 'description' => 'The method by which the monitoring configuration is added. Valid values:'."\n" + .'- BY_USER: manually added.'."\n" + .'- BY_SYSTEM_ATTRIBUTE: preset by system attribute.', 'type' => 'string', 'example' => 'BY_SYSTEM_ATTRIBUTE'], + 'AttributeId' => ['title' => '', 'description' => 'The associated attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '112'], + 'AttributeName' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'teset'], + 'AttributeMonitorConfig' => [ + 'title' => '', + 'description' => 'The monitoring configuration of the associated attribute.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitoring method. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'The field to check.', 'type' => 'string', 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Indicates whether the check is case-sensitive.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'RuleSubType' => ['title' => '', 'description' => 'The rule subtype. Valid values:'."\n" + .'- BY_ATTRIBUTE: configured based on attributes.'."\n" + .'- CUSTOMIZED: custom configuration.'."\n" + ."\n" + .'This parameter is required when the monitoring type is QUALITY.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'QualityRuleTemplate' => [ + 'title' => '', + 'description' => 'The rule template. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Type' => ['title' => '', 'description' => 'The template source. Valid values:'."\n" + .'- FROM_SYSTEM: system template.'."\n" + .'- CUSTOMIZED: custom template.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + ], + 'example' => '', + ], + 'RuleConfigList' => [ + 'title' => '', + 'description' => 'The rule configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'example' => 'v1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'RuleValidateConfigList' => [ + 'title' => '', + 'description' => 'The rule validation configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The validation configuration ID. This ID is randomly generated by the business and must be unique.', 'type' => 'string', 'example' => 'abc'], + 'ParentId' => ['title' => '', 'description' => 'The parent validation configuration ID. The parent rule validation type can only be RELATION.', 'type' => 'string', 'example' => 'a'], + 'Type' => ['title' => '', 'description' => 'The rule validation type. Valid values:'."\n" + .'- RELATION: relation.'."\n" + .'- EXPRESSION: expression.', 'type' => 'string', 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'The operator. If the validation type is EXPRESSION, valid values:'."\n" + .'- EQUAL: equal to.'."\n" + .'- NOT_EQUAL: not equal to.'."\n" + .'- LARGER: greater than.'."\n" + .'- LARGE_OR_EQUAL: greater than or equal to.'."\n" + .'- SMALLER: less than.'."\n" + .'- SMALLER_OR_EQUAL: less than or equal to.'."\n" + ."\n" + .'If the validation type is RELATION, valid values:'."\n" + .'- AND: and.'."\n" + .'- OR: or.', 'type' => 'string', 'example' => 'AND'], + 'Metric' => ['title' => '', 'description' => 'The metric. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'example' => 'a'], + 'MetricName' => ['title' => '', 'description' => 'The metric name. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The comparison value.', 'type' => 'string', 'example' => '1'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'StandardRelations' => [ + 'title' => '', + 'description' => 'The list of associated standards.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'Version' => ['title' => '', 'description' => 'The standard version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'StandardStage' => ['title' => '', 'description' => 'The stage of the standard.', 'type' => 'string', 'example' => 'DEV'], + 'StandardStatus' => ['title' => '', 'description' => 'The standard status.', 'type' => 'string', 'example' => 'draft'], + 'RelationType' => ['title' => '', 'description' => 'The association type. Valid values:'."\n" + .'- RELATIVE.', 'type' => 'string', 'example' => 'RELATIVE'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'LookupTableRelations' => [ + 'title' => '', + 'description' => 'The list of associated lookup tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'LookupTableCode' => ['title' => '', 'description' => 'The lookup table code.', 'type' => 'string', 'example' => 'test'], + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1122'], + 'AttributeName' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'test'], + 'AttributeCode' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'zz'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\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\\": false\\n },\\n \\"EnableMonitorConfig\\": false,\\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\\": false\\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' => 'Get standard details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateStandardWordRoot' => [ - 'summary' => '更新数据标准词根。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetStandardLookupTable' => [ + 'summary' => 'Retrieves the details of a data standard lookup table.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], + [ + 'name' => 'Nullable', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to allow a null value to be returned when the lookup table does not exist. If set to false, an exception is thrown. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'LookupTableInfo' => [ + 'title' => '', + 'description' => 'The lookup table details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the lookup table.', 'type' => 'string', 'example' => '城市码表'], + 'Code' => ['title' => '', 'description' => 'The code of the lookup table.', 'type' => 'string', 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'The description of the lookup table.', 'type' => 'string', 'example' => 'test'], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012021'], + 'CreatorName' => ['title' => '', 'description' => 'The username of the creator.', 'type' => 'string', 'example' => 'test'], + 'LastModifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012021'], + 'LastModifierName' => ['title' => '', 'description' => 'The username of the last modifier.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012021'], + 'OwnerName' => ['title' => '', 'description' => 'The username of the owner.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'LookupTableValueList' => [ + 'title' => '', + 'description' => 'The list of lookup table values.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The code value.', 'type' => 'string', 'example' => '杭州'], + 'Name' => ['title' => '', 'description' => 'The code name.', 'type' => 'string', 'example' => 'Hangzhou'], + 'EnglishName' => ['title' => '', 'description' => 'The English name of the code.', 'type' => 'string', 'example' => 'HZ'], + 'Description' => ['title' => '', 'description' => 'The code description.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'The directory to which the lookup table belongs.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The directory to which the lookup table belongs.', 'type' => 'string', 'example' => '/dir1/dir2'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data standard lookup table details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateStandardTemplate' => [ - 'summary' => '更新数据标准模板。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetStandardSet' => [ + 'summary' => 'Retrieves the details of a standard set.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], + [ + 'name' => 'Nullable', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to allow a null value to be returned when the standard set does not exist. If set to false, an exception is thrown. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'StandardSetInfo' => [ + 'title' => '', + 'description' => 'The details of the standard set.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the standard set.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'The code of the standard set.', 'type' => 'string', 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'The description of the standard set.', 'type' => 'string', 'example' => 'test'], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'The directory to which the standard set belongs.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The parent directory.', 'type' => 'string', 'example' => '/dir1'], + ], + 'example' => '', + ], + 'MaintainerList' => [ + 'title' => '', + 'description' => 'The list of maintainers.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'MemberList' => [ + 'title' => '', + 'description' => 'The list of members.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'MemberGroupList' => [ + 'title' => '', + 'description' => 'The list of member groups.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '1121'], + 'Name' => ['title' => '', 'description' => 'The user group name.', 'type' => 'string', 'example' => 'testGroup'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'VisibilityConfig' => [ + 'title' => '', + 'description' => 'The visibility configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The visibility type. Valid values:'."\n" + .'- PUBLIC: public.'."\n" + .'- PRIVATE: private. Only standard set members and administrators can view the standard set.'."\n" + .'- SPECIFIED: visible to specified users only.', 'type' => 'string', 'example' => 'PUBLIC'], + 'SpecifiedUserList' => [ + 'title' => '', + 'description' => 'The list of specified users who can view the standard set. This parameter takes effect only when the visibility type is set to SPECIFIED.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Creator' => [ + 'title' => '', + 'description' => 'The creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'LastModifier' => [ + 'title' => '', + 'description' => 'The user who last modified the standard set.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the standard set was created.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The time when the standard set was last modified.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ApprovalConfig' => [ + 'title' => '', + 'description' => 'The approval configuration for going online.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Indicates whether approval is enabled.', 'type' => 'boolean', 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Indicates whether batch approval submission is enabled.', 'type' => 'boolean', 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'The approval process type. Valid values:'."\n" + .'- BY_DEFAULT: default approval type.'."\n" + .'- BY_TEMPLATE: approval based on an approval template.', 'type' => 'string', 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'The approval template ID. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + ], + 'example' => '', + ], + 'OfflineApprovalConfig' => [ + 'title' => '', + 'description' => 'The approval configuration for going offline.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Indicates whether approval is enabled.', 'type' => 'boolean', 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Indicates whether batch approval submission is enabled.', 'type' => 'boolean', 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'The approval process type. Valid values:'."\n" + .'- BY_DEFAULT: default approval type.'."\n" + .'- BY_TEMPLATE: approval based on an approval template.', 'type' => 'string', 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'The approval template ID. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + ], + 'example' => '', + ], + 'DefaultStandardTemplateId' => ['title' => '', 'description' => 'The default standard template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"IsSubmitInBatch\\": false,\\n \\"ApprovalType\\": \\"BY_DEFAULT\\",\\n \\"TemplateId\\": 1121\\n },\\n \\"OfflineApprovalConfig\\": {\\n \\"EnableApproval\\": false,\\n \\"IsSubmitInBatch\\": false,\\n \\"ApprovalType\\": \\"BY_DEFAULT\\",\\n \\"TemplateId\\": 1121\\n },\\n \\"DefaultStandardTemplateId\\": 1001\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve standard set details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetStandardStatistics' => [ + 'summary' => 'Queries the number of standards grouped by standard type under a specified folder.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'UpdateCommand', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'StatisticsQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The statistical query instruction.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '标准模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - 'Version' => [ - 'title' => '版本号, 空或-1表示最新版本', - 'description' => '', - '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', + 'Directory' => ['title' => '', 'description' => 'The folder to which the standards belong. The search includes all subfolders under this folder.', 'type' => 'string', 'required' => true, 'example' => '/dir1'], + 'StandardStageList' => [ + 'title' => '', + 'description' => 'The stages to which the standards belong.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The stages to which the standards belong.', 'type' => 'string', 'required' => false, 'example' => 'dev'], 'required' => false, - 'example' => 'test', + 'example' => '', ], - 'MaintainerList' => [ - 'title' => '维护人员', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '维护人员', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '300000913', + 'CreateTimePeriod' => [ + 'title' => '', + 'description' => 'The creation time period.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2025-06-01 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00'], + 'IncludeEndTime' => ['title' => '', 'description' => 'Specifies whether to include the end time. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => false, + 'example' => '', ], - 'AttributesConfig' => [ - 'title' => '属性配置', - 'description' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The statistical results.', 'type' => 'object', 'properties' => [ - 'AttributeList' => [ - 'title' => '属性列表', - 'description' => '', + 'StandardTypeCountList' => [ + 'title' => '', + 'description' => 'The mapping between standard types and the number of standards for each type. If the standard type is empty, the key is EMPTY.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => '', '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'STRING', - ], - 'Length' => [ - 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NONE', - ], - 'ValueList' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'MinMaxValueConfig' => [ - 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'AttributeFromInfo' => [ - 'title' => '属性来源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeFrom' => [ - 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOM', - ], - 'StandardReference' => [ - 'title' => '对应的标准,属性来源为 STANDARD 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'AutoConfig' => [ - 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', - 'description' => '', - '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' => '', - '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, + 'StandardType' => ['title' => '', 'description' => 'The standard type.', 'type' => 'string', 'example' => 'test'], + 'Count' => ['title' => '', 'description' => 'The number of standards.', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], + 'TotalCount' => ['title' => '', 'description' => 'The total number of standards.', 'type' => 'integer', 'format' => 'int32', 'example' => '101'], ], - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query standard count by standard type under a folder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateStandardSet' => [ - 'summary' => '更新标准集。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetStandardTemplate' => [ + 'summary' => 'Retrieves the details of a data standard template.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The standard template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + ], + [ + 'name' => 'Nullable', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to allow a null value to be returned when the template does not exist. If set to false, an exception is thrown. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'FilterQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The filter condition.', 'type' => 'object', 'properties' => [ - 'StandardSetId' => [ - 'title' => '标准集Id', - 'description' => '', - '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' => '', + 'Version' => ['title' => '', 'description' => 'The version number. If this parameter is left empty or set to -1, the latest version is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'TemplateInfo' => [ + 'title' => '', + 'description' => 'The template details.', '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PUBLIC', - ], - 'SpecifiedUserList' => [ - 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The standard template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'TemplateFrom' => ['title' => '', 'description' => 'The source of the standard template. Valid values:'."\n" + .'- CUSTOM: custom standard template.'."\n" + .'- SYSTEM: system built-in standard template.', 'type' => 'string', 'example' => 'SYSTEM'], + 'UniqueId' => ['title' => '', 'description' => 'uniqueId', 'type' => 'string', 'example' => '1101'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The name of the standard template.', 'type' => 'string', 'example' => '测试模板'], + 'Code' => ['title' => '', 'description' => 'The code of the standard template. This value is globally unique and cannot be modified when references exist.', 'type' => 'string', 'example' => 'test01'], + 'Description' => ['title' => '', 'description' => 'The description of the standard template.', 'type' => 'string', 'example' => 'test'], + 'MaintainerList' => [ + 'title' => '', + 'description' => 'The list of maintainers.', 'type' => 'array', 'items' => [ - 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', + 'title' => '', 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1121', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_DEFAULT', - ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1121', + 'example' => '', ], - ], - 'required' => false, - ], - 'OfflineApprovalConfig' => [ - 'title' => '下线审批配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EnableApproval' => [ - 'title' => '是否开启审批', - 'description' => '', - 'type' => 'boolean', - 'required' => true, + 'Creator' => [ + 'title' => '', + 'description' => 'The creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', ], - 'IsSubmitInBatch' => [ - 'title' => '是否批量提交审批', - 'description' => '', - 'type' => 'boolean', - 'required' => true, + 'LastModifier' => [ + 'title' => '', + 'description' => 'The last modifier.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', ], - 'ApprovalType' => [ - 'title' => '审批流程类型：BY_DEFAULT 默认审批类型、BY_TEMPLATE 基于审批模板', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_DEFAULT', + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'AttributesConfig' => [ + 'title' => '', + 'description' => 'The attribute configuration.', + 'type' => 'object', + 'properties' => [ + 'AttributeList' => [ + 'title' => '', + 'description' => 'The list of attributes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'attr1'], + 'Code' => ['title' => '', 'description' => 'The attribute code.', 'type' => 'string', 'example' => 'test_attr'], + 'Type' => ['title' => '', 'description' => 'The attribute type. Valid values:'."\n" + .'- BIZ_ATTRIBUTE: business attribute.'."\n" + .'- TECH_ATTRIBUTE: technical attribute.'."\n" + .'- MANAGEMENT_ATTRIBUTE: management attribute.'."\n" + .'- QUALITY_ATTRIBUTE: quality attribute.'."\n" + .'- MASTER_DATA_ATTRIBUTE: master data attribute.'."\n" + .'- LIFECYCLE_ATTRIBUTE: lifecycle attribute.'."\n" + .'- SECURITY_ATTRIBUTE: security attribute.', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE'], + 'Required' => ['title' => '', 'description' => 'Indicates whether the attribute is required.', 'type' => 'boolean', 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The value configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value type. Valid values:'."\n" + .'- CUSTOMIZED: custom input.'."\n" + .'- SINGLE_ENUM: single enumeration value.'."\n" + .'- MULTIPLE_ENUMS: multiple enumeration values.'."\n" + .'- RANGE: range value.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The data type of the attribute value. Valid values:'."\n" + .'- STRING: string.'."\n" + .'- BIGINT: numeric.'."\n" + .'- DOUBLE: floating-point.'."\n" + .'- DATE: date, accurate to the day.'."\n" + .'- DATETIME: date, accurate to the millisecond.'."\n" + .'- BOOLEAN: Boolean.', 'type' => 'string', 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The length of the attribute value. If this parameter is left empty or set to -1, the length is not limited. Typically, only string types have a length limit for attribute values.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ValueRange' => [ + 'title' => '', + 'description' => 'The value range.', + 'type' => 'object', + 'properties' => [ + 'ValueConstraint' => ['title' => '', 'description' => 'The value source. Valid values:'."\n" + .'- NONE: no constraint.'."\n" + .'- LIST: obtained from a list.'."\n" + .'- LOOKUP_TABLE: lookup table.'."\n" + .'- MIN_MAX: value between the minimum and maximum.'."\n" + .'- DATAPHIN_ATTRIBUTE: Dataphin system property.'."\n" + .'- BUILT_IN_DATA_TYPES: built-in data types.'."\n" + .'- BUILT_IN_DATA_CLASSIFICATION: built-in data categorization.'."\n" + .'- BUILT_IN_DATA_LEVEL: built-in data security classification.', 'type' => 'string', 'example' => 'NONE'], + 'ValueList' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', 'type' => 'string', 'example' => '1'], + 'example' => '', + ], + 'MinMaxValueConfig' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to MIN_MAX.', + 'type' => 'object', + 'properties' => [ + 'MinValue' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'string', 'example' => '0'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'LookupTableReference' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LOOKUP_TABLE.', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Column' => ['title' => '', 'description' => 'The referenced lookup table field.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'DataphinAttributeType' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to DATAPHIN_ATTRIBUTE. Valid values:'."\n" + .'- BIZ_UNIT: data domain.'."\n" + .'- PROJECT: project.'."\n" + .'- USER: user.'."\n" + .'- USER_GROUP: user group.', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE'], + ], + 'example' => '', + ], + 'DefaultValue' => ['title' => '', 'description' => 'The default value.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'MonitorConfig' => [ + 'title' => '', + 'description' => 'The monitoring configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitoring method. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'The field to check.', 'type' => 'string', 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Indicates whether the check is case-sensitive.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'EnableMonitorConfig' => ['title' => '', 'description' => 'Indicates whether monitoring configuration is enabled.', 'type' => 'boolean', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'RefAttribute' => [ + 'title' => '', + 'description' => 'The referenced attribute information.', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'AttributeFromInfo' => [ + 'title' => '', + 'description' => 'The attribute source.', + 'type' => 'object', + 'properties' => [ + 'AttributeFrom' => ['title' => '', 'description' => 'The attribute source. Valid values:'."\n" + .'- SYSTEM: system attribute.'."\n" + .'- CUSTOM: custom attribute.'."\n" + .'- STANDARD: standard.', 'type' => 'string', 'example' => 'CUSTOM'], + 'StandardReference' => [ + 'title' => '', + 'description' => 'The corresponding standard. This parameter takes effect when the attribute source is set to STANDARD.', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Id' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1121', + 'CodeRuleConfig' => [ + 'title' => '', + 'description' => 'The auto-generation rule configuration for the standard code.', + 'type' => 'object', + 'properties' => [ + 'GenerateType' => ['title' => '', 'description' => 'The standard code generation method. Valid values:'."\n" + .'- CUSTOMIZED: custom.'."\n" + .'- AUTO_GENERATE: automatically generated based on the standard code rule.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'AutoConfig' => [ + 'title' => '', + 'description' => 'The auto-generation configuration for the standard code rule. This parameter takes effect when the generation method is set to AUTO_GENERATE.', + 'type' => 'object', + 'properties' => [ + 'NeedStrongValidate' => ['title' => '', 'description' => 'Indicates whether strong validation is required.', 'type' => 'boolean', 'example' => ''], + 'CodeRuleList' => [ + 'title' => '', + 'description' => 'The standard code rules.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'The position index of the code rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The code rule type. Valid values:'."\n" + .'- FIXED_STRING: fixed string.'."\n" + .'- AUTO_INCREMENT: auto-increment sequence.'."\n" + .'- STANDARD_SET_CODE: standard set code.', 'type' => 'string', 'example' => 'FIXED_STRING'], + 'Value' => ['title' => '', 'description' => 'The format or value of the code rule.', 'type' => 'string', 'example' => 'test'], + 'AutoIncrementSequenceConfig' => [ + 'title' => '', + 'description' => 'The auto-increment sequence configuration.', + 'type' => 'object', + 'properties' => [ + 'Digit' => ['title' => '', 'description' => 'The number of digits.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'StartValue' => ['title' => '', 'description' => 'The start value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Step' => ['title' => '', 'description' => 'The step size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NeedPaddingZero' => ['title' => '', 'description' => 'Indicates whether zero-padding is required.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], - 'required' => false, - ], - 'DefaultStandardTemplateId' => [ - 'title' => '默认标准模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1001', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\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\\": false\\n },\\n \\"EnableMonitorConfig\\": false,\\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\\": false,\\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\\": false\\n }\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve data standard template details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetStandardWordRoot' => [ + 'summary' => 'Retrieves the details of a data standard word root.'."\n" + .'Online version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the word root.', 'type' => 'string', 'required' => true, 'example' => '平均值'], + ], + [ + 'name' => 'Nullable', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to allow a null value to be returned when the word root does not exist. If set to false, an exception is thrown. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'WordRootInfo' => [ + 'title' => '', + 'description' => 'The word root details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the word root.', 'type' => 'string', 'example' => '平均值'], + 'FullName' => ['title' => '', 'description' => 'The full name of the word root.', 'type' => 'string', 'example' => 'average'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the word root.', 'type' => 'string', 'example' => 'avg'], + 'Description' => ['title' => '', 'description' => 'The description of the word root.', 'type' => 'string', 'example' => 'test'], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012021'], + 'CreatorName' => ['title' => '', 'description' => 'The username of the creator.', 'type' => 'string', 'example' => 'test'], + 'LastModifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012021'], + 'LastModifierName' => ['title' => '', 'description' => 'The username of the last modifier.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve data standard word root details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateStandardMappingToInvalid' => [ - 'summary' => '将标准映射关系置为无效映射。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetStreamJobs' => [ + 'summary' => 'Retrieves the list of real-time development nodes.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'GuidList' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1022', - ], - 'required' => false, - ], - 'BelongGuidList' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1023', - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Dataphin project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7162269257990111'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Dataphin environment. Valid values:'."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task object.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + .'- 0: draft.'."\n" + .'- 1: submitting.'."\n" + .'- 2: submitted.'."\n" + .'- 3: published.'."\n" + .'- 100: in development.', 'type' => 'string', 'example' => '0'], + 'Type' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- FLINK_SQL'."\n" + .'- FLINK_DATASTREAM.', 'type' => 'string', 'example' => 'FLINK_SQL'], + 'OwnerId' => ['title' => '', 'description' => 'The ID of the creator.', 'type' => 'string', 'example' => '300006788'], + 'JobName' => ['title' => '', 'description' => 'The name of the real-time node.', 'type' => 'string', 'example' => 'flink_order_detail'], + 'ProjectId' => ['title' => '', 'description' => 'The Dataphin project ID.', 'type' => 'string', 'example' => '7162269257990111'], + 'Id' => ['title' => '', 'description' => 'The mapping ID of the real-time node.', 'type' => 'integer', 'format' => 'int64', 'example' => '716555'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development.'."\n" + .'- PROD: production.', 'type' => 'string', 'example' => 'DEV'], + 'ModifierId' => ['title' => '', 'description' => 'The ID of the user who last modified the node.', 'type' => 'string', 'example' => '300006788'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'UpdateStandardLookupTable' => [ - 'summary' => '更新数据标准码表。', - 'methods' => [ - 'post', + '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' => 'Retrieve real-time development nodes', + 'changeSet' => [ + ['createdAt' => '2025-07-01T03:29:33.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + 'ramActions' => [], + ], + 'GetSupplementDagrun' => [ + 'summary' => 'Retrieves dagrun information for all business dates of a data backfill instance workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'SupplementId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data backfill instance.', 'type' => 'string', 'required' => true, 'example' => 'f_8241792_20201202_2099680'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + ."\n" + .'- DEV: development environment.'."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '码表Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30012021', - ], - 'LookupTableValueList' => [ - 'title' => '码表值列表', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'DagrunList' => [ + 'title' => '', + 'description' => 'The list of dagruns.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => 'The dagrun details.', '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', - ], + 'Id' => ['title' => '', 'description' => 'Dagrun ID', 'type' => 'string', 'example' => 'dr_2242792_14542'], + 'BizDate' => ['title' => '', 'description' => 'The business date. The time format must conform to the partition format specified by the business unit.', 'type' => 'string', 'example' => '2024-04-01'], + 'Status' => ['title' => '', 'description' => 'The status of the data backfill instance workflow. Valid values:'."\n" + ."\n" + .'- INIT: dagrun init.'."\n" + .'- CREATE_FAILED: dagrun creation failed.'."\n" + .'- CREATED: dagrun created.'."\n" + .'- READY: dagrun ready for exec.'."\n" + .'- RUNNING: dagrun running.'."\n" + .'- KILLED: dagrun stopped.'."\n" + .'- FAILED: dagrun failed.'."\n" + .'- SUCCESS: dagrun succeeded.', 'type' => 'string', 'example' => 'RUNNING'], + 'StartExecuteTime' => ['title' => '', 'description' => 'The execution start timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717081729000'], + 'EndExecuteTime' => ['title' => '', 'description' => 'The execution end timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717081789000'], + 'SupplementId' => ['title' => '', 'description' => 'The ID of the data backfill instance workflow.', 'type' => 'string', 'example' => 'f_8241792_20201202_2099680'], + 'Duration' => ['title' => '', 'description' => 'The runtime duration, in seconds.', 'type' => 'string', 'example' => '60s'], + ], + 'example' => '', ], - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List dagruns of a data backfill instance workflow', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateStandard' => [ - 'summary' => '更新标准。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetSupplementDagrun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'GetSupplementDagrunInstance' => [ + 'summary' => 'Lists the instances of all nodes for a specific business date in a data backfill workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'DagrunId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The dagrun ID.', 'type' => 'string', 'required' => true, 'example' => 'dr_2242792_14542'], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The response.', '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' => '', - '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' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'InstanceList' => [ + 'title' => '', + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The instance details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 't_239496_20210411_246982077481'], + 'Type' => ['title' => '', 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- NORMAL: periodic instance.'."\n" + .'- SUPPLEMENT: data backfill instance.'."\n" + .'- MANUAL: manual instance.', 'type' => 'string', 'example' => 'SUPPLEMENT'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-01'], + 'DueTime' => ['title' => '', 'description' => 'The scheduled date.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-02'], + 'StatusList' => [ 'title' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeId' => [ - 'title' => '属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1011', - ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, + 'description' => 'The list of instance statuses. A physical instance list contains only one status. Valid values:'."\n" + ."\n" + .'- NIT: init.'."\n" + .'- WATING: waiting.'."\n" + .'- RUNNING: running.'."\n" + .'- SUCCESS: succeeded.'."\n" + .'- FAILED: failed.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS'], + 'example' => '', ], - 'required' => false, - ], - ], - 'required' => true, - ], - 'StandardSetReference' => [ - 'title' => '标准集的引用, 表示当前标准所属的标准集', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '标准集Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - ], - 'required' => true, - ], - 'EffectiveTimeConfig' => [ - 'title' => '生效时间配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', - 'description' => '', - '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' => [ + 'StartExecuteTime' => ['title' => '', 'description' => 'The start time of the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-12 00:00:00'], + 'EndExecuteTime' => ['title' => '', 'description' => 'The end time of the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-04-12 00:25:02'], + 'Duration' => ['title' => '', 'description' => 'The execution duration. Unit: seconds.', 'type' => 'string', 'example' => '60'], + 'Index' => ['title' => '', 'description' => 'The sequence number of the hourly or minutely instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExtendInfo' => ['title' => '', 'description' => 'The extended information. This field contains information specific to instances of different business systems, such as the fileId of a pipeline, whether a logical table is a hierarchy dimension table, mid-node information, and instance output names.', 'type' => 'string', 'example' => '{"a":"b"}'], + 'NodeInfo' => [ 'title' => '', + 'description' => 'The details of the node associated with the instance.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'METADATA', - ], - 'MonitorFrom' => [ - 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_SYSTEM_ATTRIBUTE', + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_239496'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'- DATA_PROCESS: code node.'."\n" + .'- BBOX_LOGIC_TABLE_NODE: black box logical table node.'."\n" + .'- ONE_ID_LABEL: extraction label node.'."\n" + .'- ONE_ID_RULE: extraction label node.'."\n" + .'- PIPELINE_NODE: pipeline node.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'From' => ['title' => '', 'description' => 'The source business system. Valid values:'."\n" + ."\n" + .'- DATA_PROCESS: code development.'."\n" + .'- BLACK_BOX: black box.'."\n" + .'- ONE_ID: extraction.'."\n" + .'- PIPELINE: pipeline.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'SubDetailType' => ['title' => '', 'description' => 'The node subtype.', 'type' => 'string', 'example' => 'SHELL'], + 'Description' => ['title' => '', 'description' => 'The node description.', 'type' => 'string', 'example' => 'xx测试'], + 'DryRun' => ['title' => '', 'description' => 'Indicates whether the node is a dry run.', 'type' => 'boolean', 'example' => 'true'], + 'SchedulePaused' => ['title' => '', 'description' => 'Indicates whether the node is paused.', 'type' => 'boolean', 'example' => 'true'], + 'HasProd' => ['title' => '', 'description' => 'Indicates whether the node exists in the production environment.', 'type' => 'boolean', 'example' => 'true'], + 'HasDev' => ['title' => '', 'description' => 'Indicates whether the node exists in the development environment.', 'type' => 'boolean', 'example' => 'true'], + 'ResourceGroupList' => [ + 'title' => '', + 'description' => 'The schedule resource groups.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The schedule resource groups.', 'type' => 'string', 'example' => 'rs_group_test'], + 'example' => '', ], - 'AttributeId' => [ - 'title' => '关联的属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '112', + 'PriorityList' => [ + 'title' => '', + 'description' => 'The priority. Valid values:'."\n" + ."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The priority.', 'type' => 'string', 'example' => 'MIDDLE'], + 'example' => '', ], - 'AttributeName' => [ - 'title' => '属性名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'teset', + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'The scheduling period. Valid values:'."\n" + ."\n" + .'- MINUTELY'."\n" + .'- HOURLY'."\n" + .'- DAILY'."\n" + .'- WEEKLY'."\n" + .'- MONTHLY'."\n" + .'- QUARTERLY.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The scheduling period.', 'type' => 'string', 'example' => 'DAILY'], + 'example' => '', ], - 'AttributeMonitorConfig' => [ - 'title' => '关联属性的监控配置', - 'description' => '', + 'BizUnitName' => ['title' => '', 'description' => 'The business unit.', 'type' => 'string', 'example' => 'xx测试'], + 'Creator' => [ + 'title' => '', + 'description' => 'The creator of the node.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'METADATA', - ], - 'ColumnName' => [ - 'title' => '检查的字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - 'IsCaseSensitive' => [ - 'title' => '大小写是否敏感', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1001012'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], ], - 'required' => false, - ], - 'RuleSubType' => [ - 'title' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOMIZED', + 'example' => '', ], - 'QualityRuleTemplate' => [ - 'title' => '规则模板, 当监控类型为 QUALITY 时必填', - 'description' => '', + 'Modifier' => [ + 'title' => '', + 'description' => 'The modifier.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - 'Type' => [ - 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - ], - 'required' => false, - ], - 'RuleConfigList' => [ - 'title' => '规则配置, 当监控类型为 QUALITY 时必填', - '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, + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1001012'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], ], - 'required' => false, + 'example' => '', ], - 'RuleValidateConfigList' => [ - 'title' => '规则校验配置, 当监控类型为 QUALITY 时必填', - 'description' => '', + 'OwnerList' => [ + 'title' => '', + 'description' => 'The owners of the node.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => 'The owners of the node.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '校验配置Id, 由业务随机生成且确保唯一', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], - 'ParentId' => [ - 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Type' => [ - 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AND', - ], - 'Metric' => [ - 'title' => '指标, 校验类型为 EXPRESSION 时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'MetricName' => [ - 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Value' => [ - 'title' => '比较的值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1001012'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], ], - 'required' => false, + 'example' => '', ], - 'required' => false, + 'example' => '', ], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-30 10:08:49'], + 'LastModifiedTime' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-01-30 10:08:49'], ], - 'required' => false, + 'example' => '', ], - 'required' => true, ], + 'example' => '', ], - 'required' => false, - ], - 'NeedGenerateStandardCode' => [ - 'title' => '是否需要基于规则生成标准编码，如果为true则属性值部分填入的标准编码无效将重新生成', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List instances in a data backfill workflow dagrun', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'OfflineStandard' => [ - 'summary' => '下线标准。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetSupplementDagrunInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetTableColumnLineageByTaskId' => [ + 'summary' => 'Queries table column lineage information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'OfflineCommand', + 'name' => 'TableColumnLineageByTaskIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '下线指令', - 'description' => '', + 'title' => '', + 'description' => 'Data structure for querying table column lineage.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - 'Comment' => [ - 'title' => '审核备注,最多128字符', - 'description' => '', + 'TaskId' => ['title' => '', 'description' => 'Task (node) ID used to filter the query.', 'type' => 'string', 'required' => true, 'example' => 'n_123'], + 'TaskEnv' => [ + 'title' => '', + 'description' => 'Environment of the task to query: DEV or PROD.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'required' => false, + 'example' => 'DEV', ], + 'NeedNotExistObject' => ['title' => '', 'description' => 'Specifies whether to return tables that do not exist in the asset inventory. If this parameter is not specified, non-existent tables are not returned.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'Query results.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Lineage details.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'TaskId' => ['title' => '', 'description' => 'Task (node) ID associated with the lineage.', 'type' => 'string', 'example' => 'n_123'], + 'TaskEnv' => ['title' => '', 'description' => 'Environment of the task (node) associated with the lineage: DEV or PROD.', 'type' => 'string', 'example' => 'DEV'], + 'InputEnv' => ['title' => '', 'description' => 'Environment of the input table: DEV or PROD.', 'type' => 'string', 'example' => 'DEV'], + 'InputTableId' => ['title' => '', 'description' => 'GUID of the input table. Each asset has a unique GUID in the following format: '."\n" + ."\n" + .'- Logical table: dp_table.[TenantId].[BizUnitName].[TableName]'."\n" + .'- Compute source physical table: [EngineType].[TenantId].[ProjectName].[TableName]'."\n" + .'- Data source table: dp_ds_table.[TenantId].[DataSourceId].[SchemaName].[TableName]', 'type' => 'string', 'example' => 'odps.123.test_project.order'], + 'InputTableName' => ['title' => '', 'description' => 'Input table name.', 'type' => 'string', 'example' => 'order'], + 'InputColumnId' => ['title' => '', 'description' => 'GUID of the input column.', 'type' => 'string', 'example' => 'odps.123.test_project.input_table.id'], + 'InputColumnName' => ['title' => '', 'description' => 'Input column name.', 'type' => 'string', 'example' => 'id'], + 'InputTableType' => ['title' => '', 'description' => 'Input table type. Valid values:'."\n" + .'- PHYSICAL_TABLE: Physical table (compute source)'."\n" + .'- DIM_LOGIC_TABLE: Dimension logical table'."\n" + .'- FACT_LOGIC_TABLE: Fact logical table'."\n" + .'- SUM_LOGIC_TABLE: Summary logical table'."\n" + .'- REAL_TIME_LOGIC_TABLE: Real-time meta table'."\n" + .'- REAL_TIME_MIRROR_TABLE: Real-time mirror table'."\n" + .'- PHYSICAL_VIEW: Physical view'."\n" + .'- LOGICAL_VIEW: Logical view'."\n" + .'- DATA_SOURCE_PHYSICAL_TABLE: Data source table'."\n" + .'- DATA_SOURCE_VIEW: Data source view'."\n" + .'- DATA_SOURCE_MATERIALIZED_VIEW: Data source materialized view', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'InputDataSourceType' => ['title' => '', 'description' => 'Storage type of the input table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputDbType' => ['title' => '', 'description' => 'Database type of the input table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputProjectId' => ['title' => '', 'description' => 'Project ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputBizUnitId' => ['title' => '', 'description' => 'Business unit ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputDataSourceId' => ['title' => '', 'description' => 'Data source ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the input table is deleted.', 'type' => 'boolean', 'example' => ''], + 'OutputTableType' => ['title' => '', 'description' => 'Output table type. For valid values, see InputTableType.', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'OutputEnv' => ['title' => '', 'description' => 'Environment of the output table: DEV or PROD.', 'type' => 'string', 'example' => 'DEV'], + 'OutputBizUnitId' => ['title' => '', 'description' => 'Business unit ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputDataSourceType' => ['title' => '', 'description' => 'Storage type of the output table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputDbType' => ['title' => '', 'description' => 'Database type of the output table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputProjectId' => ['title' => '', 'description' => 'Project ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputDataSourceId' => ['title' => '', 'description' => 'Data source ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputTableId' => ['title' => '', 'description' => 'GUID of the output table. Each asset has a unique GUID. For the format, see InputTableId.', 'type' => 'string', 'example' => 'odps.123.test_project.order'], + 'OutputTableName' => ['title' => '', 'description' => 'Output table name.', 'type' => 'string', 'example' => 'order'], + 'OutputColumnId' => ['title' => '', 'description' => 'GUID of the output column.', 'type' => 'string', 'example' => 'odps.123.test_project.input_table.id'], + 'OutputColumnName' => ['title' => '', 'description' => 'Output column name.', 'type' => 'string', 'example' => 'id'], + 'OutputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the output table is deleted.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false,\\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\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Table Column Lineage Query', + 'extraInfo' => 'API release version: v5.1.0', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'PublishStandard' => [ - 'summary' => '发布标准。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetTableColumnLineages' => [ + 'summary' => 'Queries the column-level data lineage of an asset table.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'PublishCommand', + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The GUID of the table, which is the unique identifier of the asset.', 'type' => 'string', 'required' => true, 'example' => '1121'], + ], + [ + 'name' => 'FilterQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '发布指令', - 'description' => '', + 'title' => '', + 'description' => 'The filter conditions.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - 'Version' => [ - 'title' => '版本号, 默认取值-1（最新版本号）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'StandardStage' => [ - 'title' => '标准的阶段 :DEV、PROD，默认 DEV', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV', - ], - 'AutoPublishAfterApproval' => [ - 'title' => '是否在审批成功后自动发布， 默认 true', - 'description' => '', - 'type' => 'boolean', + 'NodeEnv' => ['title' => '', 'description' => 'The environment of the nodes to query. Valid values: dev and prod.', 'type' => 'string', 'required' => false, 'example' => 'dev'], + 'NodeIdList' => [ + 'title' => '', + 'description' => 'The list of node IDs to filter.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of node IDs to filter.', 'type' => 'string', 'required' => false, 'example' => '110021'], 'required' => false, + 'example' => '', ], - 'ReviewerIdList' => [ - 'title' => '指定的审批人', - 'description' => '', + 'NeedUpstream' => ['title' => '', 'description' => 'Specifies whether to query upstream lineage. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'NeedDownstream' => ['title' => '', 'description' => 'Specifies whether to query downstream lineage. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'NeedNotExistObject' => ['title' => '', 'description' => 'Specifies whether to return tables that do not exist in the asset inventory. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'TableColumnLineageList' => [ + 'title' => '', + 'description' => 'The list of table column lineage records.', 'type' => 'array', 'items' => [ - 'title' => '指定的审批人', + 'title' => '', 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'The node ID associated with the lineage.', 'type' => 'string', 'example' => '110021'], + 'NodeEnv' => ['title' => '', 'description' => 'The environment of the node. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'InputTableEnv' => ['title' => '', 'description' => 'The environment of the input table. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'InputTableGuid' => ['title' => '', 'description' => 'The GUID of the input table. Each asset has a unique identifier.', 'type' => 'string', 'example' => '123211'], + 'InputTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'example' => 't_input'], + 'InputColumnName' => ['title' => '', 'description' => 'The name of the input column.', 'type' => 'string', 'example' => 'col1'], + 'InputColumnGuid' => ['title' => '', 'description' => 'The GUID of the input column. Format: TableGuid.ColumnName.', 'type' => 'string', 'example' => '1121.col1'], + 'InputProjectId' => ['title' => '', 'description' => 'The ID of the project to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1233'], + 'InputBizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InputDataSourceId' => ['title' => '', 'description' => 'The ID of the data source to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InputDataSourceType' => ['title' => '', 'description' => 'The type of the data source to which the input table belongs.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the input table has been deleted.', 'type' => 'boolean', 'example' => ''], + 'OutputTableEnv' => ['title' => '', 'description' => 'The environment of the output table. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'OutputTableGuid' => ['title' => '', 'description' => 'The GUID of the output table. Each asset has a unique identifier.', 'type' => 'string', 'example' => '2231'], + 'OutputTableName' => ['title' => '', 'description' => 'The name of the output table.', 'type' => 'string', 'example' => 't_output'], + 'OutputColumnName' => ['title' => '', 'description' => 'The name of the output column.', 'type' => 'string', 'example' => 'col2'], + 'OutputColumnGuid' => ['title' => '', 'description' => 'The GUID of the output column. Format: TableId.ColumnName.', 'type' => 'string', 'example' => '2231.col2'], + 'OutputProjectId' => ['title' => '', 'description' => 'The ID of the project to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1233'], + 'OutputBizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutputDataSourceId' => ['title' => '', 'description' => 'The ID of the data source to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutputDataSourceType' => ['title' => '', 'description' => 'The type of the data source to which the output table belongs.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the output table has been deleted.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], - 'required' => false, - ], - 'Comment' => [ - 'title' => '审核备注,最多128字符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query column-level data lineage of an asset table', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetTableColumns' => [ + 'summary' => 'Queries columns of a Dataphin table in the asset inventory. Supported table types: dimension logical table, fact logical table, aggregate logical table, tag logical table, logical table view, physical table, physical view, and materialized view.'."\n" + .'Release version: 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' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Catalog', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Asset table catalog: name of the business unit or project space.', 'type' => 'string', 'required' => true, 'example' => 'LD_test01_dev'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Table name.', 'type' => 'string', 'required' => true, 'example' => 't_test01'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend response exception details.', 'type' => 'string', 'example' => 'internal error'], + 'ColumnList' => [ + 'title' => '', + 'description' => 'List of asset table columns.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'Column GUID.', 'type' => 'string', 'example' => '1121.col1'], + 'Env' => ['title' => '', 'description' => 'Environment: dev or prod.', 'type' => 'string', 'example' => 'dev'], + 'TableGuid' => ['title' => '', 'description' => 'Table GUID.', 'type' => 'string', 'example' => '1121'], + 'DataSourceId' => ['title' => '', 'description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3301'], + 'DataSourceType' => ['title' => '', 'description' => 'Data source type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'TableName' => ['title' => '', 'description' => 'Table name.', 'type' => 'string', 'example' => 't_test'], + 'SeqNumber' => ['title' => '', 'description' => 'Sequence number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'Column name.', 'type' => 'string', 'example' => 'age'], + 'DisplayName' => ['title' => '', 'description' => 'Column display name.', 'type' => 'string', 'example' => '年龄'], + 'Comment' => ['title' => '', 'description' => 'Column comment.', 'type' => 'string', 'example' => 'test'], + 'DataType' => ['title' => '', 'description' => 'Data type.', 'type' => 'string', 'example' => 'varchar'], + 'Nullable' => ['title' => '', 'description' => 'Whether null values are allowed.', 'type' => 'boolean', 'example' => ''], + 'DefaultValue' => ['title' => '', 'description' => 'Default value.', 'type' => 'string', 'example' => 'test'], + 'IsPrimaryKey' => ['title' => '', 'description' => 'Whether this is a primary key.', 'type' => 'boolean', 'example' => ''], + 'IsForeignKey' => ['title' => '', 'description' => 'Whether this is a foreign key.', 'type' => 'boolean', 'example' => ''], + 'IsPartitionColumn' => ['title' => '', 'description' => 'Whether this is a partition column.', 'type' => 'boolean', 'example' => ''], + 'Creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '30012011'], + 'LastModifier' => ['title' => '', 'description' => 'Last modifier.', 'type' => 'string', 'example' => '30012011'], + 'VisitCount30d' => ['title' => '', 'description' => 'Query count in the last 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'Modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ClassifyId' => ['title' => '', 'description' => 'Data classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'ClassifyName' => ['title' => '', 'description' => 'Data classification name.', 'type' => 'string', 'example' => 'test'], + 'LevelAbbreviation' => ['title' => '', 'description' => 'Data level abbreviation.', 'type' => 'string', 'example' => 'L1'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"DefaultValue\\": \\"test\\",\\n \\"IsPrimaryKey\\": false,\\n \\"IsForeignKey\\": false,\\n \\"IsPartitionColumn\\": false,\\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' => 'Query columns of a Dataphin table in the asset inventory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListStandards' => [ - 'summary' => '分页查询标准列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetTableLineageByTaskId' => [ + 'summary' => 'Queries table lineage information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -31590,694 +22527,381 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'TableLineageByTaskIdQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'title' => '', + 'description' => 'The data structure for querying table lineage.', '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' => '', + 'TaskId' => ['title' => '', 'description' => 'The task (node) ID used to filter the query.', 'type' => 'string', 'required' => true, 'example' => 'n_123'], + 'TaskEnv' => ['title' => '', 'description' => 'The environment of the task to query: DEV or PROD.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'NeedNotExistObject' => ['title' => '', 'description' => 'Specifies whether to return tables that do not exist in the asset inventory. If this parameter is not specified, non-existent tables are not returned.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The query results.', 'type' => 'array', 'items' => [ - 'title' => '标准类型: Basic、EMPTY 标准类型为空', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EMPTY', + 'title' => '', + 'description' => 'The lineage details.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'TaskId' => ['title' => '', 'description' => 'The task (node) ID associated with the lineage.', 'type' => 'string', 'example' => 'n_123'], + 'TaskEnv' => ['title' => '', 'description' => 'The environment of the task (node) associated with the lineage: DEV or PROD.', 'type' => 'string', 'example' => 'DEV'], + 'InputEnv' => ['title' => '', 'description' => 'The environment of the input table: DEV or PROD.', 'type' => 'string', 'example' => 'DEV'], + 'InputTableId' => ['title' => '', 'description' => 'The GUID of the input table. Each asset has a unique GUID in the following format:'."\n" + ."\n" + .'- Logical table: dp_table.[TenantId].[BusinessUnitName].[TableName]'."\n" + .'- Compute source physical table: [EngineType].[TenantId].[ProjectName].[TableName]'."\n" + .'- Data source table: dp_ds_table.[TenantId].[DataSourceId].[SchemaName].[TableName]', 'type' => 'string', 'example' => 'odps.123.test_project.order'], + 'InputTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'example' => 'order'], + 'InputTableType' => ['title' => '', 'description' => 'The type of the input table. '."\n" + ."\n" + .'- PHYSICAL_TABLE Physical table (compute source)'."\n" + .'- DIM_LOGIC_TABLE Dimension logical table'."\n" + .'- FACT_LOGIC_TABLE Fact logical table'."\n" + .'- SUM_LOGIC_TABLE Aggregate logical table'."\n" + .'- REAL_TIME_LOGIC_TABLE Real-time meta table'."\n" + .'- REAL_TIME_MIRROR_TABLE Real-time mirror table'."\n" + .'- PHYSICAL_VIEW Physical view'."\n" + .'- LOGICAL_VIEW Logical view'."\n" + .'- DATA_SOURCE_PHYSICAL_TABLE Data source table'."\n" + .'- DATA_SOURCE_VIEW Data source view'."\n" + .'- DATA_SOURCE_MATERIALIZED_VIEW Data source materialized view', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'InputDataSourceType' => ['title' => '', 'description' => 'The storage type of the input table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputDbType' => ['title' => '', 'description' => 'The data source type of the input table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputProjectId' => ['title' => '', 'description' => 'The project ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputBizUnitId' => ['title' => '', 'description' => 'The business unit ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputDataSourceId' => ['title' => '', 'description' => 'The data source ID of the input table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'InputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the input table is deleted.', 'type' => 'boolean', 'example' => ''], + 'OutputTableType' => ['title' => '', 'description' => 'The type of the output table. For valid values, see InputTableType.', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'OutputEnv' => ['title' => '', 'description' => 'The environment of the output table: DEV or PROD.', 'type' => 'string', 'example' => 'DEV/PROD'], + 'OutputBizUnitId' => ['title' => '', 'description' => 'The business unit ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputDataSourceType' => ['title' => '', 'description' => 'The storage type of the output table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputDbType' => ['title' => '', 'description' => 'The data source type of the output table.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputProjectId' => ['title' => '', 'description' => 'The project ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputDataSourceId' => ['title' => '', 'description' => 'The data source ID of the output table.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'OutputTableId' => ['title' => '', 'description' => 'The GUID of the output table. Each asset has a unique GUID. For the format, see InputTableId.', 'type' => 'string', 'example' => 'odps.123.test_project.order'], + 'OutputTableName' => ['title' => '', 'description' => 'The name of the output table.', 'type' => 'string', 'example' => 'order'], + 'OutputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the output table is deleted.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], - 'required' => false, - ], - 'StandardStage' => [ - 'title' => '标准所属阶段：DEV、PROD', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEV', + 'example' => '', ], - 'StandardTemplateIdList' => [ - 'title' => '所属标准模板Id', - 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + '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\\": false,\\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\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Table Lineage Query', + 'extraInfo' => 'API release version: v5.1.0', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetTableLineages' => [ + 'summary' => 'Queries lineage information of an asset table.'."\n" + .'Release version: 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' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The GUID of the table, which is the unique identifier of each asset.', 'type' => 'string', 'required' => true, 'example' => '1121'], + ], + [ + 'name' => 'FilterQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The filter conditions.', + 'type' => 'object', + 'properties' => [ + 'NodeEnv' => ['title' => '', 'description' => 'The environment to which the task belongs. This parameter is used for filtering. Valid values: dev and prod.', 'type' => 'string', 'required' => false, 'example' => 'dev'], + 'NodeIdList' => [ + 'title' => '', + 'description' => 'The list of task IDs used for filtering.', 'type' => 'array', - 'items' => [ - 'title' => '所属标准模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'items' => ['title' => '', 'description' => 'The task ID used for filtering.', 'type' => 'string', 'required' => false, 'example' => '110021'], 'required' => false, + 'example' => '', ], - 'StandardSetIdList' => [ - 'title' => '所属标准集Id', - 'description' => '', + 'NeedUpstream' => ['title' => '', 'description' => 'Specifies whether to query upstream lineage. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'NeedDownstream' => ['title' => '', 'description' => 'Specifies whether to query downstream lineage. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'NeedNotExistObject' => ['title' => '', 'description' => 'Specifies whether to return tables that do not exist in the asset list. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'internal error'], + 'TableLineageList' => [ + 'title' => '', + 'description' => 'The table lineage list.', 'type' => 'array', 'items' => [ - 'title' => '所属标准集Id', + 'title' => '', 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'The task ID associated with the lineage.', 'type' => 'string', 'example' => '110021'], + 'NodeEnv' => ['title' => '', 'description' => 'The environment to which the task belongs. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'InputTableEnv' => ['title' => '', 'description' => 'The environment to which the input table belongs. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'InputTableGuid' => ['title' => '', 'description' => 'The GUID of the input table. Each asset has a unique identifier.', 'type' => 'string', 'example' => '123211'], + 'InputTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'example' => 't_input'], + 'InputProjectId' => ['title' => '', 'description' => 'The ID of the project to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1233'], + 'InputBizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InputDataSourceId' => ['title' => '', 'description' => 'The ID of the data source to which the input table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InputDataSourceType' => ['title' => '', 'description' => 'The type of the data source to which the input table belongs.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'InputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the input table has been deleted.', 'type' => 'boolean', 'example' => ''], + 'OutputTableEnv' => ['title' => '', 'description' => 'The environment to which the output table belongs. Valid values: dev and prod.', 'type' => 'string', 'example' => 'dev'], + 'OutputTableGuid' => ['title' => '', 'description' => 'The GUID of the output table. Each asset has a unique identifier.', 'type' => 'string', 'example' => '2231'], + 'OutputTableName' => ['title' => '', 'description' => 'The name of the output table.', 'type' => 'string', 'example' => 't_output'], + 'OutputProjectId' => ['title' => '', 'description' => 'The ID of the project to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1233'], + 'OutputBizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutputDataSourceId' => ['title' => '', 'description' => 'The ID of the data source to which the output table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutputDataSourceType' => ['title' => '', 'description' => 'The type of the data source to which the output table belongs.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'OutputTableDeleted' => ['title' => '', 'description' => 'Indicates whether the output table has been deleted.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], - 'required' => false, - ], - 'StandardStatusList' => [ - 'title' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '标准的状态列表, DEV Stage下的标准状态为: DRAFT(草稿态)/UNDER_REVISION(修订中)/UNDER_REVIEW(审批中)/REVIEW_PASSED(审批通过)/IN_PUBLISH(发布中); PROD Stage下的标准状态为: NOT_ACTIVATED(未生效)/ACTIVE(已生效)/EXPIRED(已停用)', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DRAFT', - ], - 'required' => false, - ], - 'UserId' => [ - 'title' => '用户Id: 只会查询该用户Id本身可见的标准,为空则查询当前用户可见的标准', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30012011', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query asset table lineage information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetTransferInfo' => [ + 'summary' => 'Queries the progress of a transfer task by transfer task 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProposalId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The transfer record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'description' => 'The query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', + 'ProposalId' => ['title' => '', 'description' => 'The approval ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FlowId' => ['title' => '', 'description' => 'The approval flow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753669315426'], + 'Title' => ['title' => '', 'description' => 'The approval title.', 'type' => 'string', 'example' => 'transefer title'], + 'Creator' => [ + 'title' => '', + 'description' => 'The creator.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30000001'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', ], - 'StandardList' => [ - 'title' => '表列表', - 'description' => '', + 'OldOwner' => [ + 'title' => '', + 'description' => 'The previous owner.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30000001'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'NewOwner' => [ + 'title' => '', + 'description' => 'The new owner.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30000001'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'PrivilegeTransferMode' => ['title' => '', 'description' => 'The transfer mode. Valid values:'."\n" + .'- ONE_STOP: one-click transfer.'."\n" + .'- FUNCTION_MODULE_BASED: transfer by function module.', 'type' => 'string', 'example' => 'ONE_STOP'], + 'TransferComment' => ['title' => '', 'description' => 'The transfer description.', 'type' => 'string', 'example' => 'comment'], + 'TransferStatus' => [ + 'title' => '', + 'description' => 'The transfer status.', + 'enumValueTitles' => ['REVOKED' => 'Forcibly revoked by the administrator.', 'SUCCESS' => 'The permission transfer succeeded.', 'FAILED' => 'The permission transfer failed due to a processing error.', 'APPROVING' => 'Pending approval.', 'CANCELED' => 'Canceled.', 'APPROVED' => 'Approved by the approver and being processed.', 'RETRY' => 'Retried.', 'REJECTED' => 'Rejected by the approver.'], + 'type' => 'string', + 'example' => 'APPROVED', + ], + 'LastModifier' => [ + 'title' => '', + 'description' => 'The last modifier.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '30000001'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'example' => '', + ], + 'PrivilegeTransferResultEntries' => [ + 'title' => '', + 'description' => 'The transfer details of function modules.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'Version' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'StandardSet' => [ - 'title' => '当前标准依赖的标准集', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '标准集Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', - 'description' => '', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Length' => [ - 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'NONE', - ], - 'ValueList' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - 'MinMaxValueConfig' => [ - 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Column' => [ - 'title' => '引用的码表字段', - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - ], - 'DataphinAttributeType' => [ - 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', - 'description' => '', - 'type' => 'string', - 'example' => 'DATAPHIN_ATTRIBUTE', - ], - ], - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'MonitorConfig' => [ - 'title' => '监控配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AttributeFromInfo' => [ - 'title' => '属性来源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeFrom' => [ - 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'StandardReference' => [ - 'title' => '对应的标准,属性来源为 STANDARD 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Version' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - 'Id' => [ - 'title' => '属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1011', - ], - ], - ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], + 'Status' => ['description' => 'The status of the transfer module.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'PrivilegeDisplayName' => ['description' => 'The name of the transfer module.', 'type' => 'string', 'example' => 'table owner', 'title' => ''], + 'ErrMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'userId is error', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '1632036495973809'], + 'GmtModified' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '1632036495973809'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query transfer task progress by transfer task ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetStandardWordRoot' => [ - 'summary' => '获取数据标准词根详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetUdf' => [ + 'summary' => 'Retrieves the details of a user-defined function.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -32286,181 +22910,92 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '词根名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '平均值', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], ], [ - 'name' => 'Nullable', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '词根不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The user-defined function ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'WordRootInfo' => [ - 'title' => '词根详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'UdfInfo' => [ + 'title' => '', + 'description' => 'The details of the user-defined function.', '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' => '', - 'type' => 'string', - 'example' => '30012021', - ], - 'CreatorName' => [ - 'title' => '创建人用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LastModifier' => [ - 'title' => '最近更新人用户ID', - 'description' => '', - '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', - ], + 'Id' => ['title' => '', 'description' => 'The user-defined function ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'Name' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'example' => 'udf_to_lower'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine. Valid values: HADOOP, MAX_COMPUTE, and FLINK.', 'type' => 'string', 'example' => 'HADOOP'], + 'Directory' => ['title' => '', 'description' => 'The directory where the function is stored.', 'type' => 'string', 'example' => '/'], + 'ClassName' => ['title' => '', 'description' => 'The registered class name.', 'type' => 'string', 'example' => 'com.lydaas.dataphin.UdfTest'], + 'Category' => ['title' => '', 'description' => 'The category. Valid values:'."\n" + .'- 1: window function.'."\n" + .'- 2: aggregate function.'."\n" + .'- 3: numeric function.'."\n" + .'- 4: string function.'."\n" + .'- 5: time function.'."\n" + .'- 6: IP address utility function.'."\n" + .'- 7: URL-related function.'."\n" + .'- 8: encoding and decoding function.'."\n" + .'- 9: business-related function.'."\n" + .'- 10: other.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CommandHelp' => ['title' => '', 'description' => 'The command help information.', 'type' => 'string', 'example' => 'udf_to_lower(char x)'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time, in the yyyy-MM-d HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'GmtModified' => ['title' => '', 'description' => 'The last modification time, in the yyyy-MM-d HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012110'], + 'LastModifier' => ['title' => '', 'description' => 'The last modifier.', 'type' => 'string', 'example' => '30012110'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Retrieve user-defined function details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetStandardTemplate' => [ - 'summary' => '获取数据标准模板详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetUdfByVersion' => [ + 'summary' => 'Queries the details of a specific version of a user-defined function.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -32469,594 +23004,284 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '标准模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the user-defined function.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123'], ], [ - 'name' => 'Nullable', + 'name' => 'VersionId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模板不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'UdfInfo' => [ + 'title' => '', + 'description' => 'The details of the user-defined function.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the user-defined function.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'Name' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'example' => 'udf_to_lower'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine. Valid values: HADOOP, MAX_COMPUTE, and FLINK.', 'type' => 'string', 'example' => 'HADOOP'], + 'Directory' => ['title' => '', 'description' => 'The directory where the function is stored.', 'type' => 'string', 'example' => '/'], + 'ClassName' => ['title' => '', 'description' => 'The registered class name.', 'type' => 'string', 'example' => 'com.lydaas.dataphin.UdfTest'], + 'Category' => ['title' => '', 'description' => 'The udf type. Valid values:'."\n" + .'- 1: window function.'."\n" + .'- 2: statistical function.'."\n" + .'- 3: numerical function.'."\n" + .'- 4: string function.'."\n" + .'- 5: time function.'."\n" + .'- 6: IP address utility function.'."\n" + .'- 7: URL-related function.'."\n" + .'- 8: encoding and decoding function.'."\n" + .'- 9: business-related function.'."\n" + .'- 10: other.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CommandHelp' => ['title' => '', 'description' => 'The command help.', 'type' => 'string', 'example' => 'udf_to_lower(char x)'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time, in the yyyy-MM-d HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'GmtModified' => ['title' => '', 'description' => 'The update time, in the yyyy-MM-d HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012110'], + 'LastModifier' => ['title' => '', 'description' => 'The last modifier.', 'type' => 'string', 'example' => '30012110'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query version details of a user-defined function', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetUserBySourceId' => [ + 'summary' => 'Retrieves user details by original user ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FilterQuery', - 'in' => 'formData', - 'style' => 'json', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The user source ID.', 'type' => 'string', 'required' => true, 'example' => '323131'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '过滤条件', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'Version' => [ - 'title' => '版本号, 空或-1表示最新版本', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'User' => [ + 'title' => '', + 'description' => 'The user object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '23231231'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the user.', 'type' => 'string', 'example' => 'xx测试'], + ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Retrieve user details by original user ID', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUserBySourceId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetUserGroup' => [ + 'summary' => 'Retrieves the details of a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => '1313213'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'TemplateInfo' => [ - 'title' => '模板详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'UserGroupInfo' => [ + 'title' => '', + 'description' => 'The user group details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '标准模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'TemplateFrom' => [ - 'title' => '标准模板来源: CUSTOM 自定义标准模板、SYSTEM 系统内置标准模板', - 'description' => '', - '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' => '', + 'Id' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '1313213'], + 'Name' => ['title' => '', 'description' => 'The name of the user group.', 'type' => 'string', 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'The description of the user group.', 'type' => 'string', 'example' => 'xx'], + 'Active' => ['title' => '', 'description' => 'Indicates whether the user group is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'AdminList' => [ + 'title' => '', + 'description' => 'The administrators of the user group.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', + 'description' => 'The administrators of the user group.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - 'LastModifier' => [ - 'title' => '最近修改人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', - 'description' => '', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Length' => [ - 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'NONE', - ], - 'ValueList' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - 'MinMaxValueConfig' => [ - 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Column' => [ - 'title' => '引用的码表字段', - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - ], - 'DataphinAttributeType' => [ - 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', - 'description' => '', - 'type' => 'string', - 'example' => 'DATAPHIN_ATTRIBUTE', - ], - ], - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'MonitorConfig' => [ - 'title' => '监控配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AttributeFromInfo' => [ - 'title' => '属性来源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeFrom' => [ - 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'StandardReference' => [ - 'title' => '对应的标准,属性来源为 STANDARD 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Version' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - 'Id' => [ - 'title' => '属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1011', - ], - ], - ], - ], - ], - ], - 'CodeRuleConfig' => [ - 'title' => '标准编码自动生成规则配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GenerateType' => [ - 'title' => '标准编码生成方式: CUSTOMIZED 自定义、AUTO_GENERATE 根据标准编码规则自动生成', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'AutoConfig' => [ - 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', - 'description' => '', - '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' => '', - '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', - ], - ], - ], - ], - ], - ], - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '131313'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], + 'AccountName' => ['title' => '', 'description' => 'The account name of the user.', 'type' => 'string', 'example' => 'xx'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'MyRole' => ['title' => '', 'description' => 'The role of the current user in the user group.', 'type' => 'string', 'example' => 'xx'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve user group details', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetStandardStatistics' => [ - 'summary' => '查询目录下按照标准类型统计标准数目。', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + ], + 'GetUsers' => [ + 'summary' => 'Retrieves user information in batches by user ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33064,582 +23289,461 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'StatisticsQuery', + 'name' => 'UserIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '统计查询指令', - 'description' => '', - 'type' => 'object', + 'title' => '', + 'description' => 'The list of user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '132313', 'title' => ''], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', 'properties' => [ - 'Directory' => [ - 'title' => '所属目录,会搜索包括该目录的所有子目录下的标准', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/dir1', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1233121'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the primary account to which the user belongs.', 'type' => 'string', 'example' => '231231'], + 'SourceType' => ['title' => '', 'description' => 'The source type of the user.', 'type' => 'string', 'example' => 'ALIYUN'], + 'SourceId' => ['title' => '', 'description' => 'The source ID of the user.', 'type' => 'string', 'example' => '123@xx.com'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the user.', 'type' => 'string', 'example' => 'xx测试'], + 'DisplayNameWithoutStatus' => ['title' => '', 'description' => 'The display name of the user without status.', 'type' => 'string', 'example' => 'xx测试'], + 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => '123@xx.com'], + 'RealName' => ['title' => '', 'description' => 'The real name of the user.', 'type' => 'string', 'example' => 'xx测试'], + 'NickName' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'xx测试'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'MobilePhone' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '1388888888'], + 'Mail' => ['title' => '', 'description' => 'The email address.', 'type' => 'string', 'example' => '123@xx.com'], + 'DingNumber' => ['title' => '', 'description' => 'The DingTalk number.', 'type' => 'string', 'example' => '123@dingding'], + 'WeChatRobot' => ['title' => '', 'description' => 'The WeCom chatbot.', 'type' => 'string', 'example' => 'xx'], + 'FeiShuRobot' => ['title' => '', 'description' => 'The Lark chatbot.', 'type' => 'string', 'example' => 'xx'], + 'EnableWhiteIp' => ['title' => '', 'description' => 'Indicates whether the IP whitelist is enabled.', 'type' => 'string', 'example' => 'true'], + 'WhiteIp' => ['title' => '', 'description' => 'The IP whitelist.', 'type' => 'string', 'example' => '*'], + 'GmtModified' => ['description' => 'The last modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', ], - 'StandardStageList' => [ - 'title' => '标准所属stage', - 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Retrieve user details by user ID', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GrantDataServiceApi' => [ + 'summary' => 'Grants API authorization.', + '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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'GrantCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The grant command.', + 'type' => 'object', + 'properties' => [ + 'ExpireDate' => ['title' => '', 'description' => 'The expiration date in the format of yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30'], + 'Reason' => ['title' => '', 'description' => 'The reason for the authorization request.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'ApiId' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021'], + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1201'], + 'ProdFieldList' => [ + 'title' => '', + 'description' => 'The list of production environment permission fields for query-type APIs. This parameter is required in basic mode. This parameter is not required for operation-type APIs.', 'type' => 'array', 'items' => [ - 'title' => '标准所属stage', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The API permission field ID.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The API permission field ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], 'required' => false, - 'example' => 'dev', + 'example' => '', ], 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'boolean', - 'required' => false, + 'DevFieldList' => [ + 'title' => '', + 'description' => 'The list of development environment permission fields for query-type APIs. This parameter is required in dev-prod mode. DevFieldList and ProdFieldList cannot both be empty. This parameter is not required for operation-type APIs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The API permission field ID.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The API permission field ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], + 'required' => false, + 'example' => '', ], 'required' => false, + 'example' => '', + ], + 'ApplyDev' => ['title' => '', 'description' => 'Specifies whether to request development environment permissions for operation-type APIs.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ApplyProd' => ['title' => '', 'description' => 'Specifies whether to request production environment permissions for operation-type APIs.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AuthTypes' => [ + 'title' => '', + 'description' => 'The list of authorization permission types. Valid values:'."\n" + .'- When the grantee is an application, the following permission types are supported. To grant delegation permissions, you must also grant usage permissions.'."\n" + .' - USE: usage permission.'."\n" + .' - DELEGATION: delegation permission.'."\n" + .'- When the grantee is an individual, only USE (usage) permission is supported.'."\n" + .'- If this parameter is not specified, the default value is USE (usage) permission.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The authorization permission type.', 'type' => 'string', 'example' => 'USE', 'default' => 'USE', 'required' => false], + 'required' => false, + 'example' => '', ], + 'GranteeType' => ['title' => '', 'description' => 'The authorization object type. Valid values:'."\n" + .'- APP: application.'."\n" + .'- USER: user.', 'type' => 'string', 'example' => 'APP', 'default' => 'APP', 'required' => false], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345', 'required' => false], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'GetStandardSet' => [ - 'summary' => '获取标准集详情。', - 'methods' => [ - 'post', + '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' => 'Grant data service API authorization', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-30T01:49:47.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + 'ramActions' => [], + ], + 'GrantResourcePermission' => [ + 'summary' => 'Grants permissions on resources to users by resource point.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'GrantCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The grant request.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '', + 'description' => 'The resource type.', + 'type' => 'string', + 'required' => true, + 'example' => 'PHYSICAL_TABLE', + 'enum' => [], + ], + 'OperateList' => [ + 'title' => '', + 'description' => 'The operation types.', + 'type' => 'array', + 'items' => ['description' => 'The operation types.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + 'required' => true, + 'example' => '', + ], + 'Reason' => ['title' => '', 'description' => 'The reason for the authorization.', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'ResourceList' => [ + 'title' => '', + 'description' => 'The list of resources.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The resource object.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'hadoop.300000806.data_distill.behavior_gameinfor_01'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'EffectiveEnd' => ['title' => '', 'description' => 'The expiration timestamp, in milliseconds.', 'type' => 'string', 'required' => true, 'example' => '1717343597000'], + 'UserIdList' => [ + 'title' => '', + 'description' => 'The authorized users pending authorization.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The authorized user pending authorization.', 'type' => 'string', 'required' => false, 'example' => '23244434'], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', ], ], - [ - 'name' => 'Id', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '标准集Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Grant resource permissions to users', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Nullable', - 'in' => 'query', - 'schema' => [ - 'title' => '标准集不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:GrantResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'ListAddableRoles' => [ + 'summary' => 'Retrieves the global roles that can be assigned to tenant members. Only built-in global roles are supported. Custom global roles are not supported.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'Name' => [ - 'title' => '用户组名', - 'description' => '', - 'type' => 'string', - 'example' => 'testGroup', - ], - ], - ], - ], - 'VisibilityConfig' => [ - 'title' => '可见性配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '可见类型: PUBLIC 公开、PRIVATE 私有,仅标准集人员/管理员、SPECIFIED 指定人可见', - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'SpecifiedUserList' => [ - 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - ], - ], - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - 'LastModifier' => [ - 'title' => '最近修改人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'BY_DEFAULT', - ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'BY_DEFAULT', - ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - ], - ], - 'DefaultStandardTemplateId' => [ - 'title' => '默认标准模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'RoleList' => [ + 'title' => '', + 'description' => 'The list of roles.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The role.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The role code.', 'type' => 'string', 'example' => 'SECURITY_ADMIN'], + 'Name' => ['title' => '', 'description' => 'The role name.', 'type' => 'string', 'example' => '安全管理员'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve configurable global roles for users', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetStandardLookupTable' => [ - 'summary' => '获取数据标准码表详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAddableRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListAddableUsers' => [ + 'summary' => 'Queries users that can be added to a tenant. Only the super administrator (SuperAdmin) and system administrator can call this operation. The users must already exist in the Dataphin instance member list but have not yet been added to the tenant member list.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33647,245 +23751,128 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], + 'SearchText' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'example' => 'xx', 'required' => false], + ], 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Nullable', - 'in' => 'query', - 'schema' => [ - 'title' => '码表不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response object.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'LookupTableInfo' => [ - 'title' => '码表详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '码表Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012021', - ], - 'CreatorName' => [ - 'title' => '创建人用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LastModifier' => [ - 'title' => '最近更新人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012021', - ], - 'LastModifierName' => [ - 'title' => '最近更新人用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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', - ], - ], + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123231'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the parent Alibaba Cloud account to which the user belongs.', 'type' => 'string', 'example' => '231313'], + 'SourceType' => ['title' => '', 'description' => 'The source type of the user.', 'type' => 'string', 'example' => 'aliyun'], + 'SourceId' => ['title' => '', 'description' => 'The source ID of the user.', 'type' => 'string', 'example' => '123@xx.com'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the user.', 'type' => 'string', 'example' => 'xx'], + 'DisplayNameWithoutStatus' => ['title' => '', 'description' => 'The display name of the user without the status.', 'type' => 'string', 'example' => 'xx'], + 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => '123@xx.com'], + 'RealName' => ['title' => '', 'description' => 'The real name of the user.', 'type' => 'string', 'example' => 'xx'], + 'NickName' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'xx'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the user was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000'], + 'MobilePhone' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '13888888888'], + 'Mail' => ['title' => '', 'description' => 'The email address.', 'type' => 'string', 'example' => '123@xx.com'], + 'DingNumber' => ['title' => '', 'description' => 'The DingTalk ID.', 'type' => 'string', 'example' => '123@dingding'], + 'WeChatRobot' => ['title' => '', 'description' => 'The WeCom chatbot.', 'type' => 'string', 'example' => 'xx'], + 'FeiShuRobot' => ['title' => '', 'description' => 'The Lark chatbot.', 'type' => 'string', 'example' => 'xx'], + 'EnableWhiteIp' => ['title' => '', 'description' => 'Indicates whether the IP whitelist is enabled.', 'type' => 'string', 'example' => 'true'], + 'WhiteIp' => ['title' => '', 'description' => 'The IP whitelist.', 'type' => 'string', 'example' => '*'], + 'GmtModified' => ['description' => 'The time when the user was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717343597000', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query users available for tenant addition', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetStandard' => [ - 'summary' => '获取标准详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAddableUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListAlertEvents' => [ + 'summary' => 'Performs a conditional query to list multiple alerting events.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33893,4215 +23880,3465 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'StandardGetQuery', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询指令', - 'description' => '', + 'title' => '', + 'description' => 'The query request.', 'type' => 'object', 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', + 'UserIdList' => [ + 'title' => '', + 'description' => 'The list of alert contact IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert contact ID.', 'type' => 'string', 'required' => false, 'example' => '12345'], + 'required' => false, + 'example' => '', ], - 'Nullable' => [ - 'title' => '标准不存在时是否允许返回空值, 如果为false则会抛出异常，默认：true', - 'description' => '', - 'type' => 'boolean', + 'AlertStartTime' => ['title' => '', 'description' => 'The start date of the alert.', 'type' => 'string', 'required' => true, 'example' => '2024-11-16 00:00:00'], + 'AlertEndTime' => ['title' => '', 'description' => 'The end date of the alert.', 'type' => 'string', 'required' => true, 'example' => '2024-11-27 13:47:00'], + 'StatusList' => [ + 'title' => '', + 'description' => 'The list of alert statuses.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert status. Valid values:'."\n" + .'- ALERTING: alerting'."\n" + .'- DO_NOT_DISTURB: do not disturb'."\n" + .'- SILENCING: alerting (cool-down period)'."\n" + .'- FINISH: completed.', 'type' => 'string', 'required' => false, 'example' => 'FINISH'], 'required' => false, + 'example' => '', ], - 'Version' => [ - 'title' => '版本号, 为空表示最新版本', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'ProjectNameList' => [ + 'title' => '', + 'description' => 'The list of projects.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => false, 'example' => 'project_1'], 'required' => false, - 'example' => '1', + 'example' => '', ], - 'StandardStage' => [ - 'title' => '所属阶段：dev、prod, 默认：prod', - 'description' => '', - 'type' => 'string', + 'BizNameList' => [ + 'title' => '', + 'description' => 'The list of business units.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'required' => false, 'example' => 'biz_1'], 'required' => false, - 'example' => 'dev', + 'example' => '', ], - 'NeedRelation' => [ - 'title' => '是否需要返回关联标准和关联码表, 默认：false', - 'description' => '', - 'type' => 'boolean', + 'AlertObjectTypeList' => [ + 'title' => '', + 'description' => 'The list of alert object types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert object type. Valid values:'."\n" + .'- OS_API: API operation'."\n" + .'- OS_APPLICATION_SERVICE: service application'."\n" + .'- STREAM_TASK: real-time computing'."\n" + .'- REAL_TIME_PIPELINE_TASK: real-time integration'."\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: logical table'."\n" + .'- DQE_PHYSICAL_TABLE: physical table'."\n" + .'- DQE_REALTIME_TABLE: real-time metadata table'."\n" + .'- DQE_DATA_SOURCE: data source'."\n" + .'- DQE_INDEX: metric'."\n" + .'- QD_DECISION_INVOKE: QD decision invocation'."\n" + .'- BASELINE: baseline'."\n" + ."\n" + .'and more.', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_PYTHON37'], + 'required' => false, + 'example' => '', + ], + 'AlertReasonList' => [ + 'title' => '', + 'description' => 'The list of alert reasons.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert reason type. Valid values:'."\n" + .'- DQE_COLUMN: field rule exception'."\n" + .'- DQE_DATA_SOURCE: data source rule exception'."\n" + .'- DQE_CUSTOMIZE: custom rule exception'."\n" + .'- DQE_TABLE: table rule exception'."\n" + .'- DQE_REALTIME_TABLE: real-time table rule exception'."\n" + .'- DQE_INDEX: metric rule exception'."\n" + .'- OS_AVG_RESPONSE: average response time exception'."\n" + .'- OS_CALL_TIMES: call count exception'."\n" + .'- OS_ERROR_RATE: error rate exception'."\n" + .'- OS_OFFLINE: Offline percentage exception'."\n" + .'- STREAM_BIZ_DELAY: business delay too high'."\n" + .'- STREAM_DATA_RETENTION: data retention exceeds configuration'."\n" + .'- STREAM_MORE_THAN_FAILURE: failure frequency exceeds configuration'."\n" + .'- STREAM_TPS_OUT_RANGE: TPS out of range'."\n" + .'- STREAM_CHECKPOINT_FAILURE: checkpoint failures exceed configuration'."\n" + .'- STREAM_BACKPRESSURE: backpressure duration exceeds configuration'."\n" + .'- STREAM_JOB_FAILURE: job failure'."\n" + .'- VDM_BATCH_ERROR: error'."\n" + .'- VDM_BATCH_FINISH: completed'."\n" + .'- VDM_BATCH_TIME_OUT: execution timeout'."\n" + .'- VDM_BATCH_UNDONE: incomplete'."\n" + .'- VDM_BATCH_LOGIC_DATA_DELAY: data delay'."\n" + .'- QD_DECISION_CALL_TIMES: decision call count exception'."\n" + .'- QD_DECISION_MAX_RESPONSE: maximum response time exception'."\n" + .'- QD_DECISION_ERROR_RATE: error rate exception'."\n" + .'- QD_DECISION_PARAM_COUNT: decision parameter count exception'."\n" + .'- QD_DECISION_PARAM_PERCENTAGE: decision parameter percentage exception'."\n" + .'- QD_DECISION_PARAM_SUM: decision parameter sum exception'."\n" + .'- QD_DECISION_PARAM_AVG: decision parameter average exception'."\n" + .'- LOGICAL_INSTANCE_GENERATION: logical instance generation monitoring'."\n" + .'- KGB_TASK_ERROR: baseline task error'."\n" + .'- KGB_TASK_SLOW_DOWN: baseline task slowdown'."\n" + .'- KGB_EARLY_WARNING: baseline early warning'."\n" + .'- KGB_BROKEN_LINE: baseline breach'."\n" + ."\n" + .'and more.', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_FINISH'], + 'required' => false, + 'example' => '', + ], + 'SourceSystem' => ['title' => '', 'description' => 'The source system. Valid values:'."\n" + ."\n" + .'- ALL: all'."\n" + .'- DQE: data quality'."\n" + .'- OS: data service'."\n" + .'- STREAM: real-time computing'."\n" + .'- VDM_BATCH: offline computing'."\n" + .'- SOP: O&M platform'."\n" + .'- REAL_TIME_PIPELINE: real-time integration'."\n" + .'- KGB: baseline monitoring'."\n" + ."\n" + .'and more.', 'type' => 'string', 'required' => true, 'example' => 'ALL'], + 'MonitoredItemIdList' => [ + 'title' => '', + 'description' => 'The list of monitored item IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The monitored item ID.', 'type' => 'string', 'required' => false, 'example' => '12345'], 'required' => false, + 'example' => '', ], + 'Keyword' => ['title' => '', 'description' => 'The keyword for the query.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'StandardInfo' => [ - 'title' => '标准详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ListResult' => [ + 'title' => '', + 'description' => 'The query result.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'Version' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Data' => [ + 'title' => '', + 'description' => 'The alert event query results.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The alert event information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The alert event ID.', 'type' => 'string', 'example' => '12345'], + 'AlertObject' => [ + 'title' => '', + 'description' => 'The alert object.', + 'type' => 'object', + 'properties' => [ + 'SourceSystemType' => ['title' => '', 'description' => 'The source system. Valid values:'."\n" + ."\n" + .'- ALL: all'."\n" + .'- DQE: data quality'."\n" + .'- OS: data service'."\n" + .'- STREAM: real-time computing'."\n" + .'- VDM_BATCH: offline computing'."\n" + .'- SOP: O&M platform'."\n" + .'- REAL_TIME_PIPELINE: real-time integration'."\n" + .'- KGB: baseline monitoring'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'VDM_BATCH'], + 'Name' => ['title' => '', 'description' => 'The name of the alert object.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The alert object type. Valid values:'."\n" + .'- OS_API: API operation'."\n" + .'- OS_APPLICATION_SERVICE: service application'."\n" + .'- STREAM_TASK: real-time computing'."\n" + .'- REAL_TIME_PIPELINE_TASK: real-time integration'."\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: logical table'."\n" + .'- DQE_PHYSICAL_TABLE: physical table'."\n" + .'- DQE_REALTIME_TABLE: real-time metadata table'."\n" + .'- DQE_DATA_SOURCE: data source'."\n" + .'- DQE_INDEX: metric'."\n" + .'- QD_DECISION_INVOKE: QD decision invocation'."\n" + .'- BASELINE: baseline'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'STREAM_TASK'], + ], + 'example' => '', + ], + 'LatestAlertTime' => ['title' => '', 'description' => 'The time of the latest alert.', 'type' => 'string', 'example' => '2024-11-25 10:02:47'], + 'FirstAlertTime' => ['title' => '', 'description' => 'The time of the first alert.', 'type' => 'string', 'example' => '2024-11-25 10:02:47'], + 'AlertReceiverList' => [ + 'title' => '', + 'description' => 'The list of alert receivers.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The alert receiver.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the alert receiver. Valid values:'."\n" + .'- ON_CALL_TABLE: on-call schedule'."\n" + .'- USER_DEFINED: custom user'."\n" + .'- OWNER: owner.', 'type' => 'string', 'example' => 'OWNER'], + 'AlertChannelTypeList' => [ + 'title' => '', + 'description' => 'The list of alert channel types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert channel type. Valid values:'."\n" + .'- VOICE: phone call'."\n" + .'- SMS: text message'."\n" + .'- MAIL: email'."\n" + .'- DINGTALK_ROBOT: DingTalk chatbot'."\n" + .'- DINGDING: DingTalk work notification'."\n" + .'- CUSTOM: custom message channel'."\n" + .'- WECHAT: WeCom'."\n" + .'- FEISHU: Lark'."\n" + .'- SILENCE: do not send.', 'type' => 'string', 'example' => 'SMS'], + 'example' => '', + ], + 'CustomAlertChannelIdList' => [ + 'title' => '', + 'description' => 'The list of custom alert channel IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The custom alert channel ID.', 'type' => 'string', 'example' => '12345'], + 'example' => '', + ], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of alert users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'ADMIN'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'OnCallTableName' => ['title' => '', 'description' => 'The name of the on-call schedule.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AlertReason' => [ + 'title' => '', + 'description' => 'The alert reason.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The alert reason type. Valid values:'."\n" + .'- DQE_COLUMN: field rule exception'."\n" + .'- DQE_DATA_SOURCE: data source rule exception'."\n" + .'- DQE_CUSTOMIZE: custom rule exception'."\n" + .'- DQE_TABLE: table rule exception'."\n" + .'- DQE_REALTIME_TABLE: real-time table rule exception'."\n" + .'- DQE_INDEX: metric rule exception'."\n" + .'- OS_AVG_RESPONSE: average response time exception'."\n" + .'- OS_CALL_TIMES: call count exception'."\n" + .'- OS_ERROR_RATE: error rate exception'."\n" + .'- OS_OFFLINE: Offline percentage exception'."\n" + .'- STREAM_BIZ_DELAY: business delay too high'."\n" + .'- STREAM_DATA_RETENTION: data retention exceeds configuration'."\n" + .'- STREAM_MORE_THAN_FAILURE: failure frequency exceeds configuration'."\n" + .'- STREAM_TPS_OUT_RANGE: TPS out of range'."\n" + .'- STREAM_CHECKPOINT_FAILURE: checkpoint failures exceed configuration'."\n" + .'- STREAM_BACKPRESSURE: backpressure duration exceeds configuration'."\n" + .'- STREAM_JOB_FAILURE: job failure'."\n" + .'- VDM_BATCH_ERROR: error'."\n" + .'- VDM_BATCH_FINISH: completed'."\n" + .'- VDM_BATCH_TIME_OUT: execution timeout'."\n" + .'- VDM_BATCH_UNDONE: incomplete'."\n" + .'- VDM_BATCH_LOGIC_DATA_DELAY: data delay'."\n" + .'- QD_DECISION_CALL_TIMES: decision call count exception'."\n" + .'- QD_DECISION_MAX_RESPONSE: maximum response time exception'."\n" + .'- QD_DECISION_ERROR_RATE: error rate exception'."\n" + .'- QD_DECISION_PARAM_COUNT: decision parameter count exception'."\n" + .'- QD_DECISION_PARAM_PERCENTAGE: decision parameter percentage exception'."\n" + .'- QD_DECISION_PARAM_SUM: decision parameter sum exception'."\n" + .'- QD_DECISION_PARAM_AVG: decision parameter average exception'."\n" + .'- LOGICAL_INSTANCE_GENERATION: logical instance generation monitoring'."\n" + .'- KGB_TASK_ERROR: baseline task error'."\n" + .'- KGB_TASK_SLOW_DOWN: baseline task slowdown'."\n" + .'- KGB_EARLY_WARNING: baseline early warning'."\n" + .'- KGB_BROKEN_LINE: baseline breach'."\n" + ."\n" + .'and more.', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2024-11-25 10:02:47'], + 'UniqueKey' => ['title' => '', 'description' => 'The unique identifier.', 'type' => 'string', 'example' => 't_6340134343289405440_20241124_639873707610'], + 'AlertReasonParamList' => [ + 'title' => '', + 'description' => 'The list of alert reason parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The alert reason parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The name of the alert reason parameter.', 'type' => 'string', 'example' => 'biz_date'], + 'Value' => ['title' => '', 'description' => 'The value of the alert reason parameter.', 'type' => 'string', 'example' => '2024-11-24 00:00:00'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'BelongProject' => [ + 'title' => '', + 'description' => 'The project to which the alert belongs.', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'project_1'], + 'BizName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'biz_1'], + ], + 'example' => '', + ], + 'Status' => ['title' => '', 'description' => 'The alert status. Valid values:'."\n" + .'- ALERTING: alerting'."\n" + .'- DO_NOT_DISTURB: do not disturb'."\n" + .'- SILENCING: alerting (cool-down period)'."\n" + .'- FINISH: completed.', 'type' => 'string', 'example' => 'FINISH'], + 'AlertFrequency' => ['title' => '', 'description' => 'The alert frequency. Valid values:'."\n" + .'- ONCE: instant alert'."\n" + .'- PERIOD: periodic alert. Format: 1HOUR, 1MINUTE, 1SECOND.', 'type' => 'string', 'example' => 'ONCE'], + 'TotalAlertTimes' => ['title' => '', 'description' => 'The total number of alert occurrences.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DoNotDisturbEndTime' => ['title' => '', 'description' => 'The expiration time of the do-not-disturb period.', 'type' => 'string', 'example' => '2024-11-25 00:00:00'], + 'UrlConfig' => [ + 'title' => '', + 'description' => 'The URL information.', + 'type' => 'object', + 'properties' => [ + 'ObjectUrl' => ['title' => '', 'description' => 'The URL of the alert object page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test1'], + 'LogUrl' => ['title' => '', 'description' => 'The URL of the log page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test2'], + 'AlertConfigUrl' => ['title' => '', 'description' => 'The URL of the alert configuration page.', 'type' => 'string', 'example' => 'https://dataphin.com/ops/test3'], + ], + 'example' => '', + ], ], + 'example' => '', ], + 'example' => '', ], - 'StandardSet' => [ - 'title' => '当前标准依赖的标准集', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '标准集Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => '300000913', - ], - 'Name' => [ - 'title' => '用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'susan', - ], - ], - ], - 'AttributeWithValueList' => [ - 'title' => '属性值配置', - 'description' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Query alert events', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:32:13.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAlertEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListAlertNotifications' => [ + 'summary' => 'Performs a conditional query to list multiple push records.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The query conditions.', + 'type' => 'object', + 'properties' => [ + 'UserIdList' => [ + 'title' => '', + 'description' => 'The list of push recipient IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The push recipient ID.', 'type' => 'string', 'required' => false, 'example' => '12345'], + 'required' => false, + 'example' => '', + ], + 'NotifyStartTime' => ['title' => '', 'description' => 'The start time of the push.', 'type' => 'string', 'required' => true, 'example' => '2024-11-16 00:00:00'], + 'NotifyEndTime' => ['title' => '', 'description' => 'The end time of the push.', 'type' => 'string', 'required' => true, 'example' => '2024-11-27 13:47:00'], + 'ChannelTypeList' => [ + 'title' => '', + 'description' => 'The list of push channel types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The push channel type. Valid values:'."\n" + .'- VOICE: phone call.'."\n" + .'- SMS: text message.'."\n" + .'- MAIL: email.'."\n" + .'- DINGTALK_ROBOT: DingTalk robot.'."\n" + .'- DINGDING: DingTalk work notification.'."\n" + .'- CUSTOM: custom message channel.'."\n" + .'- WECHAT: WeCom.'."\n" + .'- FEISHU: Lark.'."\n" + .'- SILENCE: do not send.', 'type' => 'string', 'required' => false, 'example' => 'SMS'], + 'required' => false, + 'example' => '', + ], + 'CustomChannelIdList' => [ + 'title' => '', + 'description' => 'The list of custom message channel IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The custom message channel ID.', 'type' => 'string', 'required' => false, 'example' => '12345'], + 'required' => false, + 'example' => '', + ], + 'StatusList' => [ + 'title' => '', + 'description' => 'The list of push statuses.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The push status. Valid values:'."\n" + .'- SUCCESS: Sent successfully.'."\n" + .'- FAILED: Failed to send.'."\n" + .'- SENDING: Sending in progress.', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'], + 'required' => false, + 'example' => '', + ], + 'AlertReasonList' => [ + 'title' => '', + 'description' => 'The list of alert reasons.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert reason type. Valid values:'."\n" + .'- DQE_COLUMN: field rule exception.'."\n" + .'- DQE_DATA_SOURCE: data source rule exception.'."\n" + .'- DQE_CUSTOMIZE: custom rule exception.'."\n" + .'- DQE_TABLE: table rule exception.'."\n" + .'- DQE_REALTIME_TABLE: real-time table rule exception.'."\n" + .'- DQE_INDEX: metric rule exception.'."\n" + .'- OS_AVG_RESPONSE: average response time exception.'."\n" + .'- OS_CALL_TIMES: call count exception.'."\n" + .'- OS_ERROR_RATE: error rate exception.'."\n" + .'- OS_OFFLINE: Offline percentage exception.'."\n" + .'- STREAM_BIZ_DELAY: business delay too high.'."\n" + .'- STREAM_DATA_RETENTION: data retention exceeds configuration.'."\n" + .'- STREAM_MORE_THAN_FAILURE: failure frequency exceeds configuration.'."\n" + .'- STREAM_TPS_OUT_RANGE: TPS out of range.'."\n" + .'- STREAM_CHECKPOINT_FAILURE: checkpoint failures exceed configuration.'."\n" + .'- STREAM_BACKPRESSURE: backpressure duration exceeds configuration.'."\n" + .'- STREAM_JOB_FAILURE: job execution failed.'."\n" + .'- VDM_BATCH_ERROR: error.'."\n" + .'- VDM_BATCH_FINISH: completed.'."\n" + .'- VDM_BATCH_TIME_OUT: execution timed out.'."\n" + .'- VDM_BATCH_UNDONE: not completed.'."\n" + .'- VDM_BATCH_LOGIC_DATA_DELAY: data delay.'."\n" + .'- QD_DECISION_CALL_TIMES: decision call count exception.'."\n" + .'- QD_DECISION_MAX_RESPONSE: maximum response time exception.'."\n" + .'- QD_DECISION_ERROR_RATE: error rate exception.'."\n" + .'- QD_DECISION_PARAM_COUNT: decision parameter count exception.'."\n" + .'- QD_DECISION_PARAM_PERCENTAGE: decision parameter percentage exception.'."\n" + .'- QD_DECISION_PARAM_SUM: decision parameter sum exception.'."\n" + .'- QD_DECISION_PARAM_AVG: decision parameter average exception.'."\n" + .'- LOGICAL_INSTANCE_GENERATION: logical instance generation monitoring.'."\n" + .'- KGB_TASK_ERROR: baseline task error.'."\n" + .'- KGB_TASK_SLOW_DOWN: baseline task slowdown.'."\n" + .'- KGB_EARLY_WARNING: baseline early warning.'."\n" + .'- KGB_BROKEN_LINE: baseline broken line.'."\n" + ."\n" + .'And more.', 'type' => 'string', 'required' => false, 'example' => 'VDM_BATCH_FINISH'], + 'required' => false, + 'example' => '', + ], + 'SourceSystem' => ['title' => '', 'description' => 'The source system. Valid values:'."\n" + ."\n" + .'- ALL: all.'."\n" + .'- DQE: data quality.'."\n" + .'- OS: data service.'."\n" + .'- STREAM: real-time computing.'."\n" + .'- VDM_BATCH: offline computing.'."\n" + .'- SOP: O&M platform.'."\n" + .'- REAL_TIME_PIPELINE: real-time integration.'."\n" + .'- KGB: baseline monitoring.'."\n" + ."\n" + .'And more.', 'type' => 'string', 'required' => true, 'example' => 'ALL'], + 'MonitoredItemIdList' => [ + 'title' => '', + 'description' => 'The list of monitored item IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The monitored item ID.', 'type' => 'string', 'required' => false, 'example' => '12345'], + 'required' => false, + 'example' => '', + ], + 'Keyword' => ['title' => '', 'description' => 'The keyword for the query.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ListResult' => [ + 'title' => '', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Data' => [ + 'title' => '', + 'description' => 'The list of push records.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => '', + 'description' => 'The push record information.', 'type' => 'object', 'properties' => [ - 'Attribute' => [ - 'title' => '属性详情', - 'description' => '', + 'AlertEventId' => ['title' => '', 'description' => 'The alert event ID.', 'type' => 'string', 'example' => '12345'], + 'AlertObject' => [ + 'title' => '', + 'description' => 'The alert object.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', - 'description' => '', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Length' => [ - 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'NONE', - ], - 'ValueList' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - 'MinMaxValueConfig' => [ - 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Column' => [ - 'title' => '引用的码表字段', - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - ], - 'DataphinAttributeType' => [ - 'title' => '取值范围,当取值来源取值为 DATAPHIN_ATTRIBUTE 生效：BIZ_UNIT 数据板块、PROJECT 项目、USER 用户、USER_GROUP 用户组', - 'description' => '', - 'type' => 'string', - 'example' => 'DATAPHIN_ATTRIBUTE', - ], - ], - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'SourceSystemType' => ['title' => '', 'description' => 'The source system. Valid values:'."\n" + ."\n" + .'- ALL: all.'."\n" + .'- DQE: data quality.'."\n" + .'- OS: data service.'."\n" + .'- STREAM: real-time computing.'."\n" + .'- VDM_BATCH: offline computing.'."\n" + .'- SOP: O&M platform.'."\n" + .'- REAL_TIME_PIPELINE: real-time integration.'."\n" + .'- KGB: baseline monitoring.'."\n" + ."\n" + .'And more.', 'type' => 'string', 'example' => 'VDM_BATCH'], + 'Name' => ['title' => '', 'description' => 'The object name.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The alert object type. Valid values:'."\n" + .'- OS_API: API operation.'."\n" + .'- OS_APPLICATION_SERVICE: service application.'."\n" + .'- STREAM_TASK: real-time computing.'."\n" + .'- REAL_TIME_PIPELINE_TASK: real-time integration.'."\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: logical table.'."\n" + .'- DQE_PHYSICAL_TABLE: physical table.'."\n" + .'- DQE_REALTIME_TABLE: real-time meta table.'."\n" + .'- DQE_DATA_SOURCE: data source.'."\n" + .'- DQE_INDEX: metric.'."\n" + .'- QD_DECISION_INVOKE: QD decision invocation.'."\n" + .'- BASELINE: baseline.'."\n" + ."\n" + .'And more.', 'type' => 'string', 'example' => 'VDM_BATCH_SHELL'], + ], + 'example' => '', + ], + 'AlertReason' => [ + 'title' => '', + 'description' => 'The alert reason.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The alert reason type. Valid values:'."\n" + .'- DQE_COLUMN: field rule exception.'."\n" + .'- DQE_DATA_SOURCE: data source rule exception.'."\n" + .'- DQE_CUSTOMIZE: custom rule exception.'."\n" + .'- DQE_TABLE: table rule exception.'."\n" + .'- DQE_REALTIME_TABLE: real-time table rule exception.'."\n" + .'- DQE_INDEX: metric rule exception.'."\n" + .'- OS_AVG_RESPONSE: average response time exception.'."\n" + .'- OS_CALL_TIMES: call count exception.'."\n" + .'- OS_ERROR_RATE: error rate exception.'."\n" + .'- OS_OFFLINE: Offline percentage exception.'."\n" + .'- STREAM_BIZ_DELAY: business delay too high.'."\n" + .'- STREAM_DATA_RETENTION: data retention exceeds configuration.'."\n" + .'- STREAM_MORE_THAN_FAILURE: failure frequency exceeds configuration.'."\n" + .'- STREAM_TPS_OUT_RANGE: TPS out of range.'."\n" + .'- STREAM_CHECKPOINT_FAILURE: checkpoint failures exceed configuration.'."\n" + .'- STREAM_BACKPRESSURE: backpressure duration exceeds configuration.'."\n" + .'- STREAM_JOB_FAILURE: job execution failed.'."\n" + .'- VDM_BATCH_ERROR: error.'."\n" + .'- VDM_BATCH_FINISH: completed.'."\n" + .'- VDM_BATCH_TIME_OUT: execution timed out.'."\n" + .'- VDM_BATCH_UNDONE: not completed.'."\n" + .'- VDM_BATCH_LOGIC_DATA_DELAY: data delay.'."\n" + .'- QD_DECISION_CALL_TIMES: decision call count exception.'."\n" + .'- QD_DECISION_MAX_RESPONSE: maximum response time exception.'."\n" + .'- QD_DECISION_ERROR_RATE: error rate exception.'."\n" + .'- QD_DECISION_PARAM_COUNT: decision parameter count exception.'."\n" + .'- QD_DECISION_PARAM_PERCENTAGE: decision parameter percentage exception.'."\n" + .'- QD_DECISION_PARAM_SUM: decision parameter sum exception.'."\n" + .'- QD_DECISION_PARAM_AVG: decision parameter average exception.'."\n" + .'- LOGICAL_INSTANCE_GENERATION: logical instance generation monitoring.'."\n" + .'- KGB_TASK_ERROR: baseline task error.'."\n" + .'- KGB_TASK_SLOW_DOWN: baseline task slowdown.'."\n" + .'- KGB_EARLY_WARNING: baseline early warning.'."\n" + .'- KGB_BROKEN_LINE: baseline broken line.'."\n" + ."\n" + .'And more.', 'type' => 'string', 'example' => 'VDM_BATCH_FINISH'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '20241125'], + 'UniqueKey' => ['title' => '', 'description' => 'The unique identifier.', 'type' => 'string', 'example' => '123456'], + 'AlertReasonParamList' => [ + 'title' => '', + 'description' => 'The list of alert parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The alert parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The alert parameter name.', 'type' => 'string', 'example' => 'biz_date'], + 'Value' => ['title' => '', 'description' => 'The alert parameter value.', 'type' => 'string', 'example' => '2024-11-24 00:00:00'], ], + 'example' => '', ], - ], - 'MonitorConfig' => [ - 'title' => '监控配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AttributeFromInfo' => [ - 'title' => '属性来源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeFrom' => [ - 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'StandardReference' => [ - 'title' => '对应的标准,属性来源为 STANDARD 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Version' => [ - 'title' => '版本号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - 'Id' => [ - 'title' => '属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1011', + 'example' => '', ], ], + 'example' => '', ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'StandardGeneralMonitorConfig' => [ - 'title' => '标准监控配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardMonitorConfigList' => [ - 'title' => '标准监控配置列表', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'AlertReceiver' => [ 'title' => '', - 'description' => '', + 'description' => 'The receiver information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '监控配置Id：若为空会创建新的监控配置, 若传入已有的监控配置Id会更新相应的监控配置', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'METADATA', - ], - 'MonitorFrom' => [ - 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', - 'description' => '', - 'type' => 'string', - 'example' => 'BY_SYSTEM_ATTRIBUTE', - ], - 'AttributeId' => [ - 'title' => '关联的属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '112', - ], - 'AttributeName' => [ - 'title' => '属性名称', - 'description' => '', - 'type' => 'string', - 'example' => 'teset', - ], - 'AttributeMonitorConfig' => [ - 'title' => '关联属性的监控配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控方式：METADATA 元数据监控、QUALITY 数据质量监控', - 'description' => '', - 'type' => 'string', - 'example' => 'METADATA', - ], - 'ColumnName' => [ - 'title' => '检查的字段', - 'description' => '', - 'type' => 'string', - 'example' => 'column1', - ], - 'IsCaseSensitive' => [ - 'title' => '大小写是否敏感', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'RuleSubType' => [ - 'title' => '规则子类型：BY_ATTRIBUTE 根据属性配置、CUSTOMIZED 自定义配置，当监控类型为 QUALITY 时必填', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'QualityRuleTemplate' => [ - 'title' => '规则模板, 当监控类型为 QUALITY 时必填', - 'description' => '', + 'AlertChannelType' => ['title' => '', 'description' => 'The push channel type. Valid values:'."\n" + .'- VOICE: phone call.'."\n" + .'- SMS: text message.'."\n" + .'- MAIL: email.'."\n" + .'- DINGTALK_ROBOT: DingTalk robot.'."\n" + .'- DINGDING: DingTalk work notification.'."\n" + .'- CUSTOM: custom message channel.'."\n" + .'- WECHAT: WeCom.'."\n" + .'- FEISHU: Lark.'."\n" + .'- SILENCE: do not send.', 'type' => 'string', 'example' => 'SMS'], + 'CustomAlertChannelId' => ['title' => '', 'description' => 'The custom message channel ID.', 'type' => 'string', 'example' => '123456'], + 'Type' => ['title' => '', 'description' => 'The alert receiver type. Valid values:'."\n" + .'- ON_CALL_TABLE: on-call schedule.'."\n" + .'- USER_DEFINED: custom user.'."\n" + .'- OWNER: owner.', 'type' => 'string', 'example' => 'OWNER'], + 'User' => [ + 'title' => '', + 'description' => 'The user information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Type' => [ - 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - ], - ], - 'RuleConfigList' => [ - 'title' => '规则配置, 当监控类型为 QUALITY 时必填', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '校验配置Id, 由业务随机生成且确保唯一', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - 'ParentId' => [ - 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', - 'description' => '', - 'type' => 'string', - 'example' => 'a', - ], - 'Type' => [ - 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', - 'description' => '', - 'type' => 'string', - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', - 'description' => '', - 'type' => 'string', - 'example' => 'AND', - ], - 'Metric' => [ - 'title' => '指标, 校验类型为 EXPRESSION 时必填', - 'description' => '', - 'type' => 'string', - 'example' => 'a', - ], - 'MetricName' => [ - 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Value' => [ - 'title' => '比较的值', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], + 'Name' => ['title' => '', 'description' => 'The name of the alert receiver.', 'type' => 'string', 'example' => 'ADMIN'], ], + 'example' => '', ], + 'OnCallTableId' => ['title' => '', 'description' => 'The on-call schedule ID.', 'type' => 'string', 'example' => '12345'], + 'OnCallTableName' => ['title' => '', 'description' => 'The on-call schedule name.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], - ], - ], - ], - 'StandardRelations' => [ - 'title' => '关联标准列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'RELATIVE', - ], - ], - ], - ], - 'LookupTableRelations' => [ - 'title' => '关联码表列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'LookupTableCode' => [ - 'title' => '码表编码', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'AttributeId' => [ - 'title' => '属性Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1122', - ], - 'AttributeName' => [ - 'title' => '属性名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'AttributeCode' => [ - 'title' => '属性名称', - 'description' => '', - 'type' => 'string', - 'example' => 'zz', + 'AlertSend' => [ + 'title' => '', + 'description' => 'The alert sending information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '', 'description' => 'The push status. Valid values:'."\n" + .'- SUCCESS: Sent successfully.'."\n" + .'- FAILE: Failed to send.'."\n" + .'- SENDING: Sending in progress.', 'type' => 'string', 'example' => 'SUCCESS'], + 'FailReason' => ['title' => '', 'description' => 'The alert reason.', 'type' => 'string', 'example' => '不合法'], + 'SendTime' => ['title' => '', 'description' => 'The push time.', 'type' => 'string', 'example' => '2024-11-25 10:02:47'], + 'SendContent' => ['title' => '', 'description' => 'The push content.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', ], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List push records', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteStandardWordRoot' => [ - 'summary' => '删除数据标准词根。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAlertNotifications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListApiByApp' => [ + 'summary' => 'Queries the list of APIs by application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'PageQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '词根名称', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The paged query parameters.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'The keyword.', 'type' => 'string', 'required' => false, 'example' => 'apiName'], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'], + 'PageNum' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + 'AppKey' => ['title' => '', 'description' => 'The application key.'."\n" + .'>Deprecated. Use AppKeyStr instead..', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '200000000'], + 'AppKeyStr' => ['title' => '', 'description' => 'The application key.', 'type' => 'string', 'required' => false, 'example' => 'APP_200000000'], + ], 'required' => true, - 'example' => '平均值', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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"}]', - ], - 'DeleteStandardValidMapping' => [ - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'ListResult' => [ + 'title' => '', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Data' => [ + 'title' => '', + 'description' => 'The API list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The API details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'Name' => ['title' => '', 'description' => 'The API name.', 'type' => 'string', 'example' => 'exampleApi'], + 'GroupId' => ['title' => '', 'description' => 'The API group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '67890'], + 'GroupName' => ['title' => '', 'description' => 'The API group name.', 'type' => 'string', 'example' => 'exampleGroup'], + 'RequestMethod' => ['title' => '', 'description' => 'The request method.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestMethodName' => ['title' => '', 'description' => 'The request method name.', 'type' => 'string', 'example' => 'GET'], + 'UpdateRate' => ['title' => '', 'description' => 'The update frequency.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'UpdateRateName' => ['title' => '', 'description' => 'The update frequency name.', 'type' => 'string', 'example' => '每日更新'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '这是一个示例API'], + 'ReturnType' => ['title' => '', 'description' => 'The return type.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'ReturnTypeName' => ['title' => '', 'description' => 'The return type name.', 'type' => 'string', 'example' => 'JSON'], + 'Protocol' => ['title' => '', 'description' => 'The protocol.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'ProtocolName' => ['title' => '', 'description' => 'The protocol name.', 'type' => 'string', 'example' => 'HTTP和HTTPS'], + 'SqlStatement' => ['title' => '', 'description' => 'The SQL statement.', 'type' => 'string', 'example' => 'SELECT * FROM example_table'], + 'RequestParamList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The request parameter response DTO.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'ParamName' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'param1'], + 'MappingColumn' => ['title' => '', 'description' => 'The frontend binding field.', 'type' => 'string', 'example' => 'column1'], + 'ParamType' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'String'], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'value1'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '这是一个示例参数'], + 'DescriptionCode' => ['title' => '', 'description' => 'The parameter description code.', 'type' => 'string', 'example' => 'CODE_001'], + 'Must' => ['title' => '', 'description' => 'Indicates whether the request parameter is required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Optional' => ['title' => '', 'description' => 'Indicates whether the parameter is editable.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DateFormat' => ['title' => '', 'description' => 'The date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '='], + 'OriginalColumn' => ['title' => '', 'description' => 'The original field name.', 'type' => 'string', 'example' => 'original_column'], + 'InitialValue' => ['title' => '', 'description' => 'The initial value.', 'type' => 'string', 'example' => 'app_key_value'], + 'TableAndDsList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The datasource simple DTO.', + 'type' => 'object', + 'properties' => [ + 'DatasourceId' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'string', 'example' => 'ds12345'], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name.', 'type' => 'string', 'example' => 'exampleDatasource'], + 'DatasourceType' => ['title' => '', 'description' => 'The datasource type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DatasourceUrl' => ['title' => '', 'description' => 'The datasource URL.', 'type' => 'string', 'example' => 'https://example.com/datasource'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'example_table'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ParameterLocation' => ['title' => '', 'description' => 'The request parameter location for registered APIs or the value path for response parameters.', 'type' => 'string', 'example' => '/path/to/param'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value for registered APIs.', 'type' => 'string', 'example' => 'default_value'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ResponseParamList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The response parameter response DTO.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2001'], + 'ParamName' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'responseParam1'], + 'MappingColumn' => ['title' => '', 'description' => 'The frontend binding field.', 'type' => 'string', 'example' => 'responseColumn1'], + 'ParamType' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'String'], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'responseValue1'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '这是一个示例响应参数'], + 'DescriptionCode' => ['title' => '', 'description' => 'The parameter description code.', 'type' => 'string', 'example' => 'CODE_002'], + 'Must' => ['title' => '', 'description' => 'Indicates whether the request parameter is required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Optional' => ['title' => '', 'description' => 'Indicates whether the parameter is editable.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DateFormat' => ['title' => '', 'description' => 'The date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '='], + 'OriginalColumn' => ['title' => '', 'description' => 'The original field name.', 'type' => 'string', 'example' => 'original_response_column'], + 'InitialValue' => ['title' => '', 'description' => 'The initial value.', 'type' => 'string', 'example' => 'app_key_value'], + 'TableAndDsList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The datasource simple DTO.', + 'type' => 'object', + 'properties' => [ + 'DatasourceId' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'string', 'example' => 'ds67890'], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name.', 'type' => 'string', 'example' => 'responseDatasource'], + 'DatasourceType' => ['title' => '', 'description' => 'The datasource type.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'DatasourceUrl' => ['title' => '', 'description' => 'The datasource URL.', 'type' => 'string', 'example' => 'https://example.com/response_datasource'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'response_table'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ParameterLocation' => ['title' => '', 'description' => 'The request parameter location for registered APIs or the value path for response parameters.', 'type' => 'string', 'example' => '/path/to/response_param'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value for registered APIs.', 'type' => 'string', 'example' => 'default_response_value'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'PublicParamList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The common parameter response DTO.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3001'], + 'ParamName' => ['title' => '', 'description' => 'The frontend parameter name.', 'type' => 'string', 'example' => 'publicParam1'], + 'MappingColumn' => ['title' => '', 'description' => 'The frontend binding field.', 'type' => 'string', 'example' => 'publicColumn1'], + 'ParamType' => ['title' => '', 'description' => 'The parameter type.', 'type' => 'string', 'example' => 'String'], + 'Sample' => ['title' => '', 'description' => 'The parameter example.', 'type' => 'string', 'example' => 'publicValue1'], + 'Description' => ['title' => '', 'description' => 'The parameter description.', 'type' => 'string', 'example' => '这是一个示例公共参数'], + 'DescriptionCode' => ['title' => '', 'description' => 'The parameter description code.', 'type' => 'string', 'example' => 'CODE_003'], + 'Must' => ['title' => '', 'description' => 'Indicates whether the request parameter is required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Optional' => ['title' => '', 'description' => 'Indicates whether the parameter is editable.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DateFormat' => ['title' => '', 'description' => 'The date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '='], + 'OriginalColumn' => ['title' => '', 'description' => 'The original field name.', 'type' => 'string', 'example' => 'original_public_column'], + 'InitialValue' => ['title' => '', 'description' => 'The initial value.', 'type' => 'string', 'example' => 'app_key_value'], + 'TableAndDsList' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The datasource simple DTO.', + 'type' => 'object', + 'properties' => [ + 'DatasourceId' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'string', 'example' => 'ds54321'], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name.', 'type' => 'string', 'example' => 'publicDatasource'], + 'DatasourceType' => ['title' => '', 'description' => 'The datasource type.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'DatasourceUrl' => ['title' => '', 'description' => 'The datasource URL.', 'type' => 'string', 'example' => 'https://example.com/public_datasource'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'public_table'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'ParameterLocation' => ['title' => '', 'description' => 'The request parameter location for registered APIs or the value path for response parameters.', 'type' => 'string', 'example' => '/path/to/public_param'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value for registered APIs.', 'type' => 'string', 'example' => 'default_public_value'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'SpecialSql' => ['title' => '', 'description' => 'The special SQL flag.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CreateType' => ['title' => '', 'description' => 'The creation type. Valid values:'."\n" + .'SQL_MODE(0, "Logical table API - SQL mode"),'."\n" + .'WIZARD_MODE(1, "Logical table API - wizard mode"),'."\n" + .'DIRECT_API_MODE(2, "Direct datasource - SQL mode"),'."\n" + .'REGISTER_API_MODE(3, "Registered API mode"),'."\n" + .'COMPOSITE_API_MODE(4, "Composite API mode").', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ApiNo' => ['title' => '', 'description' => 'The API number.', 'type' => 'integer', 'format' => 'int64', 'example' => '987654321'], + 'ModelType' => ['title' => '', 'description' => 'The model type.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'DbEnv' => ['title' => '', 'description' => 'The data environment.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ResultSample' => ['title' => '', 'description' => 'The sample call result.', 'type' => 'string', 'example' => '{"status":"success","data":[]}'], + 'BizModuleEnName' => ['title' => '', 'description' => 'The business module name.', 'type' => 'string', 'example' => 'exampleModule'], + 'TableName' => ['title' => '', 'description' => 'The logical table name.', 'type' => 'string', 'example' => 'exampleTable'], + 'IsLogicalTable' => ['title' => '', 'description' => 'Indicates whether the table is a logical table.', 'type' => 'boolean', 'example' => ''], + 'DirectDatasourceId' => ['title' => '', 'description' => 'The datasource ID of the direct API.', 'type' => 'integer', 'format' => 'int64', 'example' => '54321'], + 'DirectDatasourceName' => ['title' => '', 'description' => 'The datasource name of the direct API.', 'type' => 'string', 'example' => 'directDatasource'], + 'ApiTimeout' => ['title' => '', 'description' => 'The API timeout.', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'MaxReturnNum' => ['title' => '', 'description' => 'The maximum number of returned records.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'ProjId' => ['title' => '', 'description' => 'The service project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '112233'], + 'ProjName' => ['title' => '', 'description' => 'The service project name.', 'type' => 'string', 'example' => 'exampleProject'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'exampleApp'], + 'RsGrpId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'grp12345'], + 'ResourceGroupName' => ['title' => '', 'description' => 'The resource group name.', 'type' => 'string', 'example' => 'exampleResourceGroup'], + 'CacheSwitch' => ['title' => '', 'description' => 'The API cache switch.', 'type' => 'string', 'example' => '1'], + 'CacheTime' => ['title' => '', 'description' => 'The cache duration, in seconds.', 'type' => 'string', 'example' => '60'], + 'Timeout' => ['title' => '', 'description' => 'The timeout duration, in seconds.', 'type' => 'string', 'example' => '10'], + 'ScriptType' => ['title' => '', 'description' => 'The script type.', 'type' => 'string', 'example' => 'SQL'], + 'RegisterApi' => [ + 'title' => '', + 'description' => 'The registered API information.', + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['title' => '', 'description' => 'The primary key of data_api.', 'type' => 'integer', 'format' => 'int64', 'example' => '67890'], + 'ModelType' => ['title' => '', 'description' => 'The model type.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HttpMethod' => ['title' => '', 'description' => 'The HTTP method of the registered API.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DatasourceId' => ['title' => '', 'description' => 'The API datasource ID.', 'type' => 'string', 'example' => 'ds67890'], + 'DatasourceName' => ['title' => '', 'description' => 'The API datasource name.', 'type' => 'string', 'example' => 'registerDatasource'], + 'Url' => ['title' => '', 'description' => 'The API datasource URL.', 'type' => 'string', 'example' => 'https://example.com/register_api'], + 'AuthenticationMode' => ['title' => '', 'description' => 'The API datasource authentication mode.', 'type' => 'string', 'example' => 'OAuth2'], + 'Protocol' => ['title' => '', 'description' => 'The API datasource request protocol.', 'type' => 'string', 'example' => 'HTTPS'], + 'Path' => ['title' => '', 'description' => 'The service path.', 'type' => 'string', 'example' => '/api/v1/register'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period.', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'SuccessExample' => ['title' => '', 'description' => 'The success example.', 'type' => 'string', 'example' => '{"status":"success","data":[]}'], + 'FailExample' => ['title' => '', 'description' => 'The failure example.', 'type' => 'string', 'example' => '{"status":"error","message":"Invalid request"}'], + ], + 'example' => '', + ], + 'Version' => ['title' => '', 'description' => 'The API version.', 'type' => 'string', 'example' => 'v1.0'], + 'IsPagedQuery' => ['title' => '', 'description' => 'Indicates whether the query is a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AuthTypes' => [ + 'title' => '', + 'description' => 'The list of permission types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The permission type.', 'type' => 'string', 'example' => 'USE'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + '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\\": false,\\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 \\"AuthTypes\\": [\\n \\"USE\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query API details list under an application', + 'description' => 'Queries the detailed information of published APIs by appKey.', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListAuthorizedDataServiceApiDetails' => [ + 'summary' => 'Queries the list of specific fields for APIs that an application has requested.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DeleteCommand', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The query request.', 'type' => 'object', 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'GuidList' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1022', - ], - 'required' => false, - ], - 'BelongGuidList' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1023', - ], - 'required' => false, - ], + 'AppKey' => ['title' => '', 'description' => 'The application key.'."\n" + .'>Deprecated. Use AppKeyStr instead..', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '200000000'], + 'Page' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '20'], + 'AppKeyStr' => ['title' => '', 'description' => 'The application key.', 'type' => 'string', 'example' => 'APP_200000000', 'required' => false], ], 'required' => true, + 'example' => '30001011', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier for the request.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '非法入参'], + 'Result' => [ + 'title' => '', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Data' => [ + 'title' => '', + 'description' => 'The list of authorized API details.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The authorized API details.', + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['title' => '', 'description' => 'API_ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'ApiName' => ['title' => '', 'description' => 'The API name.', 'type' => 'string', 'example' => 'GetData'], + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'ProjectId' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'Description' => ['title' => '', 'description' => 'The API description.', 'type' => 'string', 'example' => 'Description1'], + 'DevAuthPeriod' => ['title' => '', 'description' => 'The validity period of the API permission in the development environment.', 'type' => 'string', 'example' => '2035-12-31'], + 'ProdAuthPeriod' => ['title' => '', 'description' => 'The validity period of the API permission in the production environment.', 'type' => 'string', 'example' => '2035-12-31'], + 'AuthType' => ['title' => '', 'description' => 'The permission type.', 'type' => 'string', 'example' => '使用权限'], + 'AuthorizedDevReturnParameters' => [ + 'title' => '', + 'description' => 'The list of fields authorized for the API in the development environment.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The field object.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'param1'], + 'ParameterDataType' => [ + 'title' => '', + 'description' => 'The parameter type.', + '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' => 'The description.', 'type' => 'string', 'example' => 'description1'], + 'ExampleValue' => ['title' => '', 'description' => 'The example value.', 'type' => 'string', 'example' => 'example1'], + 'IsAuthorized' => [ + 'title' => '', + 'description' => 'The field authorization status.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => ['0：未授权', '1：已授权'], + ], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AuthorizedProdReturnParameters' => [ + 'title' => '', + 'description' => 'The list of fields authorized for the API in the production environment.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The field object.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'param1'], + 'ParameterDataType' => [ + 'title' => '', + 'description' => 'The parameter type.', + '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' => 'The description.', 'type' => 'string', 'example' => 'description1'], + 'ExampleValue' => ['title' => '', 'description' => 'The example value.', 'type' => 'string', 'example' => 'example1'], + 'IsAuthorized' => [ + 'title' => '', + 'description' => 'The field authorization status.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => ['0：未授权', '1：已授权'], + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query the list of specific fields for aPIs requested by an application', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed'], ], - '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"}]', - ], - 'DeleteStandardSet' => [ - 'summary' => '删除标准集。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAuthorizedDataServiceApiDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListBatchTemplates' => [ + 'summary' => 'Queries offline computing templates by paging. Online version: v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'], + ], + [ + 'name' => 'Env', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The runtime environment. Default value: PROD.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '标准集Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', + 'title' => '', + 'description' => 'The paged query conditions.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'The template name keyword.', 'type' => 'string', 'required' => false, 'example' => '数据处理模板'], + 'PageNum' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TemplateList' => [ + 'title' => '', + 'description' => 'The list of template records.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID, which is the same as the menu tree node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '数据处理模板'], + 'OperatorType' => ['title' => '', 'description' => 'The node type. Valid values: 10 (Shell) and 21 (Python).', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Engine' => ['title' => '', 'description' => 'The compute engine version. Currently supported Python versions: Python 2.7 and Python 3.7.', 'type' => 'string', 'example' => 'Python 3.7'], + 'Content' => ['title' => '', 'description' => 'The template content.', 'type' => 'string', 'example' => '#!/bin/bash'."\n" + .'echo \'hello world\''], + 'CurrentVersion' => ['title' => '', 'description' => 'The current latest version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'The template status. Valid values: 0 (draft), 2 (submitted), and 100 (in development).', 'type' => 'string', 'example' => '2'], + 'Description' => ['title' => '', 'description' => 'The template description.', 'type' => 'string', 'example' => '用于数据处理的Shell模板'], + 'Owner' => ['title' => '', 'description' => 'The template owner.', 'type' => 'string', 'example' => '张三'], + 'OwnerId' => ['title' => '', 'description' => 'The template owner ID.', 'type' => 'string', 'example' => '100001'], + 'Comment' => ['title' => '', 'description' => 'The template submission comment.', 'type' => 'string', 'example' => '初始化提交'], + 'Modifier' => ['title' => '', 'description' => 'The last modifier of the template.', 'type' => 'string', 'example' => '李四'], + 'ModifierId' => ['title' => '', 'description' => 'The ID of the last modifier of the template.', 'type' => 'string', 'example' => '100002'], + 'GmtCreate' => ['title' => '', 'description' => 'The template creation time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2026-01-01 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The template update time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2026-05-28 15:30:00'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List offline computing templates by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 100,\\n \\"TemplateList\\": [\\n {\\n \\"Id\\": 1001,\\n \\"ProjectId\\": 123456,\\n \\"Name\\": \\"数据处理模板\\",\\n \\"OperatorType\\": 10,\\n \\"Engine\\": \\"Python 3.7\\",\\n \\"Content\\": \\"#!/bin/bash\\\\necho \'hello world\'\\",\\n \\"CurrentVersion\\": 1,\\n \\"Status\\": \\"2\\",\\n \\"Description\\": \\"用于数据处理的Shell模板\\",\\n \\"Owner\\": \\"张三\\",\\n \\"OwnerId\\": \\"100001\\",\\n \\"Comment\\": \\"初始化提交\\",\\n \\"Modifier\\": \\"李四\\",\\n \\"ModifierId\\": \\"100002\\",\\n \\"GmtCreate\\": \\"2026-01-01 10:00:00\\",\\n \\"GmtModified\\": \\"2026-05-28 15:30:00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteStandardRelations' => [ - 'summary' => '批量删除标准关联关系。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ListBizEntities' => [ + 'summary' => 'Queries a list of business entities.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The query request.', 'type' => 'object', 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'StandardRefList' => [ - 'title' => '被引用的标准列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'object_'], + 'Page' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'FilterCriteria' => [ + 'title' => '', + 'description' => 'The filter criteria for the query.', + 'type' => 'object', + 'properties' => [ + 'BizUnitIdList' => [ + 'title' => '', + 'description' => 'The list of business unit IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of business unit IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102323411'], + 'required' => false, + 'example' => '', + ], + 'BizUnitNameList' => [ + 'title' => '', + 'description' => 'The list of business unit IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of business unit IDs.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'required' => false, + 'example' => '', + ], + 'DataDomainIdList' => [ + 'title' => '', + 'description' => 'The list of data domain IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of business unit IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102323411'], + 'required' => false, + 'example' => '', + ], + 'DataDomainNameList' => [ + 'title' => '', + 'description' => 'The list of data domain IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of data domain IDs.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'required' => false, + 'example' => '', + ], + 'SubTypeList' => [ + 'title' => '', + 'description' => 'The list of business entity subtypes. For more information, refer to the API operation for querying business entity details.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of data domain IDs.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'required' => false, + 'example' => '', + ], + 'OwnerUserIdList' => [ + 'title' => '', + 'description' => 'The list of owner user IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of owner user IDs.', 'type' => 'string', 'required' => true, 'example' => '30001326'], + 'required' => false, + 'example' => '', + ], + 'HasTableRef' => ['title' => '', 'description' => 'Specifies whether the business entity is associated with a logical table.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'StatusList' => [ + 'title' => '', + 'description' => 'The list of business entity statuses. For more information, refer to the API operation for querying business entity details.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business entity status.', 'type' => 'string', 'required' => true, 'example' => 'PUBLISHED'], + 'required' => false, + 'example' => '', ], - 'required' => false, ], - 'required' => true, - ], - 'RelationType' => [ - 'title' => '标准关联关系：RELATIVE', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RELATIVE', + 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'Data' => [ - 'title' => '删除结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paginated result.', 'type' => 'object', 'properties' => [ - 'SuccessCount' => [ - 'title' => '添加成功数目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'NotExistStandardIdList' => [ - 'title' => '不存在标准Id列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], + 'BizEntityList' => [ + 'title' => '', + 'description' => 'The list of business entities.', 'type' => 'array', 'items' => [ - 'title' => '不存在标准Id列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1021', + 'title' => '', + 'description' => 'The business entity.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '12121111'], + 'Name' => ['title' => '', 'description' => 'The name of the business entity.', 'type' => 'string', 'example' => 'create_process_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business entity.', 'type' => 'string', 'example' => '业务活动测试'], + 'Description' => ['title' => '', 'description' => 'The description of the business entity.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The ID of the business entity owner.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The ID of the business entity owner.', 'type' => 'string', 'example' => '张三'], + 'Type' => ['title' => '', 'description' => 'The type of the business entity. Valid values:'."\n" + .'- BIZ_OBJECT: business object.'."\n" + .'- BIZ_PROCESS: business process.', 'type' => 'string', 'example' => 'BIZ_OBJECT'], + 'SubType' => ['title' => '', 'description' => 'The subtype of the business entity.', 'type' => 'string', 'example' => 'NORMAL'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '20101011'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '6798087749072704'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the business entity was created.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The time when the business entity was last modified.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business entity.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business entity.', 'type' => 'string', 'example' => '张三'], + 'OnlineStatus' => ['title' => '', 'description' => 'The online status of the business entity. Valid values: '."\n" + .'- SUBMITTED: not online.'."\n" + .'- APPROVING: pending approval.'."\n" + .'- PUBLISHED: online.'."\n" + .'- REJECT: failed to go online.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'Status' => ['title' => '', 'description' => 'The status of the business entity. Valid values:'."\n" + .'- DRAFT: draft or not online.'."\n" + .'- SUBMITTING: being submitted.'."\n" + .'- SUBMITTED: submitted.'."\n" + .'- DEVELOPING: under development.'."\n" + .'- PUBLISHING: being published.'."\n" + .'- PUBLISHED: published.', 'type' => 'string', 'example' => 'SUBMITTED'], + 'RefTableCount' => ['title' => '', 'description' => 'The number of associated logical tables.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HasChildBizEntity' => ['title' => '', 'description' => 'Indicates whether the entity is a child business object.', 'type' => 'boolean', 'example' => ''], + 'LevelSubBizObject' => ['title' => '', 'description' => 'Indicates whether the entity is a sublevel of a hierarchy dimension.', 'type' => 'boolean', 'example' => ''], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated central business entity IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '11023'], + 'example' => '', + ], + 'BelongToBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of parent business process IDs. This parameter is valid only when the entity type is business process.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '11023'], + 'example' => '', + ], + 'ChildBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of child business object IDs. This parameter is valid only when the entity type is business object.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '11023'], + 'example' => '', + ], + 'SuffixBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of subsequent business process IDs. This parameter is valid only when the entity type is business process.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'example' => '11023'], + 'example' => '', + ], + ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"LevelSubBizObject\\": false,\\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' => 'Query business entities', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteStandardLookupTable' => [ - 'summary' => '删除数据标准码表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListBizEntities', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListBizUnits' => [ + 'summary' => 'Retrieves all business units under the current tenant.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '码表Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => [ + 'title' => '', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'BizUnitList' => [ + 'title' => '', + 'description' => 'The business unit details.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The business unit details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101001201'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'test01'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => '测试'], + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the business unit.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the business unit.', 'type' => 'string', 'example' => '张三'], + 'Icon' => ['title' => '', 'description' => 'The business unit icon.', 'type' => 'string', 'example' => 'icon-e-commerce'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment.'."\n" + .'- PROD: production environment.', 'type' => 'string', 'example' => 'DEV'], + 'Mode' => ['title' => '', 'description' => 'The production mode. Valid values:'."\n" + .'- BASIC: single-environment mode.'."\n" + .'- DEV_PROD: development/production dual-environment mode.', 'type' => 'string', 'example' => 'DEV_PROD'], + 'AccountList' => [ + 'title' => '', + 'description' => 'The business unit architects.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '20001201'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query all business units under the current tenant', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteStandardInValidMapping' => [ - 'summary' => '删除无效映射关系。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListBizUnits', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListCatalogAssets' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'ListCatalogAssetsQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The query parameters.', 'type' => 'object', 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'GuidList' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1022', - ], - 'required' => false, - ], - 'BelongGuidList' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '所属guid列表,上限为1000', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1023', - ], - 'required' => false, - ], + 'AssetType' => ['title' => '', 'description' => 'The asset type. Default value: TABLE. Valid values:'."\n" + .'- TABLE: table, including views and materialized views.'."\n" + .'- INDEX: technical metric.'."\n" + .'- BIZ_INDEX: business metric.'."\n" + .'- API: API.'."\n" + .'- PAGE: dashboard.', 'type' => 'string', 'required' => false, 'example' => 'TABLE'], + 'QueryMode' => ['title' => '', 'description' => 'The query type. Determines whether to use name for exact matching or keyword for fuzzy search. Default value: EXACT_MATCH. Valid values:'."\n" + .'- EXACT_MATCH: exact match.'."\n" + .'- ASSET_SEARCH: fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'EXACT_MATCH'], + 'Name' => ['title' => '', 'description' => 'The asset name. Used when queryMode is set to EXACT_MATCH. If this parameter is not specified, all assets are queried.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. Used when queryMode is set to ASSET_SEARCH. Supports keyword matching against the asset full name, asset name, asset display name, and asset description. If this parameter is not specified, all assets are queried.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'PageNum' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => [ + 'title' => '', + 'description' => 'The data catalog asset list.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'AssetList' => [ + 'title' => '', + 'description' => 'The asset list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The asset catalog query result.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['title' => '', 'description' => 'The asset GUID, which serves as the unique identifier of the asset.', 'type' => 'string', 'example' => 'dp_ds_table.300023201.7311626611751680256.load_test.abc'], + 'AssetType' => ['title' => '', 'description' => 'The asset type. Valid values: TABLE (table, including views and materialized views), INDEX (technical metric), BIZ_INDEX (business metric), API, and PAGE (dashboard).', 'type' => 'string', 'example' => 'TABLE'], + 'IsDeleted' => ['title' => '', 'description' => 'Indicates whether the asset is deleted.', 'type' => 'boolean', 'example' => ''], + 'AssetName' => ['title' => '', 'description' => 'The asset name.', 'type' => 'string', 'example' => 'abc'], + 'AssetDisplayName' => ['title' => '', 'description' => 'The asset display name. Returned when the asset type is TABLE, INDEX, or BIZ_INDEX.', 'type' => 'string', 'example' => 'abc表'], + 'AssetFullName' => ['title' => '', 'description' => 'The asset full name. Returned when the asset type is TABLE or INDEX.', 'type' => 'string', 'example' => 'dwd_all.abc'], + 'MaxSecurityLevel' => ['title' => '', 'description' => 'The highest sensitivity level. Returned when the asset type is TABLE.', 'type' => 'string', 'example' => 'L3'], + 'AssetTags' => [ + 'title' => '', + 'description' => 'The asset tags.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The asset tags.', 'type' => 'string', 'example' => '["标签1", "标签2"]'], + 'example' => '', + ], + 'AssetDescription' => ['title' => '', 'description' => 'The asset description.', 'type' => 'string', 'example' => 'abc'], + 'AssetFrom' => ['title' => '', 'description' => 'The asset source. For TABLE (physical table), the value is in the format "Dataphin-workspace type-project Chinese name (project English name)". For TABLE (logical table), the value is in the format "Dataphin-workspace type-data domain Chinese name (data domain English name)". For TABLE (data source table), the value is in the format "source system name-data source name-database/schema name". For INDEX (standard modeling metric), the value is the asset source of the associated aggregate table. For INDEX (custom metric), the value is the asset source of the source table. For API, the value is the data service project name. For PAGE, the value is the application system name.', 'type' => 'string', 'example' => 'Dataphin-中间层-服饰零售 (LD_Fashion)'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '6865277495315392'], + 'BizUnitName' => ['title' => '', 'description' => 'The name of the business unit to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '服饰零售（LD_Fashion）'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the asset belongs. Returned when the asset type is TABLE (physical tables only) or INDEX (technical metrics whose source table is a physical table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '6865331517728384'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project to which the asset belongs. Returned when the asset type is TABLE (physical tables only) or INDEX (technical metrics whose source table is a physical table only).', 'type' => 'string', 'example' => 'train'], + 'DatasourceId' => ['title' => '', 'description' => 'The ID of the data source to which the asset belongs. Returned when the asset type is TABLE (data source tables only) or INDEX (technical metrics whose source table is a data source table only).', 'type' => 'integer', 'format' => 'int64', 'example' => '7305549302863001856'], + 'DataSourceName' => ['title' => '', 'description' => 'The name of the data source to which the asset belongs. Returned when the asset type is TABLE (data source tables only) or INDEX (technical metrics whose source table is a data source table only).', 'type' => 'string', 'example' => 'demo_mysql'], + 'SubType' => ['title' => '', 'description' => 'The subtype. Valid values: DIM_NORMAL (common logical dimension table), DIM_ENUM (enumeration logical dimension table), DIM_VIRTUAL (virtual logical dimension table), SUM_BIZ_UNIT (aggregate logical table), FACT_EVENT (event fact logical table), FACT_SNAPSHOT (snapshot fact logical table), DATASOURCE_TABLE (data source table), PHYSICAL_TABLE (physical table), DATASOURCE_VIEW (view - data source view), PHYSICAL_VIEW (physical view), MATERIALIZED_VIEW (materialized view), BIZ_INDEX (business metric), INDEX (technical metric - standard modeling metric), and CUSTOM_INDEX (technical metric - custom metric).', 'type' => 'string', 'example' => 'DIM_NORMAL'], + 'Directories' => [ + 'title' => '', + 'description' => 'The directories to which the asset belongs, including topic ID, topic name, directory ID, and directory name.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The directory information to which the asset belongs.', + 'type' => 'object', + 'properties' => [ + 'TopicId' => ['title' => '', 'description' => 'The topic ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101676'], + 'TopicName' => ['title' => '', 'description' => 'The topic name.', 'type' => 'string', 'example' => '全渠道数据专题'], + 'DirectoryId' => ['title' => '', 'description' => 'The directory ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '102260'], + 'DirectoryName' => ['title' => '', 'description' => 'The directory name.', 'type' => 'string', 'example' => '线上电商平台'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'SumTableGuid' => ['title' => '', 'description' => 'The GUID of the aggregate table to which the asset belongs. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => 'odps.300023201.test.ads_gross'], + 'SumTableName' => ['title' => '', 'description' => 'The name of the aggregate table to which the asset belongs. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => 'ads_gross'], + 'Granularity' => ['title' => '', 'description' => 'The statistical granularity name of the technical metric. Returned when the asset type is INDEX.', 'type' => 'string', 'example' => '课程'], + 'DataCellId' => ['title' => '', 'description' => 'The ID of the subject domain to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '49837403'], + 'DataCellName' => ['title' => '', 'description' => 'The name of the subject domain to which the asset belongs. Returned when the asset type is TABLE (logical tables only) or INDEX (technical metrics whose source table is a logical table only).', 'type' => 'string', 'example' => '课程域'], + 'ApiId' => ['title' => '', 'description' => 'The API ID. Returned when the asset type is API.', 'type' => 'integer', 'format' => 'int64', 'example' => '10441'], + 'ApiGroupName' => ['title' => '', 'description' => 'The API group name. Returned when the asset type is API.', 'type' => 'string', 'example' => '默认API分组'], + 'ApiRequestMethod' => ['title' => '', 'description' => 'The API operation type. Returned when the asset type is API. Valid values:'."\n" + .'- 1: Get.'."\n" + .'- 2: List.'."\n" + .'- 3: Create.'."\n" + .'- 4: Update.'."\n" + .'- 5: Delete.', 'type' => 'string', 'example' => '1'], + 'ApiCallMode' => ['title' => '', 'description' => 'The API call mode. Returned when the asset type is API. Valid values:'."\n" + .'- 1: synchronous call.'."\n" + .'- 2: asynchronous call.', 'type' => 'string', 'example' => '1'], + 'BiCatalog' => ['title' => '', 'description' => 'The BI workspace or directory to which the asset belongs. Returned when the asset type is PAGE (dashboard).', 'type' => 'string', 'example' => 'dataphin演示空间'], + 'ChartCount' => ['title' => '', 'description' => 'The total number of charts. Returned when the asset type is PAGE (dashboard).', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'DeleteStandard' => [ - 'summary' => '删除标准。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query asset catalog list', + 'summary' => 'Queries the list of asset catalog entries. Online version: v6.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:ListCatalogAssets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 68,\\n \\"AssetList\\": [\\n {\\n \\"Guid\\": \\"dp_ds_table.300023201.7311626611751680256.load_test.abc\\",\\n \\"AssetType\\": \\"TABLE\\",\\n \\"IsDeleted\\": false,\\n \\"AssetName\\": \\"abc\\",\\n \\"AssetDisplayName\\": \\"abc表\\",\\n \\"AssetFullName\\": \\"dwd_all.abc\\",\\n \\"MaxSecurityLevel\\": \\"L3\\",\\n \\"AssetTags\\": [\\n \\"[\\\\\\"标签1\\\\\\", \\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"AssetDescription\\": \\"abc\\",\\n \\"AssetFrom\\": \\"Dataphin-中间层-服饰零售 (LD_Fashion)\\",\\n \\"BizUnitId\\": 6865277495315392,\\n \\"BizUnitName\\": \\"服饰零售（LD_Fashion）\\",\\n \\"ProjectId\\": 6865331517728384,\\n \\"ProjectName\\": \\"train\\",\\n \\"DatasourceId\\": 7305549302863002000,\\n \\"DataSourceName\\": \\"demo_mysql\\",\\n \\"SubType\\": \\"DIM_NORMAL\\",\\n \\"Directories\\": [\\n {\\n \\"TopicId\\": 101676,\\n \\"TopicName\\": \\"全渠道数据专题\\",\\n \\"DirectoryId\\": 102260,\\n \\"DirectoryName\\": \\"线上电商平台\\"\\n }\\n ],\\n \\"SumTableGuid\\": \\"odps.300023201.test.ads_gross\\",\\n \\"SumTableName\\": \\"ads_gross\\",\\n \\"Granularity\\": \\"课程\\",\\n \\"DataCellId\\": \\"49837403\\",\\n \\"DataCellName\\": \\"课程域\\",\\n \\"ApiId\\": 10441,\\n \\"ApiGroupName\\": \\"默认API分组\\",\\n \\"ApiRequestMethod\\": \\"1\\",\\n \\"ApiCallMode\\": \\"1\\",\\n \\"BiCatalog\\": \\"dataphin演示空间\\",\\n \\"ChartCount\\": 23\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListComputeSources' => [ + 'summary' => 'Query the list of compute sources.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'Type' => ['title' => '', 'description' => 'The type of the compute source.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], + 'BindProject' => ['title' => '', 'description' => 'Specifies whether the compute source is bound to a project.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Keyword' => ['title' => '', 'description' => 'The keyword used for filtering.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paginated query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'ComputeSourceList' => [ + 'title' => '', + 'description' => 'The paginated list of compute sources.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['title' => '', 'description' => 'The ID of the compute source owner.', 'type' => 'string', 'example' => '30012211'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the compute source owner.', 'type' => 'string', 'example' => '张三'], + 'BindProjectId' => ['title' => '', 'description' => 'The ID of the bound project.', 'type' => 'integer', 'format' => 'int64', 'example' => '10132131111'], + 'Description' => ['title' => '', 'description' => 'The description of the compute source.', 'type' => 'string', 'example' => 'test'], + 'BindProject' => ['title' => '', 'description' => 'Indicates whether the compute source is bound to a project.', 'type' => 'boolean', 'example' => ''], + 'GmtModified' => ['title' => '', 'description' => 'The time when the compute source was last modified, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'Creator' => ['title' => '', 'description' => 'The ID of the creator.', 'type' => 'string', 'example' => '30012211'], + 'Name' => ['title' => '', 'description' => 'The name of the compute source.', 'type' => 'string', 'example' => 'test1011'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the compute source was created, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'Type' => ['title' => '', 'description' => 'The type of the compute source.', 'type' => 'string', 'example' => 'MaxCompute'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the compute source.', 'type' => 'string', 'example' => 'test1011'], + 'Id' => ['title' => '', 'description' => 'The ID of the compute source.', 'type' => 'integer', 'format' => 'int64', 'example' => '102111'], + 'BindProjectName' => ['title' => '', 'description' => 'The name of the bound project.', 'type' => 'string', 'example' => 'testPrj'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'Query the list of compute sources by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStandardWordRoot' => [ - 'summary' => '创建数据标准词根。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ListDataDomains' => [ + 'summary' => 'Retrieves a list of data domains.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The query request.', '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', + 'BizUnitIdList' => [ + 'title' => '', + 'description' => 'The IDs of the business units to which the data domains belong.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The IDs of the business units to which the data domains belong.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456'], + 'required' => false, + 'example' => '', ], - 'Description' => [ - 'title' => '词根描述', - 'description' => '', - 'type' => 'string', + 'ParentIdList' => [ + 'title' => '', + 'description' => 'The IDs of the parent data domains.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The IDs of the parent data domains.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10232311'], 'required' => false, - 'example' => 'test', + 'example' => '', ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. You can search by data domain name, code, or description.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ - 'title' => '词根名称', - 'description' => '', - 'type' => 'string', - 'example' => 'average', + 'title' => '', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'DataDomainList' => [ + 'title' => '', + 'description' => 'The details of the data domains.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of the data domains.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the data domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the data domain belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '545844456'], + 'Name' => ['title' => '', 'description' => 'The name of the data domain.', 'type' => 'string', 'example' => 'dm_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the data domain.', 'type' => 'string', 'example' => '测试'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the data domain.', 'type' => 'string', 'example' => 'dm_code_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object.', 'type' => 'string', 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The ID of the owner of the business object.', 'type' => 'string', 'example' => '30010010'], + 'OwnerName' => ['title' => '', 'description' => 'The ID of the owner of the business object.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the data domain.', 'type' => 'string', 'example' => '30010010'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the data domain.', 'type' => 'string', 'example' => '张三'], + 'ParentId' => ['title' => '', 'description' => 'The IDs of the parent data domains.', 'type' => 'integer', 'format' => 'int64', 'example' => '10232311'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query data domain list', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateStandardTemplate' => [ - 'summary' => '创建数据标准模板。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListDataDomains', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDataServiceApiCallStatistics' => [ + 'summary' => 'O&M analysis: API call statistics.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'Search conditions.', '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' => '', + 'OrderColumn' => ['title' => '', 'description' => 'Sort column. Valid values: CALL_COUNT (call count), ERROR_COUNT (error count), ERROR_RATE (error rate), AVG_RESPONSE_TIME (average response time), and OFFLINE_RATE (offline percentage). Default value: CALL_COUNT.', 'type' => 'string', 'required' => false, 'example' => 'CALL_COUNT'], + 'OrderType' => ['title' => '', 'description' => 'Sort order. Valid values: 1 (ascending) and 2 (descending). Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Keyword' => ['title' => '', 'description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'StartTime' => ['title' => '', 'description' => 'Start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + 'EndTime' => ['title' => '', 'description' => 'End time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend error details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', 'type' => 'object', 'properties' => [ - 'AttributeList' => [ - 'title' => '属性列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'CallStatisticsList' => [ + 'title' => '', + 'description' => 'API call statistics list.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => '', '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性值的数据类型：STRING 字符串、BIGINT 数值类型、DOUBLE 浮点类型、DATE 日期,精确到天、DATETIME 日期,精确到ms、BOOLEAN 布尔型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'STRING', - ], - 'Length' => [ - 'title' => '属性值长度, 为空或-1表示不限制长度, 通常只有字符串类型才会限制属性值的长度', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NONE', - ], - 'ValueList' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '取值范围,当取值来源取值为 LIST 生效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'MinMaxValueConfig' => [ - 'title' => '取值范围,当取值来源取值为 MIN_MAX 生效', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'LookupTableId' => [ - 'title' => '码表Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'AttributeFromInfo' => [ - 'title' => '属性来源', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeFrom' => [ - 'title' => '属性来源：SYSTEM 系统属性、CUSTOM 自定义属性、STANDARD 标准', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOM', - ], - 'StandardReference' => [ - 'title' => '对应的标准,属性来源为 STANDARD 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'AutoConfig' => [ - 'title' => '标准编码规则自动生成配置, 当生产方式为 AUTO_GENERATE 生效', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NeedStrongValidate' => [ - 'title' => '是否强校验', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - ], - 'CodeRuleList' => [ - 'title' => '标准编码规则', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'ApiName' => ['title' => '', 'description' => 'API name.', 'type' => 'string', 'example' => 'test'], + 'ProjectName' => ['title' => '', 'description' => 'Data service project.', 'type' => 'string', 'example' => 'test'], + 'AppNameList' => [ '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' => '', - '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, + 'description' => 'Authorized application names.', + 'type' => 'array', + 'items' => ['description' => 'Authorized application name.', 'type' => 'string', 'title' => '', 'example' => '授权应用名称'], + 'example' => '', ], - 'required' => true, + 'ProjectId' => ['title' => '', 'description' => 'Data service project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '101201'], + 'Creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '30012011'], + 'ErrorCount' => ['title' => '', 'description' => 'Number of call errors.', 'type' => 'string', 'example' => '22'], + 'AuthorizedAppCount' => ['title' => '', 'description' => 'Number of authorized applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SqlId' => ['title' => '', 'description' => 'SQL table primary key.', 'type' => 'integer', 'format' => 'int32', 'example' => '1121'], + 'OfflineRate' => ['title' => '', 'description' => 'Offline percentage.', 'type' => 'string', 'example' => '23.2%'], + 'LastCallTime' => ['title' => '', 'description' => 'Last call time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'CallCount' => ['title' => '', 'description' => 'Number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AvgResponseTime' => ['title' => '', 'description' => 'Average response time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '11'], + 'ApiId' => ['title' => '', 'description' => 'API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1003'], + 'ErrorRate' => ['title' => '', 'description' => 'Error rate.', 'type' => 'string', 'example' => '23.2%'], ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], ], - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query API call statistics by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStandardSet' => [ - 'summary' => '创建标准集。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataServiceApiCalls' => [ + 'summary' => 'Queries data service call logs with pagination.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PUBLIC', - ], - 'SpecifiedUserList' => [ - 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '指定可见的人员列表,当可见类型为 SPECIFIED 生效', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_DEFAULT', - ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_DEFAULT', - ], - 'TemplateId' => [ - 'title' => '审批模板Id,当审批流程类型为 BY_TEMPLATE 生效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1121', - ], - ], - 'required' => false, - ], - 'DefaultStandardTemplateId' => [ - 'title' => '默认标准模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1001', - ], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'AppKey' => ['title' => '', 'description' => 'The application key.'."\n" + .'>This parameter is deprecated. Use AppKeyStr instead.>', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '12345'], + 'AppKeyStr' => ['title' => '', 'description' => 'The application key.', 'type' => 'string', 'example' => 'app12345', 'required' => false], + 'ApiName' => ['title' => '', 'description' => 'The name of the API.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ApiId' => ['title' => '', 'description' => 'The ID of the API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20122'], + 'StartTime' => ['title' => '', 'description' => 'The start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], + 'ClientIp' => ['title' => '', 'description' => 'The IP address.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1'], + 'Successful' => ['title' => '', 'description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1201', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paginated query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'CallLogList' => [ + 'title' => '', + 'description' => 'The list of API call logs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['title' => '', 'description' => 'The ID of the API.', 'type' => 'integer', 'format' => 'int64', 'example' => '102112'], + 'AppKey' => ['title' => '', 'description' => 'The application key.'."\n" + .'>This parameter is deprecated. Use AppKeyStr instead.>', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '12345'], + 'AppKeyStr' => ['title' => '', 'description' => 'The application key.', 'type' => 'string', 'example' => 'abc12345'], + 'Sql' => ['title' => '', 'description' => 'The SQL statement.', 'type' => 'string', 'example' => 'select col1 from t_test1 limit 100;'], + 'ClientIp' => ['title' => '', 'description' => 'The IP address of the request.', 'type' => 'string', 'example' => '192.168.1.1'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the request. Format: yyyy-MM-dd HH:mm:ss.SSS.', 'type' => 'string', 'example' => '2024-11-01 01:01:01.000'], + 'EndTime' => ['title' => '', 'description' => 'The end time of the request. Format: yyyy-MM-dd HH:mm:ss.SSS.', 'type' => 'string', 'example' => '2024-11-01 01:01:03.000'], + 'CostTime' => ['title' => '', 'description' => 'The duration of the request, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'RequestParameter' => ['title' => '', 'description' => 'The request parameters.', 'type' => 'string', 'example' => '{"name":"test"}'], + 'ResponseParameter' => ['title' => '', 'description' => 'The response parameters.', 'type' => 'string', 'example' => '{"code":"200","message":"success"}'], + 'RequestSize' => ['title' => '', 'description' => 'The size of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'], + 'ResponseSize' => ['title' => '', 'description' => 'The size of the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'], + 'ResultCount' => ['title' => '', 'description' => 'The number of returned data records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Successful' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], + 'HttpStatusDescription' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'BizCode' => ['title' => '', 'description' => 'The business status code.', 'type' => 'string', 'example' => 'OK'], + 'BizCodeDescription' => ['title' => '', 'description' => 'The description of the business status code.', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890-232sds-3e232-ae2e232'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102356'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.', 'type' => 'string', 'example' => 'test'], + 'ApiName' => ['title' => '', 'description' => 'The name of the API.', 'type' => 'string', 'example' => 'test'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.', 'type' => 'string', 'example' => 'test'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values: 0 (dev) and 1 (prod).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'JobId' => ['title' => '', 'description' => 'The job ID.', 'type' => 'string', 'example' => '102356'], + 'Status' => ['title' => '', 'description' => 'The call status of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExecuteMode' => ['title' => '', 'description' => 'The execution mode. Valid values: 1 (synchronous) and 2 (asynchronous).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExecuteCostTime' => ['title' => '', 'description' => 'The execution duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'CreateStandardRelations' => [ - 'summary' => '创建标准关联关系。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"CallLogList\\": [\\n {\\n \\"ApiId\\": 102112,\\n \\"AppKey\\": 12345,\\n \\"AppKeyStr\\": \\"abc12345\\",\\n \\"Sql\\": \\"select col1 from t_test1 limit 100;\\",\\n \\"ClientIp\\": \\"192.168.1.1\\",\\n \\"StartTime\\": \\"2024-11-01 01:01:01.000\\",\\n \\"EndTime\\": \\"2024-11-01 01:01:03.000\\",\\n \\"CostTime\\": 2000,\\n \\"RequestParameter\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"ResponseParameter\\": \\"{\\\\\\"code\\\\\\":\\\\\\"200\\\\\\",\\\\\\"message\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"RequestSize\\": 1024,\\n \\"ResponseSize\\": 1024,\\n \\"ResultCount\\": 1,\\n \\"Successful\\": false,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"HttpStatusDescription\\": \\"OK\\",\\n \\"BizCode\\": \\"OK\\",\\n \\"BizCodeDescription\\": \\"OK\\",\\n \\"RequestId\\": \\"1234567890-232sds-3e232-ae2e232\\",\\n \\"ProjectId\\": 102356,\\n \\"AppName\\": \\"test\\",\\n \\"ApiName\\": \\"test\\",\\n \\"ProjectName\\": \\"test\\",\\n \\"Env\\": 1,\\n \\"JobId\\": \\"102356\\",\\n \\"Status\\": 1,\\n \\"ExecuteMode\\": 1,\\n \\"ExecuteCostTime\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Data Service Call Logs with Pagination', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDataServiceApiImpacts' => [ + 'summary' => 'Operations analysis: analyzes the impact of abnormal API calls.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'StandardRefList' => [ - 'title' => '被引用的标准列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'RelationType' => [ - 'title' => '标准关联关系：RELATIVE', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RELATIVE', - ], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'StartTime' => ['title' => '', 'description' => 'The start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 08:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-06-30 20:00:00'], + 'ApiId' => ['title' => '', 'description' => 'The ID of the called API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021'], + 'OrderColumn' => ['title' => '', 'description' => 'The column used for sorting. Valid values: CALL_COUNT: the number of calls. ERROR_COUNT: the number of errors. ERROR_RATE: the error rate. Default value: CALL_COUNT.', 'type' => 'string', 'required' => false, 'example' => 'CALL_COUNT'], + 'OrderType' => ['title' => '', 'description' => 'The sort order. Valid values: 1: ascending order. 2: descending order. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'Data' => [ - 'title' => '创建结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'SuccessCount' => [ - 'title' => '添加成功数目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'NotExistStandardIdList' => [ - 'title' => '不存在标准Id列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'ImpactList' => [ + 'title' => '', + 'description' => 'The list of API impact analysis results.', 'type' => 'array', 'items' => [ - 'title' => '不存在标准Id列表', + 'title' => '', 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1021', + 'type' => 'object', + 'properties' => [ + 'ClientFailCount' => ['title' => '', 'description' => 'The number of client failures.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalTimeCost' => ['title' => '', 'description' => 'The total time consumed by the API, including failed calls.', 'type' => 'string', 'example' => '231'], + 'SuccessTimeCost' => ['title' => '', 'description' => 'The total time consumed by successful calls.', 'type' => 'string', 'example' => '99'], + 'ErrorCount' => ['title' => '', 'description' => 'The number of errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ClientIp' => ['title' => '', 'description' => 'The source IP address of the access request.', 'type' => 'string', 'example' => '192.168.1.1'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'test'], + 'ErrorApiCount' => ['title' => '', 'description' => 'The number of abnormal API calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '88'], + 'LastCallTime' => ['title' => '', 'description' => 'The most recent call time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'Minute' => ['title' => '', 'description' => 'The gateway statistics time. Format: yyyy_MMdd_HHmm.', 'type' => 'string', 'example' => '2025_0611_1011'], + 'OfflineCount' => ['title' => '', 'description' => 'The number of offline instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppKey' => ['title' => '', 'description' => 'appKey', 'type' => 'integer', 'format' => 'int64', 'example' => '1101'], + 'CallCount' => ['title' => '', 'description' => 'The number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'ApiId' => ['title' => '', 'description' => 'apiNo', 'type' => 'integer', 'format' => 'int64', 'example' => '2011'], + 'ErrorRate' => ['title' => '', 'description' => 'The error rate.', 'type' => 'string', 'example' => '10.0'], + ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query the impact of abnormal data service API calls by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStandardMapping' => [ - 'summary' => '创建标准映射关系, 包括有效映射和无效映射。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataServiceApps' => [ + 'summary' => 'Queries the list of all applications under a data service tenant. All tenant members can perform this operation.'."\n" + .'Release version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'Query the list of all applications under the tenant.', 'type' => 'object', 'properties' => [ - 'AssetGuidList' => [ - 'title' => '资产guid列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '资产guid列表', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1121', - ], - 'required' => true, - ], - 'StandardId' => [ - 'title' => '标准Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'RelationType' => [ - 'title' => '映射关系类型: VALID 有效映射、INVALID 无效映射, 默认: VALID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VALID', - ], - 'InvalidMappingRelationOperationType' => [ - 'title' => '引入映射关系时针对无效映射的处理策略: SET_INVALID_TO_VALID 将无效映射置为有效映射、KEEP_INVALID_AND_SKIP 保留无效映射然后跳过, 默认：SET_INVALID_TO_VALID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SET_INVALID_TO_VALID', - ], + 'Keyword' => ['title' => '', 'description' => 'Application name search keyword.', 'type' => 'string', 'required' => false, 'example' => '营销看板'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + 'AppGroupId' => ['title' => '', 'description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '12345', 'required' => false], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ - 'title' => '创建结果', - 'description' => '', + 'title' => '', + 'description' => 'The list of all applications under the tenant.', 'type' => 'object', 'properties' => [ - 'SuccessCount' => [ - 'title' => '添加成功数目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'FailedGuidList' => [ - 'title' => '创建失败资产guid列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'AppList' => [ + 'title' => '', + 'description' => 'Application list.', 'type' => 'array', 'items' => [ - 'title' => '创建失败资产guid列表', + 'title' => '', 'description' => '', - 'type' => 'string', - 'example' => '1021', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '12345'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'Owner list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'example' => '12345'], + 'Name' => ['title' => '', 'description' => 'Username.', 'type' => 'string', 'example' => '张三'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'AppGroup' => ['title' => '', 'description' => 'Application group name.', 'type' => 'string', 'example' => '默认分组'], + 'IsMember' => ['title' => '', 'description' => 'Indicates whether the current user has joined the application.', 'type' => 'boolean', 'example' => ''], + 'AppName' => ['title' => '', 'description' => 'Application name.', 'type' => 'string', 'example' => '默认应用'], + ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Message\\": \\"internal error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TotalCount\\": 68,\\n \\"AppList\\": [\\n {\\n \\"AppId\\": 12345,\\n \\"OwnerList\\": [\\n {\\n \\"Id\\": \\"12345\\",\\n \\"Name\\": \\"张三\\"\\n }\\n ],\\n \\"AppGroup\\": \\"默认分组\\",\\n \\"IsMember\\": false,\\n \\"AppName\\": \\"默认应用\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query Data Service Application List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStandardLookupTable' => [ - 'summary' => '创建数据标准码表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataServiceAuthorizedApps' => [ + 'summary' => 'Queries the list of applications that the current user has permissions to access.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', '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' => '', - '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, - ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'AuthorizedAppList' => [ + 'title' => '', + 'description' => 'The paginated list of authorized applications.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['title' => '', 'description' => 'The ID of the owner.', 'type' => 'string', 'example' => '1121'], + 'RealHasOwnerPrivilege' => ['title' => '', 'description' => 'Indicates whether the user actually has owner permissions on this application. The user may lack permissions because of expiration or other reasons.', 'type' => 'boolean', 'example' => ''], + 'ExpireDate' => ['title' => '', 'description' => 'The expiration date in the format of yyyy-MM-dd.', 'type' => 'string', 'example' => '2025-06-30'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102122'], + 'RevocableDetail' => ['title' => '', 'description' => 'The detailed status of the revoke button. Valid values: -1: super administrators cannot revoke. -2: owners cannot revoke. -3: project administrators without actual permissions are grayed out. -4: regular users without permissions cannot revoke. 1: project administrators with actual permissions can revoke. 2: regular users with permissions can revoke.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'test'], + 'ApplyUserId' => [ + 'title' => '', + 'description' => 'The ID of the permission account, which is the applicant ID.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => '30012101', + ], + 'ApplyUserName' => ['title' => '', 'description' => 'The permission account, which is the applicant.', 'type' => 'string', 'example' => '测试'], + 'AppId' => ['title' => '', 'description' => 'The primary key ID of the application.', 'type' => 'integer', 'format' => 'int32', 'example' => '1022'], + 'RealHasPrivilege' => ['title' => '', 'description' => 'Indicates whether the user actually has permissions.', 'type' => 'boolean', 'example' => ''], + 'PrivilegeAccount' => ['title' => '', 'description' => 'The permission account. Valid values: 0: individual account.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'OwnerUserName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'IsProjectManager' => ['title' => '', 'description' => 'Indicates whether the current user is a project administrator.', 'type' => 'boolean', 'example' => ''], + 'Id' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1121'], + 'RemarkForDebugList' => [ + 'title' => '', + 'description' => 'The descriptions used for troubleshooting.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'v1'], + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'example' => 'k1'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Revocable' => ['title' => '', 'description' => 'Indicates whether the permissions can be returned or revoked.', 'type' => 'boolean', 'example' => ''], + 'PrivilegeType' => ['title' => '', 'description' => 'The permission type. Valid values: 0: usage permission. 1: development permission.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"AuthorizedAppList\\": [\\n {\\n \\"Owner\\": \\"1121\\",\\n \\"RealHasOwnerPrivilege\\": false,\\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\\": false,\\n \\"PrivilegeAccount\\": 0,\\n \\"OwnerUserName\\": \\"test\\",\\n \\"IsProjectManager\\": false,\\n \\"Id\\": 1121,\\n \\"RemarkForDebugList\\": [\\n {\\n \\"Value\\": \\"v1\\",\\n \\"Key\\": \\"k1\\"\\n }\\n ],\\n \\"Revocable\\": false,\\n \\"PrivilegeType\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query authorized data service applications by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateStandard' => [ - 'summary' => '创建标准。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataServiceMyApiPermissions' => [ + 'summary' => 'Obtain the list of API permissions managed by me.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'Search conditions.', 'type' => 'object', 'properties' => [ - 'EffectiveTimeConfig' => [ - 'title' => '生效时间配置', - 'description' => '', + 'Keyword' => ['title' => '', 'description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend response exception details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '生效时间类型: FOREVER 永久、TIME_PERIOD 时间段', - 'description' => '', - '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', + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'PermissionList' => [ + 'title' => '', + 'description' => 'Paginated permission list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '', 'description' => 'Role. Valid value: 0, which indicates the owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Owner' => ['title' => '', 'description' => 'Owner ID.', 'type' => 'string', 'example' => '1121'], + 'PrivilegeBelongTo' => ['title' => '', 'description' => 'The user to whom the privilege belongs.', 'type' => 'string', 'example' => '1121'], + 'ApiName' => ['title' => '', 'description' => 'API name.', 'type' => 'string', 'example' => 'teset'], + 'PrivilegeFrom' => ['title' => '', 'description' => 'Authorization source. Valid value: 0, which indicates the owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ProjectName' => ['title' => '', 'description' => 'Project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102122'], + 'OwnerUserName' => ['title' => '', 'description' => 'Owner name.', 'type' => 'string', 'example' => 'test'], + 'Creator' => ['title' => '', 'description' => 'Creator ID.', 'type' => 'string', 'example' => '1121'], + 'ApiId' => ['title' => '', 'description' => 'API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1322'], + 'CreateUserName' => ['title' => '', 'description' => 'Creator name.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', ], ], - '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'METADATA', - ], - 'MonitorFrom' => [ - 'title' => '添加方式：BY_USER 手动添加、BY_SYSTEM_ATTRIBUTE 系统属性预置', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_SYSTEM_ATTRIBUTE', - ], - 'AttributeId' => [ - 'title' => '关联的属性Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOMIZED', - ], - 'QualityRuleTemplate' => [ - 'title' => '规则模板, 当监控类型为 QUALITY 时必填', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '模板Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - 'Type' => [ - 'title' => '模板来源: FROM_SYSTEM 系统模板、CUSTOMIZED 自定义模板', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMIZED', - ], - ], - 'required' => false, - ], - 'RuleConfigList' => [ - 'title' => '规则配置, 当监控类型为 QUALITY 时必填', - '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, - ], - 'RuleValidateConfigList' => [ - 'title' => '规则校验配置, 当监控类型为 QUALITY 时必填', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '校验配置Id, 由业务随机生成且确保唯一', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], - 'ParentId' => [ - 'title' => '父校验配置Id, 父规则校验类型只能是RELATION', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Type' => [ - 'title' => '规则校验类型: RELATION 关系、EXPRESSION 表达式', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '如果校验类型是 EXPRESSION: EQUAL 等于、NOT_EQUAL 不等于、LARGER 大于、LARGE_OR_EQUAL 大于或等于、SMALLER 小于、SMALLER_OR_EQUAL 小于或等于; 如果校验类型是 RELATION: AND 且、OR 或', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AND', - ], - 'Metric' => [ - 'title' => '指标, 校验类型为 EXPRESSION 时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'MetricName' => [ - 'title' => '指标名称, 校验类型为 EXPRESSION 时必填', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query the Data Service API Permissions Managed by Me by Page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpsertQualityWatchAlert' => [ - 'summary' => '新建或者修改监控对象告警设置。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataServiceMyAppPermissions' => [ + 'summary' => 'Queries the applications that the current user has permissions to access.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpsertCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data service project.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更改指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30012011', - ], - 'Name' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'AlertDutyList' => [ - 'title' => '值班表告警列表', - 'description' => '', + 'Keyword' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'PermissionList' => [ + 'title' => '', + 'description' => 'The paginated permission list.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '报警值班表ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Name' => [ - 'title' => '报警值班表名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'Owner' => ['title' => '', 'description' => 'The ID of the owner.', 'type' => 'string', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '112101'], + 'Creator' => ['title' => '', 'description' => 'The ID of the creator.', 'type' => 'string', 'example' => '1121'], + 'CreateUserName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => 'test'], + 'AppName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'test'], + 'Role' => ['title' => '', 'description' => 'The role. Valid values:'."\n" + .'- 0: owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PrivilegeBelongTo' => ['title' => '', 'description' => 'The user to whom the permission belongs.', 'type' => 'string', 'example' => '1121'], + 'AppId' => ['title' => '', 'description' => 'AppId', 'type' => 'integer', 'format' => 'int32', 'example' => '1021'], + 'PrivilegeFrom' => ['title' => '', 'description' => 'The source of the authorization. Valid values:'."\n" + .'- 0: owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'OwnerUserName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'CurrentUserRole' => ['title' => '', 'description' => 'The role of the current logon user relative to this record. Valid values:'."\n" + .'- SuperAdmin: the current user is a super administrator.'."\n" + .'- ProjMan: the current user is a project administrator for this record.'."\n" + .'- NormalUser: the current user is a regular user for this record, meaning the user is neither a super administrator nor a project administrator.', 'type' => 'string', 'example' => 'NormalUser'], + 'RemarkForDebugList' => [ + 'title' => '', + 'description' => 'The description, used for troubleshooting.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'example' => 'v1'], + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'example' => 'k1'], + ], + 'example' => '', + ], + 'example' => '', ], ], - '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', + 'example' => '', ], - 'required' => false, + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], - 'required' => true, + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Query data service applications accessible to the current user by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListDataServicePublishedApis' => [ + 'summary' => 'Queries the list of published APIs by page.', + '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' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Search conditions.', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['title' => '', 'description' => 'Group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '102113'], + 'ApiName' => ['title' => '', 'description' => 'API name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'ApiList' => [ + 'title' => '', + 'description' => 'Paginated API list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '', 'description' => 'API group name.', 'type' => 'string', 'example' => 'test'], + 'GroupId' => ['title' => '', 'description' => 'Group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102131'], + 'ApiId' => ['title' => '', 'description' => 'API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1022'], + 'ApiName' => ['title' => '', 'description' => 'API name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'API description.', 'type' => 'string', 'example' => 'test xx'], + 'OwnerUserName' => ['title' => '', 'description' => 'Owner name.', 'type' => 'string', 'example' => '张三'], + 'Owner' => ['title' => '', 'description' => 'Owner ID.', 'type' => 'string', 'example' => '30012011'], + 'DeployTime' => ['title' => '', 'description' => 'Publish time. Time format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'UpdateRate' => ['title' => '', 'description' => 'Update frequency. Valid values: 0 (custom), 1 (daily), 2 (hourly), 3 (per minute).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CustomUpdateRate' => ['title' => '', 'description' => 'Custom update frequency content.', 'type' => 'string', 'example' => '0 0 0/1 * * *'], + 'AppCount' => ['title' => '', 'description' => 'Number of bound applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AppInfoList' => [ + 'title' => '', + 'description' => 'List of referenced application information.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '10211'], + 'AppName' => ['title' => '', 'description' => 'Application name.', 'type' => 'string', 'example' => 'test'], + 'AppKey' => ['title' => '', 'description' => 'Application key.'."\n" + .'>Deprecated. Use AppKeyStr instead.>', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '200000000'], + 'AppKeyStr' => ['title' => '', 'description' => 'Application key.', 'type' => 'string', 'example' => 'APP_200000000'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'CallCount' => ['title' => '', 'description' => 'Number of calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '21'], + 'LogicUnitNo' => ['title' => '', 'description' => 'Service unit number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1022'], + 'Mode' => ['title' => '', 'description' => 'Mode. Valid values: 0 (basic), 1 (dev_prod).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ApplyStatus' => ['title' => '', 'description' => 'Application status. Valid values: 0 (not all applied), 1 (applied), 2 (no app, need to apply for an app first).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UpdateTime' => ['title' => '', 'description' => 'Modification time. Time format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'CreateType' => ['title' => '', 'description' => 'Creation type. Valid values: 0 (custom mode), 1 (wizard mode), 2 (direct connection API).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExecuteMode' => ['title' => '', 'description' => 'Call type. Valid values: 1 (synchronous), 2 (asynchronous).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProjectId' => ['title' => '', 'description' => 'Data service project ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '102101'], + 'ProjectName' => ['title' => '', 'description' => 'Service project name.', 'type' => 'string', 'example' => 'test'], + 'Version' => ['title' => '', 'description' => 'API version.', 'type' => 'string', 'example' => '1.0'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"PageResult\\": {\\n \\"TotalCount\\": 68,\\n \\"ApiList\\": [\\n {\\n \\"GroupName\\": \\"test\\",\\n \\"GroupId\\": 102131,\\n \\"ApiId\\": 1022,\\n \\"ApiName\\": \\"test\\",\\n \\"Description\\": \\"test xx\\",\\n \\"OwnerUserName\\": \\"张三\\",\\n \\"Owner\\": \\"30012011\\",\\n \\"DeployTime\\": \\"2025-06-30 08:00:00\\",\\n \\"UpdateRate\\": 1,\\n \\"CustomUpdateRate\\": \\"0 0 0/1 * * *\\",\\n \\"AppCount\\": 1,\\n \\"AppInfoList\\": [\\n {\\n \\"AppId\\": 10211,\\n \\"AppName\\": \\"test\\",\\n \\"AppKey\\": 200000000,\\n \\"AppKeyStr\\": \\"APP_200000000\\"\\n }\\n ],\\n \\"CallCount\\": 21,\\n \\"LogicUnitNo\\": 1022,\\n \\"Mode\\": 1,\\n \\"ApplyStatus\\": 1,\\n \\"UpdateTime\\": \\"2025-06-30 08:00:00\\",\\n \\"CreateType\\": 1,\\n \\"ExecuteMode\\": 1,\\n \\"ProjectId\\": 102101,\\n \\"ProjectName\\": \\"test\\",\\n \\"Version\\": \\"1.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query the list of published APIs by page in data service', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Response parameters changed'], ], - '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"}]', - ], - 'UpsertQualityWatch' => [ - 'summary' => '新建或更改质量监控对象, 支持添加多种类型的质量监控对象，包括：Dataphin表，全域表，数据源，指标，实时元表。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ramActions' => [], + ], + 'ListDataSourceWithConfig' => [ + 'summary' => 'Search for data sources. The results include data source configuration items.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpsertCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更改指令', - 'description' => '', + 'title' => '', + 'description' => 'Paginated query', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '监控对象ID: 传递了代表更新,不传递代表新建', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'Name' => ['title' => '', 'description' => 'Data source name', 'type' => 'string', 'required' => false, 'example' => 'vcns-test'], + 'TypeList' => [ + 'title' => '', + 'description' => 'Data source type', + 'type' => 'array', + 'items' => ['description' => 'Data source type', 'type' => 'string', 'example' => 'MAX_COMPUTE', 'required' => false, 'title' => ''], 'required' => false, - 'example' => '1', - ], - 'Type' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表、DATASOURCE 数据源、INDEX 指标、REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TABLE', + 'example' => '', ], - 'DataSourceInfo' => [ - 'title' => '数据源详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], + 'ScopeList' => [ + 'title' => '', + 'description' => 'Data source scope. Valid values:'."\n" + .'- STREAMING: Real-time'."\n" + .'- OFFLINE: Offline'."\n" + .'- DIP_META_SYNC: Meta warehouse initialization'."\n" + .'- DATA_DISTILL: Data distillation'."\n" + .'- CUMPUTE_SOURCE_SHADOW: Shadow compute source'."\n" + .'- LABEL: Label'."\n" + .'- ALL: Offline + Real-time', + 'type' => 'array', + 'items' => ['description' => 'Data source scope', 'type' => 'string', 'example' => 'ALL', 'required' => false, 'title' => ''], 'required' => false, + 'example' => '', ], - 'TableInfo' => [ - 'title' => '监控表对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '表Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], + 'OwnerList' => [ + 'title' => '', + 'description' => 'Data source owner', + 'type' => 'array', + 'items' => ['description' => 'User ID', 'type' => 'string', 'required' => false, 'example' => '2323131', 'title' => ''], 'required' => false, + 'example' => '', ], - 'IndexInfo' => [ - 'title' => '监控指标对象', - 'description' => '', + 'Tag' => ['title' => '', 'description' => 'Tag marked when creating the data source', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Page' => ['title' => '', 'description' => 'Page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'default' => '1', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'default' => '20', 'example' => '20'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'description' => 'Query result.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '指标Id：', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '18755764', - ], - 'GranularityDisplayName' => [ - 'title' => '统计粒度名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '全站汇总表', - ], - 'ComputeType' => [ - 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AUTO', - ], - 'CellSumLogicTableName' => [ - 'title' => '单元汇总表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dws_all', - ], - 'Type' => [ - 'title' => '指标类型：INDEX', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INDEX', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1121', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1121', - ], - 'DateType' => [ - 'title' => '指标数据类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', + 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '39', 'title' => ''], + 'DataSourceList' => [ + 'description' => 'Paginated list', + 'type' => 'array', + 'items' => [ + 'description' => 'Data source', + 'type' => 'object', + 'properties' => [ + 'ProdDataSourceInfo' => [ + 'description' => 'Production environment data source', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Data source ID', 'type' => 'integer', 'format' => 'int64', 'example' => '300000028799'], + 'Name' => ['title' => '', 'description' => 'Data source name', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'Data source type', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Scope' => ['title' => '', 'description' => 'Data source scope', 'type' => 'string', 'required' => false, 'example' => 'ALL'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1708303959000'], + 'ModifyTime' => ['title' => '', 'description' => 'Modification time', 'type' => 'integer', 'format' => 'int64', 'example' => '1708303959000'], + 'Creator' => ['title' => '', 'description' => 'Creator ID', 'type' => 'string', 'example' => '212211111'], + 'CreatorName' => ['title' => '', 'description' => 'Creator name', 'type' => 'string', 'example' => '张三'], + 'Owner' => ['title' => '', 'description' => 'Owner ID', 'type' => 'string', 'example' => '212211111'], + 'OwnerName' => ['title' => '', 'description' => 'Owner name', 'type' => 'string', 'example' => '张三'], + 'Description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'xx 测试'], + 'Env' => ['title' => '', 'description' => 'Environment of the data source', 'type' => 'string', 'example' => 'PROD'], + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'Connection configuration items', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Connection configuration item', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Configuration item ID', 'type' => 'string', 'example' => 'param1'], + 'Value' => ['title' => '', 'description' => 'Configuration item value', 'type' => 'string', 'example' => 'value1'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'DevDataSourceInfo' => [ + 'description' => 'Development environment data source', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Data source ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12313123131'], + 'Name' => ['title' => '', 'description' => 'Data source name', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'Data source type', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Scope' => ['title' => '', 'description' => 'Data source scope', 'type' => 'string', 'required' => false, 'example' => 'ALL'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1710209552704'], + 'ModifyTime' => ['title' => '', 'description' => 'Modification time', 'type' => 'integer', 'format' => 'int64', 'example' => '1710209552704'], + 'Creator' => ['title' => '', 'description' => 'Creator ID', 'type' => 'string', 'example' => '212211111'], + 'CreatorName' => ['title' => '', 'description' => 'Creator name', 'type' => 'string', 'example' => '张三'], + 'Owner' => ['title' => '', 'description' => 'Owner ID', 'type' => 'string', 'example' => '212211111'], + 'OwnerName' => ['title' => '', 'description' => 'Owner name', 'type' => 'string', 'example' => '张三'], + 'Description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'example' => 'xx 项目'], + 'Env' => ['title' => '', 'description' => 'Environment of the data source', 'type' => 'string', 'example' => 'DEV'], + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'Connection configuration items', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Connection configuration item', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Configuration item ID', 'type' => 'string', 'example' => 'param1'], + 'Value' => ['title' => '', 'description' => 'Configuration item value', 'type' => 'string', 'example' => 'value1'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query data source list', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpsertQualityTemplate' => [ - 'summary' => '新建或者修改质量模板。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListDataSourceWithConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDatasets' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -38110,1669 +27347,1735 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpsertCommand', + 'name' => 'DatasetQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更改指令', - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '模板ID: 传递了代表更新,不传递代表新建', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'Description' => [ - 'title' => '模板描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '模板负责人ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30012011', - ], - 'Catalog' => [ - 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CONSISTENT', - ], - 'SupportDataSourceTypeList' => [ - 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - 'required' => false, - ], - 'FormPropertyList' => [ - 'title' => '规则配置键值对', - 'description' => '', + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30001011'], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7273382541481536', 'title' => ''], + 'Keyword' => ['title' => '', 'description' => 'The keyword.', 'type' => 'string', 'required' => false, 'example' => 'rds'], + 'TypeList' => [ + 'title' => '', + 'description' => 'The dataset type. If left empty, all types are queried.', '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, - ], + 'items' => ['description' => 'The type list.', 'type' => 'string', 'required' => false, 'example' => '[\\"APPLICATION\\",\\"AUDIO\\"]', 'title' => ''], 'required' => false, + 'example' => '', ], + 'StorageType' => ['title' => '', 'description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'OSS'], + 'ContentType' => ['title' => '', 'description' => 'The content type.', 'type' => 'string', 'required' => false, 'example' => 'GENERAL'], + 'DataUnit' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'string', 'required' => false, 'example' => '74280'], + 'Owner' => ['title' => '', 'description' => 'The owner ID.', 'type' => 'string', 'required' => false, 'example' => '300001391'], + 'Scenario' => ['title' => '', 'description' => 'The dataset scenario. Valid values:'."\n" + .'- OFFLINE: offline.'."\n" + .'- REALTIME: real-time.', 'type' => 'string', 'required' => false, 'example' => 'OFFLINE'], + 'IncludeVersionList' => ['title' => '', 'description' => 'Specifies whether to include version details. Default value: FALSE.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The backend response code is `OK`.', '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' => '', - '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' => '', - '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"}]', - ], - 'UpsertQualitySchedule' => [ - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'UpsertCommand', - 'in' => 'formData', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged result.', + 'type' => 'object', + 'properties' => [ + 'ResultData' => [ + 'title' => '', + 'description' => 'The object.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The dataset ID (business primary key).', 'type' => 'integer', 'format' => 'int64', 'example' => '7128268454335680'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7290731813137728'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'ds_tm'], + 'Name' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'audio_dataset'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7285340579984832'], + 'Directory' => ['title' => '', 'description' => 'The directory (retrieved from the file service by fileId).', 'type' => 'string', 'example' => '/'], + 'DataCellId' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'string', 'example' => '74280'], + 'DataCellName' => ['title' => '', 'description' => '**The data domain name.**', 'type' => 'string', 'example' => '离线数据主题域'], + 'Type' => ['title' => '', 'description' => '**The dataset type.**', 'type' => 'string', 'example' => 'HYBRID'], + 'StorageType' => ['title' => '', 'description' => '**The storage type.**', 'type' => 'string', 'example' => 'OSS'], + 'MetadataStorageType' => ['title' => '', 'description' => '**The metastore type.**', 'type' => 'string', 'example' => 'POSTGRESQL'], + 'Scenario' => ['title' => '', 'description' => 'The dataset scenarios. Valid values:'."\n" + .'- OFFLINE: offline (default).'."\n" + .'- REALTIME: real-time.', 'type' => 'string', 'example' => 'OFFLINE'], + 'ContentType' => ['title' => '', 'description' => 'The content type.', 'type' => 'string', 'example' => 'GENERAL'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The owner list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '300001391', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The creator ID.', 'type' => 'string', 'example' => '300001391'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2026-05-18 17:07:54.237771'], + 'GmtModified' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2026-05-18 17:07:54.237771'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试数据集'], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '300001413'], + 'VersionList' => [ + 'title' => '', + 'description' => 'The version list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7280840713415040'], + 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7280832407583104'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'example' => 'V4'], + 'DataVersionConfig' => [ + 'title' => '', + 'description' => 'The dataset version configuration.', + 'type' => 'object', + 'properties' => [ + 'VersionDescription' => ['title' => '', 'description' => 'The version description.', 'type' => 'string', 'example' => '测试数据集版本'], + 'FileStorageConfig' => [ + 'title' => '', + 'description' => 'The file storage configuration.', + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7445343860022804608'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '测试数据源'], + 'DevPath' => ['title' => '', 'description' => 'The development path (not required for basic projects).', 'type' => 'string', 'example' => 'HTML正文提取/test423/'], + 'ProdPath' => ['title' => '', 'description' => 'The production path.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'MountPath' => ['title' => '', 'description' => 'The mount path.', 'type' => 'string', 'required' => true, 'example' => '/var/run/openresty/cache/corp'], + ], + 'example' => '', + ], + 'MetadataStorageConfig' => [ + 'title' => '', + 'description' => 'The metastore configuration.', + 'type' => 'object', + 'properties' => [ + 'MetadataStorageMode' => ['title' => '', 'description' => 'The storage destination (new table or existing table).', 'type' => 'string', 'required' => true, 'example' => 'CREATE'], + 'MetadataStorageType' => ['title' => '', 'description' => 'The metastore type.', 'type' => 'string', 'example' => 'MILVUS'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => true, 'example' => '7445343860022804608'], + 'DataSourceName' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '测试数据源'], + 'DevSchema' => ['title' => '', 'description' => 'The development database/schema.', 'type' => 'string', 'example' => 'HTML正文提取/test423/'], + 'ProdSchema' => ['title' => '', 'description' => 'The production database/schema.', 'type' => 'string', 'required' => true, 'example' => 'HTML正文提取/test423/'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 's_crm_all_plt_jala_shop'], + 'TableSchema' => [ + 'title' => '', + 'description' => 'The table schema configuration.', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The field list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'id'], + 'Type' => ['title' => '', 'description' => 'The field type.', 'type' => 'string', 'required' => true, 'example' => 'int8'], + 'ElementType' => ['title' => '', 'description' => 'The array element subtype. This parameter takes effect only when type is set to ARRAY.', 'type' => 'string', 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => 'The maximum array capacity. This parameter takes effect only when type is set to ARRAY. Default value: 4096.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Pk' => ['title' => '', 'description' => 'Indicates whether the field is a primary key.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'Comment' => ['title' => '', 'description' => 'The field description.', 'type' => 'string', 'example' => '主键'], + 'Url' => ['title' => '', 'description' => 'Indicates whether the field is a URL.', 'type' => 'boolean', 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'MultiModal-Embedding'], + 'Dimension' => ['title' => '', 'description' => 'The embedding dimension.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance:mongodb'], + 'IndexType' => ['title' => '', 'description' => 'The index type. PG supports IVFFlat and HNSW. Milvus supports all index types.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type. Default value: COSINE. Valid values: COSINE, L2, and IP.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters.', 'type' => 'object', 'example' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'RealtimeMetaTableConfig' => [ + 'title' => '', + 'description' => 'The real-time meta table configuration (takes effect only when `metadataStorageType=REALTIME_META_TABLE`).', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID of the meta table (cross-project access is supported).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7128268454335680'], + 'MetaTableName' => ['title' => '', 'description' => 'The meta table name.', 'type' => 'string', 'required' => true, 'example' => '测试元表'], + 'DatasourceType' => ['title' => '', 'description' => 'The meta table data source type (only KAFKA is available in this release).', 'type' => 'string', 'required' => true, 'example' => 'KAFKA'], + 'TableSchema' => [ + 'title' => '', + 'description' => 'The table schema configuration (reuses `MetadataStorageConfigDTO.TableSchemaDTO`).', + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'title' => '', + 'description' => 'The field list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => '**The field name.**', 'type' => 'string', 'required' => true, 'example' => 'happen_time'], + 'Type' => ['title' => '', 'description' => '**The field type.**', 'type' => 'string', 'required' => true, 'example' => 'date'], + 'ElementType' => ['title' => '', 'description' => '**The array element subtype. This parameter takes effect only when type is set to ARRAY.**', 'type' => 'string', 'example' => 'INT64'], + 'MaxCapacity' => ['title' => '', 'description' => '**The maximum array capacity. This parameter takes effect only when type is set to ARRAY. Default value: 4096.**', 'type' => 'integer', 'format' => 'int32', 'example' => '35'], + 'Pk' => ['title' => '', 'description' => 'Indicates whether the field is a primary key.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'Comment' => ['title' => '', 'description' => '**The field description.**', 'type' => 'string', 'example' => '录入时间'], + 'Url' => ['title' => '', 'description' => 'Indicates whether the field is a URL.', 'type' => 'boolean', 'example' => 'false'], + 'VectorIndexConfig' => [ + 'title' => '', + 'description' => 'The vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['title' => '', 'description' => 'The embedding model.', 'type' => 'string', 'required' => true, 'example' => 'multimodal-embedding-v1'], + 'Dimension' => ['title' => '', 'description' => 'The embedding dimension.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'instance'], + 'IndexType' => ['title' => '', 'description' => 'The index type. PG supports IVFFlat and HNSW. Milvus supports all index types.', 'type' => 'string', 'required' => true, 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['title' => '', 'description' => 'The similarity type. Default value: COSINE. Valid values: COSINE, L2, and IP.', 'type' => 'string', 'required' => true, 'example' => 'COSINE'], + 'IndexParams' => ['title' => '', 'description' => 'The index build parameters.', 'type' => 'object', 'example' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Creator' => ['title' => '', 'description' => 'The creator ID.', 'type' => 'string', 'example' => '300001391'], + 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'format' => 'date-time', 'example' => '2026-04-28 10:03:49'], + 'GmtModified' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'format' => 'date-time', 'example' => '1749450490000'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'LockOwner' => ['title' => '', 'description' => 'The development owner ID.', 'type' => 'string', 'example' => '300001391'], + 'LockOwnerName' => ['title' => '', 'description' => 'The name of the development owner (interface Displayed Fields).', 'type' => 'string', 'example' => '张三'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Count' => ['title' => '', 'description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List datasets', + 'summary' => 'Lists datasets in a project based on specified conditional query criteria. Online version: v6.2.0.', + 'description' => '## Operation description'."\n" + ."\n" + .'This API allows you to retrieve dataset information for a specific project by providing a tenant ID, project ID, and other optional parameters such as keywords and type lists. Paging is supported. The returned data includes basic dataset information and version details. ProjectId is required. Other parameters are optional and can be configured as needed to filter results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + '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 \\"ResultData\\": [\\n {\\n \\"Id\\": 7128268454335680,\\n \\"ProjectId\\": 7290731813137728,\\n \\"ProjectName\\": \\"ds_tm\\",\\n \\"Name\\": \\"audio_dataset\\",\\n \\"FileId\\": 7285340579984832,\\n \\"Directory\\": \\"/\\",\\n \\"DataCellId\\": \\"74280\\",\\n \\"DataCellName\\": \\"离线数据主题域\\",\\n \\"Type\\": \\"HYBRID\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"MetadataStorageType\\": \\"POSTGRESQL\\",\\n \\"Scenario\\": \\"OFFLINE\\",\\n \\"ContentType\\": \\"GENERAL\\",\\n \\"OwnerList\\": [\\n {\\n \\"UserId\\": \\"300001391\\",\\n \\"UserName\\": \\"张三\\"\\n }\\n ],\\n \\"Creator\\": \\"300001391\\",\\n \\"CreatorName\\": \\"张三\\",\\n \\"GmtCreate\\": \\"2026-05-18 17:07:54.237771\\",\\n \\"GmtModified\\": \\"2026-05-18 17:07:54.237771\\",\\n \\"Description\\": \\"测试数据集\\",\\n \\"TenantId\\": 300001413,\\n \\"VersionList\\": [\\n {\\n \\"Id\\": 7280840713415040,\\n \\"DatasetId\\": 7280832407583104,\\n \\"Version\\": \\"V4\\",\\n \\"DataVersionConfig\\": {\\n \\"VersionDescription\\": \\"测试数据集版本\\",\\n \\"FileStorageConfig\\": {\\n \\"DataSourceId\\": \\"7445343860022804608\\",\\n \\"DataSourceName\\": \\"测试数据源\\",\\n \\"DevPath\\": \\"HTML正文提取/test423/\\",\\n \\"ProdPath\\": \\"HTML正文提取/test423/\\",\\n \\"MountPath\\": \\"/var/run/openresty/cache/corp\\"\\n },\\n \\"MetadataStorageConfig\\": {\\n \\"MetadataStorageMode\\": \\"CREATE\\",\\n \\"MetadataStorageType\\": \\"MILVUS\\",\\n \\"DataSourceId\\": \\"7445343860022804608\\",\\n \\"DataSourceName\\": \\"测试数据源\\",\\n \\"DevSchema\\": \\"HTML正文提取/test423/\\",\\n \\"ProdSchema\\": \\"HTML正文提取/test423/\\",\\n \\"TableName\\": \\"s_crm_all_plt_jala_shop\\",\\n \\"TableSchema\\": {\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"id\\",\\n \\"Type\\": \\"int8\\",\\n \\"ElementType\\": \\"INT64\\",\\n \\"MaxCapacity\\": 20,\\n \\"Pk\\": true,\\n \\"Comment\\": \\"主键\\",\\n \\"Url\\": false,\\n \\"VectorIndexConfig\\": {\\n \\"EmbeddingModel\\": \\"MultiModal-Embedding\\",\\n \\"Dimension\\": 0,\\n \\"IndexType\\": \\"AUTOINDEX\\",\\n \\"SimilarityType\\": \\"COSINE\\",\\n \\"IndexParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n }\\n },\\n \\"RealtimeMetaTableConfig\\": {\\n \\"ProjectId\\": 7128268454335680,\\n \\"MetaTableName\\": \\"测试元表\\",\\n \\"DatasourceType\\": \\"KAFKA\\",\\n \\"TableSchema\\": {\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"happen_time\\",\\n \\"Type\\": \\"date\\",\\n \\"ElementType\\": \\"INT64\\",\\n \\"MaxCapacity\\": 35,\\n \\"Pk\\": false,\\n \\"Comment\\": \\"录入时间\\",\\n \\"Url\\": false,\\n \\"VectorIndexConfig\\": {\\n \\"EmbeddingModel\\": \\"multimodal-embedding-v1\\",\\n \\"Dimension\\": 0,\\n \\"IndexType\\": \\"AUTOINDEX\\",\\n \\"SimilarityType\\": \\"COSINE\\",\\n \\"IndexParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"Creator\\": \\"300001391\\",\\n \\"GmtCreate\\": \\"2026-04-28 10:03:49\\",\\n \\"GmtModified\\": \\"1749450490000\\"\\n }\\n ],\\n \\"LockOwner\\": \\"300001391\\",\\n \\"LockOwnerName\\": \\"张三\\"\\n }\\n ],\\n \\"Count\\": 12\\n }\\n}","type":"json"}]', + ], + 'ListFiles' => [ + 'summary' => 'Query the directory tree file list.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更改指令', - 'description' => '', + 'title' => '', + 'description' => 'Query conditions', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '调度对象ID: 传递代表更新,不传递代表新建', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'WatchId' => [ - 'title' => '监控对象Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PERIOD_SCHEDULE', - ], - 'PartitionType' => [ - 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ONE_TASKS_FINISHED', - ], - 'TriggerType' => [ - 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'STATIC_TASK_TRIGGER', - ], - 'PeriodScheduleIntervalType' => [ - 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '* * 1/* * * *', - ], - 'ValidatePartitionType' => [ - 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TASK_REFERRED_PARTITION', - ], + 'ProjectId' => ['title' => '', 'description' => 'Project ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11112311'], + 'Category' => ['title' => '', 'description' => 'Menu tree category'."\n" + .'- Ad hoc query: tempCode'."\n" + .'- Code task: codeManage'."\n" + .'- Offline pipeline: offlinePipeline'."\n" + .'- Pipeline custom component: offlinePipelineCustomPlugin'."\n" + .'- Sync task: dataX'."\n" + .'- Real-time meta table: streamMeta'."\n" + .'- Real-time custom source: streamCustomDataSource'."\n" + .'- Real-time computing template: streamTemplate'."\n" + .'- Resource management: resourceManage'."\n" + .'- Offline function: udfResource'."\n" + .'- Real-time function: streamFunction', 'type' => 'string', 'required' => true, 'example' => 'tempCode'], + 'Recursive' => ['title' => '', 'description' => 'Whether to recursively traverse and query'."\n" + .'- true: Yes, returns all nodes under the directory'."\n" + .'- false: No, returns only the first-level nodes under the directory', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'Directory' => ['title' => '', 'description' => 'File directory', 'type' => 'string', 'required' => true, 'example' => '/xx/x'], + 'Env' => ['title' => '', 'description' => 'Environment identifier'."\n" + .'- DEV'."\n" + .'- PROD', 'type' => 'string', 'required' => true, 'example' => 'DEV'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'Backend response HTTP code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Request error code. OK indicates a normal request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Request error message', 'type' => 'string', 'example' => 'successful'], + 'FileList' => [ + 'title' => '', + 'description' => 'File list', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'File', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'File ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111231112'], + 'Name' => ['title' => '', 'description' => 'File name', 'type' => 'string', 'example' => 'xx测试'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID', 'type' => 'integer', 'format' => 'int64', 'example' => '312112121'], + 'Category' => ['title' => '', 'description' => 'File category', 'type' => 'string', 'example' => 'tempCode'], + 'FileType' => ['title' => '', 'description' => 'File type, such as directory', 'type' => 'string', 'example' => 'directory'], + 'Directory' => ['title' => '', 'description' => 'File directory', 'type' => 'string', 'example' => '/xx/x'], + 'Content' => ['title' => '', 'description' => 'File content', 'type' => 'string', 'example' => 'select 1;'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1717483193830'], + 'GmtModified' => ['title' => '', 'description' => 'Modification time', 'type' => 'integer', 'format' => 'int64', 'example' => '1717483193830'], + 'Creator' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '1212111'], + 'LastModifier' => ['title' => '', 'description' => 'Last modifier', 'type' => 'string', 'example' => '1212111'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query File List', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpsertQualityRule' => [ - 'summary' => '新建或者修改质量规则。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListInstances' => [ + 'summary' => 'Paginate and query instances.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpsertCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更改指令', - 'description' => '', + 'title' => '', + 'description' => 'Query Request', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '规则ID，非空时代表修改，为空时代表新建', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'NodeId' => ['description' => 'Node ID', 'type' => 'string', 'required' => false, 'example' => 'n_23131', 'title' => ''], + 'RunStatusList' => [ + 'title' => '', + 'description' => 'Running status'."\n" + .'- INIT: Initialized'."\n" + .'- WAIT_SUBMISSION: Waiting for Submission'."\n" + .'- WAIT_SCHEDULE: Waiting for Schedule Time'."\n" + .'- DISPATCH_BLOCKED: Throttled'."\n" + .'- WAIT_RESOURCE: Waiting for Scheduling Resources'."\n" + .'- RUNNING: Running'."\n" + .'- SUCCESS: Succeeded'."\n" + .'- FAILED: Failed', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Running status', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, - 'example' => '11', - ], - 'Name' => [ - 'title' => '质量规则名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'example' => '', ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', + 'MinBizDate' => ['title' => '', 'description' => 'Start business date and time. The time format must conform to the partition format specified by the business unit.', 'type' => 'string', 'required' => false, 'example' => '2024-05-30'], + 'MaxBizDate' => ['title' => '', 'description' => 'End business date and time. The time format must conform to the partition format specified by the business unit.', 'type' => 'string', 'required' => false, 'example' => '2024-05-31'], + 'BizType' => ['title' => '', 'description' => 'Business Type'."\n" + ."\n" + .'- SCRIPT: Script Instance'."\n" + .'- LOGICAL_TABLE: Logical Table', 'type' => 'string', 'required' => false, 'example' => 'SCRIPT'], + 'SubBizTypeList' => [ + 'title' => '', + 'description' => 'Sub-business Type'."\n" + .'- MAX_COMPUTE_SQL'."\n" + .'- HIVE_SQL'."\n" + .'- SHELL'."\n" + .'- PYTHON'."\n" + .'- ONE_SERVICE_SQL'."\n" + .'- DATABASE_SQL', + 'type' => 'array', + 'items' => ['description' => 'Sub-business Type', 'type' => 'string', 'required' => false, 'example' => 'SHELL', 'title' => ''], 'required' => false, - 'example' => 'test', - ], - 'Strength' => [ - 'title' => '规则强弱: STRONG、WEAK', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'STRONG', + 'example' => '', ], - 'CatalogList' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'Schedule Period'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY', 'type' => 'array', - 'items' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'WatchId' => [ - 'title' => '所属监控ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'EnableErrorArchive' => [ - 'title' => '是否启动异常归档', - 'description' => '', - 'type' => 'boolean', + 'items' => ['description' => 'Schedule Period', 'type' => 'string', 'required' => false, 'example' => 'DAILY', 'title' => ''], 'required' => false, + 'example' => '', ], - 'ValidateConditionList' => [ - 'title' => '校验条件', - 'description' => '', + 'OwnerList' => [ + 'title' => '', + 'description' => 'Node Owner', 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '条件节点id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '268', - ], - 'Type' => [ - 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], + 'items' => ['title' => '', 'description' => 'Owner', 'type' => 'string', 'required' => false, 'example' => '123131'], 'required' => false, + 'example' => '', ], - 'FormPropertyList' => [ - 'title' => '规则配置键值对, 与模板类型相关：不同模板类型返回不同的表单键值对配置', - 'description' => '', + 'PriorityList' => [ + 'title' => '', + 'description' => 'Priority'."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST', '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, - ], + 'items' => ['description' => 'Priority', 'type' => 'string', 'required' => false, 'example' => 'MIDDLE', 'title' => ''], 'required' => false, + 'example' => '', ], - 'AttributeWithValueList' => [ - 'title' => '规则业务属性配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeInfo' => [ - 'title' => '属性详情', - 'description' => '', + 'SchedulePaused' => ['title' => '', 'description' => 'Whether scheduling is paused', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'MinRunDate' => ['title' => '', 'description' => 'Minimum instance run time', 'type' => 'string', 'required' => false, 'example' => '2024-05-30'], + 'MaxRunDate' => ['title' => '', 'description' => 'Maximum instance run time', 'type' => 'string', 'required' => false, 'example' => '2024-05-31'], + 'ScheduleType' => ['title' => '', 'description' => 'Instance schedule type'."\n" + .'- NORMAL (Periodic Instance)'."\n" + .'- MANUAL (Manual Instance)', 'type' => 'string', 'required' => true, 'example' => 'NORMAL'], + 'SearchText' => ['title' => '', 'description' => 'Fuzzy match by node name or exact match by node ID', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131311111321'], + 'Page' => ['title' => '', 'description' => 'Page Number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page Size', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + 'BizUnitId' => ['title' => '', 'description' => 'Business unit ID. Required when querying summary logical tables.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6232322111'], + 'FlowId' => ['title' => '', 'description' => 'Workflow ID', 'type' => 'string', 'required' => false, 'example' => '1021'], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Environment identifier'."\n" + .'- DEV: Development environment'."\n" + .'- PROD (default): Production environment', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response Result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'Backend response HTTP code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Request error code. OK indicates a normal request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Request error message', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'description' => 'Paginated result', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '107', 'title' => ''], + 'Data' => [ + 'description' => 'Paginated records', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '属性Id', - 'description' => '', - '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, + 'Id' => ['title' => '', 'description' => 'Instance ID', 'type' => 'string', 'example' => 't_23231'], + 'BizDate' => ['title' => '', 'description' => 'Business Date', 'type' => 'string', 'example' => '2024-05-30'], + 'DueTime' => ['title' => '', 'description' => 'Schedule Time', 'type' => 'string', 'example' => '2024-05-30 16:47:13'], + 'StatusList' => [ + 'title' => '', + 'description' => 'Instance Status', + 'type' => 'array', + 'items' => ['description' => 'Instance Status', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'example' => '', ], - 'ValueConfig' => [ - 'title' => '属性值配置详情', - 'description' => '', + 'StartExecuteTime' => ['title' => '', 'description' => 'Execution start time', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-05-30 16:46:13'], + 'EndExecuteTime' => ['title' => '', 'description' => 'Execution End Time', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-05-30 16:47:13'."\n"], + 'Duration' => ['title' => '', 'description' => 'Running duration, in seconds', 'type' => 'string', 'example' => '60s'], + 'Index' => ['title' => '', 'description' => 'Hourly/Minutely instance sequence number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'Node Details', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '属性值填写方式: CUSTOMIZED 自定义输入,SINGLE_ENUM 下拉单选框,MULTIPLE_ENUMS 下拉多选框, RANGE 范围区间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'STRING', + 'Id' => ['title' => '', 'description' => 'Node ID', 'type' => 'string', 'example' => 'n_132331'], + 'From' => ['title' => '', 'description' => 'Node Source', 'type' => 'string', 'example' => 'DATA_PROCES'], + 'Type' => ['title' => '', 'description' => 'Node Business Type'."\n" + .'- SCRIPT: Script'."\n" + .'- LOGICAL_TABLE: Logical Table', 'type' => 'string', 'example' => 'DATA_PROCES'], + 'Name' => ['title' => '', 'description' => 'Node Name', 'type' => 'string', 'example' => 'xx测试'."\n"], + 'SubDetailType' => ['title' => '', 'description' => 'Sub-business Type'."\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' => 'Node Description', 'type' => 'string', 'example' => 'xx 测试'], + 'DryRun' => ['title' => '', 'description' => 'Whether to dry run', 'type' => 'boolean', 'example' => 'false'], + 'SchedulePaused' => ['title' => '', 'description' => 'Whether scheduling is paused', 'type' => 'boolean', 'example' => 'false'], + 'HasProd' => ['title' => '', 'description' => 'Whether a production environment exists', 'type' => 'boolean', 'example' => 'true'], + 'HasDev' => ['title' => '', 'description' => 'Whether a development environment exists', 'type' => 'boolean', 'example' => 'false'], + 'PriorityList' => [ + 'description' => 'Priority'."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST', + 'type' => 'array', + 'items' => ['description' => 'Priority', 'type' => 'string', 'example' => 'MIDDLE', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Length' => [ - 'title' => '属性字段长度, 可对文本型的属性值最大长度进行约束', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '986992', + 'ResourceGroupList' => [ + 'title' => '', + 'description' => 'Running Resource Group', + 'type' => 'array', + 'items' => ['description' => 'Resource Group', 'type' => 'string', 'example' => 'rs_group_test', 'title' => ''], + 'example' => '', ], - 'ValueEnumList' => [ - 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', - 'description' => '', + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'Schedule Period', 'type' => 'array', - 'items' => [ - 'title' => '属性选项值:仅针对填写方式为下拉单选框或下拉多选框的属性', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'items' => ['description' => 'Schedule Period'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY', 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'example' => '', + ], + 'BizUnitName' => ['title' => '', 'description' => 'Business Unit', 'type' => 'string', 'example' => 'xx测试'], + 'Creator' => [ + 'title' => '', + 'description' => 'Node Creator', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'User ID', 'type' => 'string', 'example' => '21313112', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], ], - 'required' => false, + 'example' => '', ], - 'DefaultValue' => [ - 'title' => '属性默认值', - 'description' => '', + 'Modifier' => [ + 'title' => '', + 'description' => 'Modifier', '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, + 'Id' => ['description' => 'Username', 'type' => 'string', 'example' => '21313112', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'OwnerList' => [ + 'title' => '', + 'description' => 'Owner', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'User ID', 'type' => 'string', 'example' => '21313112', 'title' => ''], + 'Name' => ['description' => 'Username', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'example' => '', ], + 'CreateTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2024-05-30 16:47:13'], + 'LastModifiedTime' => ['title' => '', 'description' => 'Last Modified Time', 'type' => 'string', 'example' => '2024-05-30 16:47:13'."\n"], ], - '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, + 'example' => '', ], + 'ExtendInfo' => ['title' => '', 'description' => 'Node extended information: specific information for instances from different business systems, such as pipeline fileId, whether the logical table has hierarchical dimensions, mid node information, and instance output name', 'type' => 'string', 'example' => 'xx'], ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Get Instance List', + 'changeSet' => [ + ['createdAt' => '2025-07-01T03:29:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-30T08:34:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateQualityWatchSwitch' => [ - 'summary' => '批量开启或关闭质量监控对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListNodeDownStream' => [ + 'summary' => 'Queries the downstream nodes of a node. The query results can be used as a data reference when you create a data backfill workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The request for querying node downstream.', 'type' => 'object', 'properties' => [ - 'Open' => [ - 'title' => '是否开启', - 'description' => '', - 'type' => 'boolean', + 'NodeIdList' => [ + 'title' => '', + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'n_23431'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs. This parameter can be specified when the node ID is a logical table node ID. If this parameter is not specified, all fields in the table are used by default.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'required' => false, 'example' => '23211121'], + 'required' => false, + 'example' => '112', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => true, + 'example' => '', ], - 'WatchIdList' => [ - 'title' => '监控Id列表', - 'description' => '', + 'DownStreamDepth' => ['title' => '', 'description' => 'The depth. Default value: 3.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'FilterList' => [ + 'title' => '', + 'description' => 'The filters. You can include or exclude results based on projects or nodes. Default value: empty.', 'type' => 'array', 'items' => [ - 'title' => '监控Id列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', + 'description' => 'The filter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The filter key. Valid values:'."\n" + .'- PROJECT: project'."\n" + .'- PHYSICAL_NODE_ID: physical node ID'."\n" + .'- LOGICAL_TABLE_NODE_ID: logical table ID.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT', 'title' => ''], + 'ValueList' => [ + 'description' => 'The list of filter values.', + 'type' => 'array', + 'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => '102113', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Exclude' => ['description' => 'Specifies whether to exclude the matched results. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'example' => '', ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123011'], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The 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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'NodeInfoList' => [ + 'title' => '', + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_2423351'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'Type' => ['title' => '', 'description' => 'The node type.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'FieldIdList' => [ + 'title' => '', + 'description' => 'The list of field IDs.', + 'type' => 'array', + 'items' => ['description' => 'The field ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'example' => '', + ], + 'Depth' => ['title' => '', 'description' => 'The depth level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query node downstream', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateQualityRuleSwitch' => [ - 'summary' => '批量开启或关闭质量规则。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListNodeDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListNodes' => [ + 'summary' => 'Retrieves a list of scheduling nodes.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'Open' => [ - 'title' => '是否开启', - 'description' => '', - 'type' => 'boolean', + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12111'], + 'NodeBizType' => ['title' => '', 'description' => 'The node business type. Valid values:'."\n" + .'- SCRIPT: script'."\n" + .'- LOGICAL_TABLE: logical table.', 'type' => 'string', 'required' => true, 'example' => 'SCRIPT'], + 'NodeSubBizTypeList' => [ + 'title' => '', + 'description' => 'The sub-business types. Valid values:'."\n" + .'- MAX_COMPUTE_SQL'."\n" + .'- HIVE_SQL'."\n" + .'- SHELL'."\n" + .'- PYTHON'."\n" + .'- ONE_SERVICE_SQL'."\n" + .'- DATABASE_SQL.', + 'type' => 'array', + 'items' => ['description' => 'The sub-business type.', 'type' => 'string', 'required' => false, 'example' => 'SHELL', 'title' => ''], 'required' => true, + 'example' => '', ], - 'RuleIdList' => [ - 'title' => '规则Id列表', - 'description' => '', + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'The scheduling periods. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY.', 'type' => 'array', - 'items' => [ - 'title' => '规则Id列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - 'required' => true, + 'items' => ['description' => 'The scheduling period.', 'type' => 'string', 'required' => false, 'example' => 'DAILY', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The user IDs of the owners.', + 'type' => 'array', + 'items' => ['description' => 'The owner.', 'type' => 'string', 'required' => false, 'example' => '121112', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'PriorityList' => [ + 'title' => '', + 'description' => 'The node priorities. Valid values:'."\n" + .'- HIGHEST'."\n" + .'- HIGH'."\n" + .'- MIDDLE'."\n" + .'- LOW'."\n" + .'- LOWEST.', + 'type' => 'array', + 'items' => ['description' => 'The priority.', 'type' => 'string', 'required' => false, 'example' => 'MIDDLE', 'title' => ''], + 'required' => false, + 'example' => '', ], + 'SchedulePaused' => ['title' => '', 'description' => 'Specifies whether scheduling is paused.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'DryRun' => ['title' => '', 'description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ScheduleType' => ['title' => '', 'description' => 'The node scheduling type. Valid values:'."\n" + .'- NORMAL: periodic scheduling'."\n" + .'- SUPPLEMENT: data backfill'."\n" + .'- MANUAL: manual scheduling.', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'], + 'SearchText' => ['title' => '', 'description' => 'The search keyword. Fuzzy search by node name and exact search by node ID are supported.', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'NodeList' => [ + 'title' => '', + 'description' => 'The list of nodes on the current page.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node details.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'xx test'], + 'PriorityList' => [ + 'title' => '', + 'description' => 'The priority.', + 'type' => 'array', + 'items' => ['description' => 'The priority.', 'type' => 'string', 'example' => 'MIDDLE', 'title' => ''], + 'example' => '', + ], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-05-30 16:47:13'], + 'DryRun' => ['title' => '', 'description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'example' => 'true'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The owner.', + 'type' => 'array', + 'items' => [ + 'description' => 'The owner.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '23222', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'From' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'Creator' => [ + 'title' => '', + 'description' => 'The creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '23222', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'SubDetailType' => ['title' => '', 'description' => 'The sub-business types. Valid values:'."\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' => 'The node name.', 'type' => 'string', 'example' => 'xx测试'], + 'HasProd' => ['title' => '', 'description' => 'Indicates whether a production environment exists.', 'type' => 'boolean', 'example' => 'true'], + 'Type' => ['title' => '', 'description' => 'The node type.', 'type' => 'string', 'example' => 'DATA_PROCESS'], + 'HasDev' => ['title' => '', 'description' => 'Indicates whether a development environment exists.', 'type' => 'boolean', 'example' => 'true'], + 'SchedulePaused' => ['title' => '', 'description' => 'Indicates whether scheduling is paused.', 'type' => 'boolean', 'example' => 'true'], + 'SchedulePeriodList' => [ + 'title' => '', + 'description' => 'The scheduling period.', + 'type' => 'array', + 'items' => ['description' => 'The scheduling period.', 'type' => 'string', 'example' => 'HOURLY', 'title' => ''], + 'example' => '', + ], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'The project to which the node belongs.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '1121321', 'title' => ''], + 'Name' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'LastModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-05-30 16:47:13', 'title' => ''], + 'BizUnitName' => ['title' => '', 'description' => 'The name of the business unit to which the node belongs.', 'type' => 'string', 'example' => 'xx测试'], + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_31111'], + 'Modifier' => [ + 'title' => '', + 'description' => 'The user who last modified the node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '311131', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xx测试', 'title' => ''], + ], + 'example' => '', + ], + 'ExtendInfo' => ['title' => '', 'description' => 'The extended information.', 'type' => 'string', 'example' => '{"xx":"zz"}'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - '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"}]', - ], - 'SubmitQualityWatchTasks' => [ - 'summary' => '批量提交监控对象校验任务。', - 'methods' => [ - 'post', + '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' => 'List scheduling nodes', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:30:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListOperationRecord' => [ + 'summary' => 'Performs a paged query on the list of operation records. Online version: v6.2.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SubmitCommand', + 'name' => 'ListCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '提交指令', - 'description' => '', + 'title' => '', + 'description' => 'The query command.', 'type' => 'object', 'properties' => [ - 'WatchIdList' => [ - 'title' => '监控对象ID', - 'description' => '', + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'Page' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + 'Status' => [ + 'title' => '', + 'description' => 'The list of task statuses.', 'type' => 'array', - 'items' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'required' => true, + 'items' => ['title' => '', 'description' => 'The task status. Valid values: 4 (running), 5 (succeeded), 6 (failed).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + 'required' => false, + 'example' => '', ], - 'PartitionExpression' => [ - 'title' => '分区表达式-自定义表达式', - 'description' => '', - 'type' => 'string', + 'ObjectType' => [ + 'title' => '', + 'description' => 'The list of object types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The object type. Valid values: onedata-ide, onedata3-server, DATA_CATALOG, openapi.', 'type' => 'string', 'required' => false, 'example' => 'onedata-ide'], 'required' => false, - 'example' => 'ds=${yyyyMMdd}', + 'example' => '', ], - 'BizDate' => [ - 'title' => '业务日期，格式：yyyy-MM-dd', - 'description' => '', - 'type' => 'string', + 'CodeType' => [ + 'title' => '', + 'description' => 'The list of code types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The code type. Valid values: 0 (SQL), 1 (shell), 2 (Python), 3 (MR), 4 (Spark).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'required' => false, + 'example' => '', + ], + 'UserIds' => [ + 'title' => '', + 'description' => 'The list of executor IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the executor.', 'type' => 'string', 'required' => false, 'example' => '30231123'], 'required' => false, - 'example' => '2025-06-30', + 'example' => '', + ], + 'BeginTimeStart' => ['title' => '', 'description' => 'The beginning of the start time range. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 00:00:00'], + 'BeginTimeEnd' => ['title' => '', 'description' => 'The end of the start time range. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2025-12-31 23:59:59'], + 'Duration' => [ + 'title' => '', + 'description' => 'The list of duration ranges.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The duration range. Valid values: 0 (within 10 minutes), 1 (10 to 30 minutes), 2 (30 to 60 minutes), 3 (over 1 hour).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'required' => false, + 'example' => '', ], + 'CodeContent' => ['title' => '', 'description' => 'The keyword for code search.', 'type' => 'string', 'required' => false, 'example' => 'select'], + 'FileName' => ['title' => '', 'description' => 'The script name.', 'type' => 'string', 'required' => false, 'example' => '测试脚本'], + 'SortType' => ['title' => '', 'description' => 'The sort type. Valid values: 0 (start time ascending), 1 (start time descending), 2 (object name).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'SubmitResult' => [ - 'title' => '执行结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'OperationLogListResponse' => [ + 'title' => '', + 'description' => 'The operation log list response.', 'type' => 'object', 'properties' => [ - 'WatchTaskIdList' => [ - 'title' => '监控对象校验任务ID列表', - 'description' => '', + 'ResultData' => [ + 'title' => '', + 'description' => 'The list of operation logs.', 'type' => 'array', 'items' => [ - 'title' => '监控对象校验任务ID列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'description' => 'The operation log entry.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => '测试任务'], + 'ObjectType' => ['title' => '', 'description' => 'The object type.', 'type' => 'string', 'example' => 'onedata-ide'], + 'CodeType' => ['title' => '', 'description' => 'The code type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Status' => ['title' => '', 'description' => 'The task status.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'BeginTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2025-01-15 10:30:00'], + 'Runner' => ['title' => '', 'description' => 'The ID of the executor.', 'type' => 'string', 'example' => '30231123'], + 'RunnerName' => ['title' => '', 'description' => 'The name of the executor.', 'type' => 'string', 'example' => '张三'], + 'RelationTables' => [ + 'title' => '', + 'description' => 'The list of related tables.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'ods_test_table'], + 'example' => '', + ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '131211211'], + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'], + 'OperationId' => ['title' => '', 'description' => 'The operation record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '987654321'], + 'Duration' => ['title' => '', 'description' => 'The execution duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + ], + 'example' => '', ], + 'example' => '', ], + 'Count' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Paged query of operation record list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"OperationLogListResponse\\": {\\n \\"ResultData\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"测试任务\\",\\n \\"ObjectType\\": \\"onedata-ide\\",\\n \\"CodeType\\": 0,\\n \\"Status\\": 5,\\n \\"BeginTime\\": \\"2025-01-15 10:30:00\\",\\n \\"Runner\\": \\"30231123\\",\\n \\"RunnerName\\": \\"张三\\",\\n \\"RelationTables\\": [\\n \\"ods_test_table\\"\\n ],\\n \\"ProjectId\\": 131211211,\\n \\"TenantId\\": 10001,\\n \\"OperationId\\": 987654321,\\n \\"Duration\\": 120\\n }\\n ],\\n \\"Count\\": 100\\n }\\n}","type":"json"}]', ], - 'SubmitQualityRuleTasks' => [ - 'summary' => '批量提交规则任务,支持试跑。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListProjectMembers' => [ + 'summary' => 'Queries the list of project members.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SubmitCommand', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], + ], + [ + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '提交指令', - 'description' => '', + 'title' => '', + 'description' => 'The request object.', 'type' => 'object', 'properties' => [ - 'IsTestRun' => [ - 'title' => '是否为试跑: true 试跑、false 正式运行, 默认 true', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - ], - 'WatchRuleIdList' => [ - 'title' => '监控及规则ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'RuleId' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'PartitionExpressionFrom' => [ - 'title' => '试跑分区表达式来源: SCHEDULE 已有调度、CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOM', - ], - 'ScheduleId' => [ - 'title' => '已有调度ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'PartitionExpression' => [ - 'title' => '分区表达式-自定义表达式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ds=${yyyyMMdd}', - ], - 'BizDate' => [ - 'title' => '业务日期，格式：yyyy-MM-dd', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2025-06-30', - ], + 'Env' => ['title' => '', 'description' => 'The project environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '1030111021', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response object.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'SubmitResult' => [ - 'title' => '执行结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', 'type' => 'object', 'properties' => [ - 'RuleTaskIdList' => [ - 'title' => '规则任务Id,试跑场景返回', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则任务Id,试跑场景返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'WatchTaskIdList' => [ - 'title' => '监控对象任务ID,非试跑场景返回', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of project members.', 'type' => 'integer', 'format' => 'int32', 'example' => '101'], + 'ProjectMemberList' => [ + 'title' => '', + 'description' => 'The list of project members.', 'type' => 'array', 'items' => [ - 'title' => '监控对象任务ID,非试跑场景返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'description' => 'The project member.', + 'type' => 'object', + 'properties' => [ + 'RoleIdList' => [ + 'title' => '', + 'description' => 'The roles.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The role code. For the list of role codes, refer to the add project member operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The creation timestamp.', 'type' => 'string', 'example' => '1702692675000'], + 'LastModifier' => ['title' => '', 'description' => 'The ID of the user who last modified the record.', 'type' => 'string', 'example' => '101111'], + 'UserName' => ['title' => '', 'description' => 'The username of the member.', 'type' => 'string', 'example' => '测试用户'], + 'UserId' => ['title' => '', 'description' => 'The user ID of the member.', 'type' => 'string', 'example' => '101111'], + 'GmtModified' => ['title' => '', 'description' => 'The last modified timestamp.', 'type' => 'string', 'example' => '1721720955000'], + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12356'], + 'LastModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the record.', 'type' => 'string', 'example' => '测试用户'], + ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query project members by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'RemoveQualityRuleSchedules' => [ - 'summary' => '批量删除质量规则和调度的绑定关系。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListProjects' => [ + 'summary' => 'Retrieves a list of projects.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RemoveCommand', + 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '解绑指令', - 'description' => '', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '平均值', - ], - 'RuleId' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - 'ScheduleIdList' => [ - 'title' => '调度ID', - 'description' => '', + 'Keyword' => ['title' => '', 'description' => 'The keyword for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'TagList' => [ + 'title' => '', + 'description' => 'The project tags.', 'type' => 'array', - 'items' => [ - 'title' => '调度ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - 'required' => true, + 'items' => ['title' => '', 'description' => 'The project tags.', 'type' => 'string', 'required' => false, 'example' => 'GENERAL'], + 'required' => false, + 'example' => '', ], + 'Mode' => ['title' => '', 'description' => 'The project mode.', 'type' => 'string', 'required' => false, 'example' => 'BASIC'], + 'Env' => ['title' => '', 'description' => 'The environment identifier.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'ProjectList' => [ + 'title' => '', + 'description' => 'The paginated list of projects.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RealtimeDataSourceName' => ['title' => '', 'description' => 'The name of the real-time compute source.', 'type' => 'string', 'example' => 'ds2'], + 'Owner' => ['title' => '', 'description' => 'The project owner.', 'type' => 'string', 'example' => '30012112'], + 'OwnerName' => ['title' => '', 'description' => 'The project owner.', 'type' => 'string', 'example' => '张三'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试'], + 'Mode' => ['title' => '', 'description' => 'The project mode.', 'type' => 'string', 'example' => 'BASIC'], + 'GmtModified' => ['title' => '', 'description' => 'The time when the project was last modified, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'Env' => ['title' => '', 'description' => 'The environment identifier.', 'type' => 'string', 'example' => 'DEV'], + 'Name' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'demo'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '162112'], + 'Type' => ['title' => '', 'description' => 'The project type.', 'type' => 'string', 'example' => 'GENERAL'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the project was created, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-10 10:01:01'], + 'DataSourceName' => ['title' => '', 'description' => 'The name of the compute source.', 'type' => 'string', 'example' => 'ds1'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the project.', 'type' => 'string', 'example' => '测试'], + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1030111021'], + 'DataSourceId' => ['title' => '', 'description' => 'The compute source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'RealtimeDataSourceId' => ['title' => '', 'description' => 'The real-time compute source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1122'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'List projects by page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListPublishRecords' => [ + 'summary' => 'Retrieves a paginated list of publish records.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Query command.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'SearchFilter' => [ + 'title' => '', + 'description' => 'Publish record filter.', + 'type' => 'object', + 'properties' => [ + 'ProjectIdList' => [ + 'title' => '', + 'description' => 'List of project IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890'], + 'required' => true, + 'example' => '', + ], + 'SubmitterList' => [ + 'title' => '', + 'description' => 'List of submitter IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Submitter ID.', 'type' => 'string', 'required' => true, 'example' => '30897000'], + 'required' => false, + 'example' => '', + ], + 'ChangeTypeList' => [ + 'title' => '', + 'description' => 'List of change types (0: Create, 1: Update, 2: Delete).', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Change type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'required' => false, + 'example' => '', + ], + 'PublishStatusList' => [ + 'title' => '', + 'description' => 'List of publish statuses (0: Failed, 1: Succeeded, 2: Publishing).', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Publish status.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'required' => false, + 'example' => '', + ], + 'PublishStartTime' => ['title' => '', 'description' => 'Publish start time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00'], + 'PublishEndTime' => ['title' => '', 'description' => 'Publish end time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00'], + 'Page' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + 'required' => true, + 'example' => '', ], - 'Data' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'true', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'Backend response HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'ListResult' => [ + 'title' => '', + 'description' => 'Query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Data' => [ + 'title' => '', + 'description' => 'Publish record list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Publish record.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Publish record ID, which is not the object ID and is globally unique in the publish list.', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456'], + 'PublishName' => ['title' => '', 'description' => 'Publish name.', 'type' => 'string', 'example' => 'test_lc__20241118171502'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'example' => '1241844456'], + 'Publisher' => ['title' => '', 'description' => 'Publisher ID.', 'type' => 'string', 'example' => '307999999'], + 'PublisherName' => ['title' => '', 'description' => 'Publisher name.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModify' => ['title' => '', 'description' => 'Modification time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'ChangeType' => ['title' => '', 'description' => 'Change type. Valid values: 0: Create. 1: Update. 2: Delete.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ObjectType' => ['title' => '', 'description' => 'Object type.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'ObjectName' => ['title' => '', 'description' => 'Object name.', 'type' => 'string', 'example' => '对象A'], + 'ObjectId' => ['title' => '', 'description' => 'Object ID.', 'type' => 'string', 'example' => '1234567'], + 'NodeId' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'ObjectVersion' => ['title' => '', 'description' => 'Object version.', 'type' => 'string', 'example' => '1'], + 'FinishTime' => ['title' => '', 'description' => 'Publish completion time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-10-10 10:10:10'], + 'ErrorMessage' => ['title' => '', 'description' => 'Publish error message.', 'type' => 'string', 'example' => 'error'], + 'PublishStatus' => ['title' => '', 'description' => 'Publish status. Valid values: 0: Failed. 1: Succeeded. 2: Publishing.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Query publish records by page', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:35.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'ListQualityWatches' => [ - 'summary' => '分页查询质量监控对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListPublishRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListQualityRuleTasks' => [ + 'summary' => 'Queries quality rule tasks by paging.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -39781,721 +29084,662 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The paged query conditions.', 'type' => 'object', 'properties' => [ - 'WatchTypeList' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', + 'WatchTaskId' => ['title' => '', 'description' => 'The ID of the quality watchtask.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'array', - 'items' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TABLE', - ], + 'items' => ['title' => '', 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT'], 'required' => false, + 'example' => '', ], - 'StatusList' => [ - 'title' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', + 'RuleStrengthList' => [ + 'title' => '', + 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG: strong'."\n" + .'- WEAK: weak.', 'type' => 'array', - 'items' => [ - 'title' => '监控对象生效状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLE', - ], + 'items' => ['title' => '', 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG: strong'."\n" + .'- WEAK: weak.', 'type' => 'string', 'required' => false, 'example' => 'STRONG'], 'required' => false, + 'example' => '', ], - 'LatestWatchTaskStatusList' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', + 'StatusList' => [ + 'title' => '', + 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting'."\n" + .'- RUNNING: running'."\n" + .'- SUCCESS: succeeded'."\n" + .'- FAILED: failed'."\n" + .'- CANCEL: canceled'."\n" + .'- TIMEOUT: timed out'."\n" + .'- OFFLINE: offline.', 'type' => 'array', - 'items' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], + 'items' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting'."\n" + .'- RUNNING: running'."\n" + .'- SUCCESS: succeeded'."\n" + .'- FAILED: failed'."\n" + .'- CANCEL: canceled'."\n" + .'- TIMEOUT: timed out'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, + 'example' => '', ], - 'CurrentUserOwned' => [ - 'title' => '是否当前用户负责的监控对象', - 'description' => '', - 'type' => 'boolean', + 'ValidateResultList' => [ + 'title' => '', + 'description' => 'The validation result. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting for execution'."\n" + .'- RUNNING: running'."\n" + .'- PASS: passed'."\n" + .'- NOT_PASS: not passed'."\n" + .'- FAILED: execution failed'."\n" + .'- OFFLINE: offline and needs to be restarted'."\n" + .'- CANCEL: task canceled'."\n" + .'- TIMEOUT: task timed out.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The validation result. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting for execution'."\n" + .'- RUNNING: running'."\n" + .'- PASS: passed'."\n" + .'- NOT_PASS: not passed'."\n" + .'- FAILED: execution failed'."\n" + .'- OFFLINE: offline and needs to be restarted'."\n" + .'- CANCEL: task canceled'."\n" + .'- TIMEOUT: task timed out.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, + 'example' => '', ], - 'QualityOwnerList' => [ - 'title' => '质量负责人', - 'description' => '', + 'RuleTagList' => [ + 'title' => '', + 'description' => 'The rule label. Valid values:'."\n" + .'- DEFAULT: default label'."\n" + .'- DATA_STANDARD_MANUAL: standard rule manually created'."\n" + .'- DATA_STANDARD_AUTO: quality rule created by automatic creation from a standard'."\n" + .'- PIPELINE: rule created by a pipeline'."\n" + .'- DATA_MODELING: data modeling diagnostics.', 'type' => 'array', - 'items' => [ - 'title' => '质量负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], + 'items' => ['title' => '', 'description' => 'The rule label. Valid values:'."\n" + .'- DEFAULT: default label'."\n" + .'- DATA_STANDARD_MANUAL: standard rule manually created'."\n" + .'- DATA_STANDARD_AUTO: quality rule created by automatic creation from a standard'."\n" + .'- PIPELINE: rule created by a pipeline'."\n" + .'- DATA_MODELING: data modeling diagnostics.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], 'required' => false, + 'example' => '', ], - 'TableOwnerList' => [ - 'title' => '表负责人', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '表负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30'], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. You can search by field name or rule name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'QualityRuleTaskList' => [ + 'title' => '', + 'description' => 'The list of quality rule tasks.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WatchId' => ['title' => '', 'description' => 'The ID of the associated quality watchtask.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'WatchTaskId' => ['title' => '', 'description' => 'The ID of the quality watchtask. This ID is empty for trial-run rule tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Id' => ['title' => '', 'description' => 'The ID of the rule task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RuleId' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Status' => ['title' => '', 'description' => 'The task status.', 'type' => 'string', 'example' => 'running'], + 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ValidatePartition' => ['title' => '', 'description' => 'The validation partition.', 'type' => 'string', 'example' => '20251011'], + 'ValidateObjectType' => ['title' => '', 'description' => 'The object type of the validated object.', 'type' => 'string', 'example' => 'column'], + 'ValidateObjectName' => ['title' => '', 'description' => 'The name of the validated object.', 'type' => 'string', 'example' => 'test'], + 'ValidateSuccess' => ['title' => '', 'description' => 'Indicates whether the validation passed.', 'type' => 'boolean', 'example' => ''], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'BizDateFormat' => ['title' => '', 'description' => 'The business date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The ID of the user who last modified the task.', 'type' => 'string', 'example' => '30012011'], + ], + 'example' => '', + ], + 'example' => '', + ], ], - 'required' => false, + 'example' => '', ], - 'TableTypeList' => [ - 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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' => 'List quality rule tasks by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListQualityRules' => [ + 'summary' => 'Queries quality rules by paging.'."\n" + .'Online version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The paged query conditions.', + 'type' => 'object', + 'properties' => [ + 'WatchId' => ['title' => '', 'description' => 'The monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'StatusList' => [ + 'title' => '', + 'description' => 'The rule effective status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'array', - 'items' => [ - 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LOGIC_DIM_TABLE', - ], + 'items' => ['title' => '', 'description' => 'The rule effective status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'required' => false, 'example' => 'ENABLE'], 'required' => false, + 'example' => '', ], - 'DataSourceIdList' => [ - 'title' => '数据源Id', - 'description' => '', + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency.'."\n" + .'- EFFECTIVE: validity.'."\n" + .'- TIMELINESE: timeliness.'."\n" + .'- ACCURATE: accuracy.'."\n" + .'- UNIQUENESS: uniqueness.'."\n" + .'- COMPLETENESS: completeness.'."\n" + .'- STABILITY: stability.'."\n" + .'- CUSTOM: custom.', 'type' => 'array', - 'items' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'items' => ['title' => '', 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency.'."\n" + .'- EFFECTIVE: validity.'."\n" + .'- TIMELINESE: timeliness.'."\n" + .'- ACCURATE: accuracy.'."\n" + .'- UNIQUENESS: uniqueness.'."\n" + .'- COMPLETENESS: completeness.'."\n" + .'- STABILITY: stability.'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT'], 'required' => false, + 'example' => '', ], - 'DataSourceTypeList' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', - 'description' => '', + 'TemplateIdList' => [ + 'title' => '', + 'description' => 'The rule template.', 'type' => 'array', - 'items' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MAX_COMPUTE', - ], + 'items' => ['title' => '', 'description' => 'The rule template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - ], - 'required' => false, - ], - 'DataSourceOwnerList' => [ - 'title' => '数据源负责人', - 'description' => '', + 'RuleStrengthList' => [ + 'title' => '', + 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG: strong.'."\n" + .'- WEAK: weak.', 'type' => 'array', - 'items' => [ - 'title' => '数据源负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], + 'items' => ['title' => '', 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG: strong.'."\n" + .'- WEAK: weak.', 'type' => 'string', 'required' => false, 'example' => 'STRONG'], 'required' => false, + 'example' => '', ], - 'IndexOwnerList' => [ - 'title' => '指标负责人', - 'description' => '', + 'TestRunTaskValidateResultList' => [ + 'title' => '', + 'description' => 'The trial run validation result. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting for execution.'."\n" + .'- RUNNING: executing.'."\n" + .'- PASS: passed.'."\n" + .'- NOT_PASS: not passed.'."\n" + .'- FAILED: execution failed.'."\n" + .'- OFFLINE: offline. The task needs to be restarted.'."\n" + .'- CANCEL: task canceled.'."\n" + .'- TIMEOUT: task timed out.', 'type' => 'array', - 'items' => [ - 'title' => '指标负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], + 'items' => ['title' => '', 'description' => 'The trial run validation result. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting for execution.'."\n" + .'- RUNNING: executing.'."\n" + .'- PASS: passed.'."\n" + .'- NOT_PASS: not passed.'."\n" + .'- FAILED: execution failed.'."\n" + .'- OFFLINE: offline. The task needs to be restarted.'."\n" + .'- CANCEL: task canceled.'."\n" + .'- TIMEOUT: task timed out.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, + 'example' => '', ], - 'IndexComputeTypeList' => [ - 'title' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', - 'description' => '', + 'TestRunTaskStatusList' => [ + 'title' => '', + 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: executing.'."\n" + .'- SUCCESS: execution succeeded.'."\n" + .'- FAILED: execution failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', 'type' => 'array', - 'items' => [ - 'title' => '指标计算类型: AUTO 自动化编码方式、CUSTOM 专家编码方式、MOUNT 外部表注册的方式、COMBINE 衍生指标专用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AUTO', - ], - 'required' => false, - ], - 'Keyword' => [ - 'title' => '搜索关键词: 监控表名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: executing.'."\n" + .'- SUCCESS: execution succeeded.'."\n" + .'- FAILED: execution failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, - 'example' => '20', + 'example' => '', ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword for filtering. Supports searching by rule name and validation object.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], - 'QualityWatchList' => [ - 'title' => '分页质量告警列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'QualityRuleList' => [ + 'title' => '', + 'description' => 'The list of quality rules returned by page.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'example' => 'TABLE', - ], - 'Id' => [ - 'title' => '监控Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Name' => [ - 'title' => '监控名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'title' => '状态：ENABLE，DISABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'ENABLE', + 'Id' => ['title' => '', 'description' => 'The quality rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The quality rule name.', 'type' => 'string', 'example' => 'test'], + 'Status' => ['title' => '', 'description' => 'The quality rule status. Valid values:'."\n" + .'- ENABLE'."\n" + .'- DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Strength' => ['title' => '', 'description' => 'The rule strength. Valid values:'."\n" + .'- STRONG'."\n" + .'- WEAK.', 'type' => 'string', 'example' => 'STRONG'], + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule category. Valid values:'."\n" + .'- CONSISTENT: consistency.'."\n" + .'- EFFECTIVE: validity.'."\n" + .'- TIMELINESE: timeliness.'."\n" + .'- ACCURATE: accuracy.'."\n" + .'- UNIQUENESS: uniqueness.'."\n" + .'- COMPLETENESS: completeness.'."\n" + .'- STABILITY: stability.'."\n" + .'- CUSTOM: custom.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule category. Valid values:'."\n" + .'- CONSISTENT: consistency.'."\n" + .'- EFFECTIVE: validity.'."\n" + .'- TIMELINESE: timeliness.'."\n" + .'- ACCURATE: accuracy.'."\n" + .'- UNIQUENESS: uniqueness.'."\n" + .'- COMPLETENESS: completeness.'."\n" + .'- STABILITY: stability.'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CONSISTENT'], + 'example' => '', ], - 'DataSourceInfo' => [ - 'title' => '数据源详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Type' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'CreatorName' => [ - 'title' => '创建者名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', + 'TemplateType' => ['title' => '', 'description' => 'The templatetype. Valid values:'."\n" + .' - FIELD_NULL_VALUE_VALIDATE: field null value validation.'."\n" + .' - FIELD_EMPTY_STRING_VALIDATE: field empty character string validation.'."\n" + .' - FIELD_UNIQUE_VALIDATE: field uniqueness validation.'."\n" + .' - FIELD_GROUP_COUNT_VALIDATE: field unique value count validation.'."\n" + .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count validation.'."\n" + .' - FUNCTION_TIME_COMPARE: time function comparison.'."\n" + .' - SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison.'."\n" + .' - DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison.'."\n" + .' - FIELD_FORMAT_VALIDATE: field format validation.'."\n" + .' - FIELD_LENGTH_VALIDATE: field length validation.'."\n" + .' - FIELD_VALUE_RANGE_VALIDATE: field value range validation.'."\n" + .' - CODE_TABLE_COMPARE: lookup table reference comparison.'."\n" + .' - STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison.'."\n" + .' - SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison.'."\n" + .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison.'."\n" + .' - SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison.'."\n" + .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison.'."\n" + .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison.'."\n" + .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison.'."\n" + .' - DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison.'."\n" + .' - TABLE_STABILITY_VALIDATE: table stability validation.'."\n" + .' - TABLE_FLUCTUATION_VALIDATE: table fluctuation validation.'."\n" + .' - FIELD_STABILITY_VALIDATE: field stability validation.'."\n" + .' - FIELD_FLUCTUATION_VALIDATE: field fluctuation validation.'."\n" + .' - CUSTOM_STATISTICAL_VALIDATE: custom statistical metric validation.'."\n" + .' - CUSTOM_DATA_DETAILS_VALIDATE: custom data details validation.'."\n" + .' - DATASOURCE_AVAILABLE_CHECK: data source connectivity check.'."\n" + .' - TABLE_SCHEMA_CHECK: table schema change detection.'."\n" + .' - REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison.'."\n" + .' - REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring.'."\n" + .' - REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison, and more.', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '1'], + 'TemplateScope' => ['title' => '', 'description' => 'The templatetype group. Valid values:'."\n" + .'- SYSTEM: system preset.'."\n" + .'- CUSTOM: custom template.'."\n" + .'- TEMPLATE: union of SYSTEM and CUSTOM.'."\n" + .'- CUSTOM_SQL: custom SQL template.', 'type' => 'string', 'example' => 'CUSTOM'], + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitoring to which the rule belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnableErrorArchive' => ['title' => '', 'description' => 'Indicates whether exception archiving is enabled.', 'type' => 'boolean', 'example' => ''], + 'ValidateConditionList' => [ + 'title' => '', + 'description' => 'The list of validation conditions.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The condition node ID.', 'type' => 'string', 'example' => '268'], + 'Type' => ['title' => '', 'description' => 'The condition type. Valid values:'."\n" + .'- RELATION: relation.'."\n" + .'- EXPRESSION: expression.', 'type' => 'string', 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'The operator. Valid values: EQUAL, NOT_EQUAL, LARGER, SMALLER, LARGE_OR_EQUAL, SMALLER_OR_EQUAL, AND, OR.', 'type' => 'string', 'example' => 'AND'], + 'OperatorName' => ['title' => '', 'description' => 'The operator name.', 'type' => 'string', 'example' => '且'], + 'Metric' => ['title' => '', 'description' => 'The metric.', 'type' => 'string', 'example' => 'test'], + 'MetricName' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The value.', 'type' => 'string', 'example' => '1'], + 'ParentId' => ['title' => '', 'description' => 'The parent condition node ID.', 'type' => 'string', 'example' => '123'], ], + 'example' => '', ], + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_DIM_TABLE', - ], - 'Catalog' => [ - 'title' => '表catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '表Id', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'title' => '表名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Env' => [ - 'title' => '环境标识：DEV、PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '负责人用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '22', + 'TestRunRuleTaskId' => ['title' => '', 'description' => 'The ID of the most recent trial run task.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'TestRunRuleTaskStatus' => ['title' => '', 'description' => 'The status of the most recent trial run task. Valid values: NOT_RUN, WAITING, RUNNING, SUCCESS, FAILED.', 'type' => 'string', 'example' => 'SUCCESS'], + 'TestRunRuleValidateResult' => ['title' => '', 'description' => 'Indicates whether the trial run validation passed.', 'type' => 'boolean', 'example' => ''], + 'ScheduleBindList' => [ + 'title' => '', + 'description' => 'The list of schedules bound to the rule.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ScheduleId' => ['title' => '', 'description' => 'The schedule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ScheduleName' => ['title' => '', 'description' => 'The schedule name.', 'type' => 'string', 'example' => 'test'], ], - 'IsPartitionTable' => [ - 'title' => '是否分区表', - 'description' => '', - 'type' => 'boolean', + 'example' => '', + ], + 'example' => '', + ], + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'The rule configuration key-value pairs. These vary by templatetype: different templatetypes return different form key-value pair configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['title' => '', 'description' => 'The control type.', 'type' => 'string', 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'The property name.', 'type' => 'string', 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'The property value.', 'type' => 'string', 'example' => 'abc'], ], + 'example' => '', ], + 'example' => '', ], - 'IndexInfo' => [ - 'title' => '指标详情', - 'description' => '', + 'ValidateObject' => [ + 'title' => '', + 'description' => 'The validation object.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Catalog' => [ - 'title' => '指标catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '指标Id：', - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'Guid' => [ - 'title' => '指标guid：', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'Name' => [ - 'title' => '指标名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'DisplayName' => [ - 'title' => '指标展示名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'GranularityId' => [ - 'title' => '统计粒度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18755764', - ], - 'GranularityDisplayName' => [ - 'title' => '统计粒度名称', - 'description' => '', - 'type' => 'string', - 'example' => '全站汇总表', - ], - 'ComputeType' => [ - 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', - 'description' => '', - 'type' => 'string', - 'example' => 'AUTO', - ], - 'CellSumLogicTableName' => [ - 'title' => '单元汇总表名', - 'description' => '', - 'type' => 'string', - 'example' => 'dws_all', - ], - 'Type' => [ - 'title' => '指标类型：INDEX', - 'description' => '', - 'type' => 'string', - 'example' => 'INDEX', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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', - ], + 'Type' => ['title' => '', 'description' => 'The validation object type. Valid values: UNKNOWN, TABLE, COLUMN, DATASOURCE, DATASOURCE_TABLE, REALTIME, INDEX, CHAIN.', 'type' => 'string', 'example' => 'TABLE'], + 'Name' => ['title' => '', 'description' => 'The validation object name.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], - 'QualityOwner' => [ - 'title' => '质量负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'QualityOwnerName' => [ - 'title' => '质量负责人显示名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LatestWatchTaskId' => [ - 'title' => '最近一次监控对象校验记录ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', + 'AttributeWithValueList' => [ + 'title' => '', + 'description' => 'The rule business attribute configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AttributeInfo' => [ + 'title' => '', + 'description' => 'The attribute details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-168890138815'], + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'example' => 'attr01'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Enabled' => ['title' => '', 'description' => 'Indicates whether the attribute is enabled.', 'type' => 'boolean', 'example' => ''], + 'Required' => ['title' => '', 'description' => 'Indicates whether the attribute is required.', 'type' => 'boolean', 'example' => ''], + 'Searchable' => ['title' => '', 'description' => 'Indicates whether the attribute is searchable.', 'type' => 'boolean', 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The attribute value configuration details.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value input method. Valid values:'."\n" + .'- CUSTOMIZED: custom input.'."\n" + .'- SINGLE_ENUM: single-select dropdown.'."\n" + .'- MULTIPLE_ENUMS: multi-select dropdown.'."\n" + .'- RANGE: range interval.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The attribute field type. Valid values:'."\n" + .'- STRING: text.'."\n" + .'- BIGINT: integer.'."\n" + .'- DOUBLE: floating-point.'."\n" + .'- BOOLEAN: Boolean.'."\n" + .'- DATE: date.'."\n" + .'- DATETIME: datetime.', 'type' => 'string', 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The attribute field length. This constrains the maximum length of text-type attribute values.', 'type' => 'integer', 'format' => 'int32', 'example' => '6997283'], + 'ValueEnumList' => [ + 'title' => '', + 'description' => 'The attribute option values. This applies only to attributes with the input method set to single-select dropdown or multi-select dropdown.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute option values. This applies only to attributes with the input method set to single-select dropdown or multi-select dropdown.', 'type' => 'string', 'example' => 'test'], + 'example' => '', + ], + 'DefaultValue' => [ + 'title' => '', + 'description' => 'The attribute default value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The list of attribute values. This applies to attributes with the input method set to custom input, single-select dropdown, or multi-select dropdown.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of attribute values. This applies to attributes with the input method set to custom input, single-select dropdown, or multi-select dropdown.', 'type' => 'string', 'example' => '123'], + 'example' => '', + ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'AttributeValue' => [ + 'title' => '', + 'description' => 'The property value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The list of attribute values. This applies to attributes with the input method set to custom input, single-select dropdown, or multi-select dropdown.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of attribute values. This applies to attributes with the input method set to custom input, single-select dropdown, or multi-select dropdown.', 'type' => 'string', 'example' => '123'], + 'example' => '', + ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Indicates whether the minimum value is included.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. This applies to range interval attributes.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Indicates whether the maximum value is included.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'Modifier' => ['title' => '', 'description' => 'The ID of the user who last modified the rule.', 'type' => 'string', 'example' => '30012011'], + 'ModifierName' => ['title' => '', 'description' => 'The name of the user who last modified the rule.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\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\\": false,\\n \\"Required\\": false,\\n \\"Searchable\\": false,\\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\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\n }\\n }\\n },\\n \\"AttributeValue\\": {\\n \\"ValueList\\": [\\n \\"123\\"\\n ],\\n \\"MinValue\\": \\"1\\",\\n \\"IncludeMinValue\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\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' => 'List quality rules by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListQualityWatchTasks' => [ - 'summary' => '分页查询质量监控任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListQualityTemplates' => [ + 'summary' => 'Queries quality templates by paging.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -40504,528 +29748,314 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The paged query conditions.', 'type' => 'object', 'properties' => [ - 'WatchTypeList' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TABLE', - ], - 'required' => false, - ], - 'DataSourceIdList' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'DataSourceScopeList' => [ - 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '数据源用途: STREAMING 仅实时、OFFLINE 仅离线、ALL 实时和离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - ], - 'required' => false, - ], - 'DataSourceTypeList' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP、MYSQL等', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MAX_COMPUTE', - ], - 'required' => false, - ], - 'ErrorRuleStrengthList' => [ - 'title' => '规则异常类型：STRONG 强、WEAK 弱', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则异常类型：STRONG 强、WEAK 弱', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '表类型：LOGIC_DIM_TABLE 维度逻辑表，LOGIC_FACT_TABLE 事实逻辑表，LOGIC_SUM_TABLE 汇总逻辑表，LOGIC_LABEL_TABLE 标签逻辑表，PHYSICAL_TABLE 物理表，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LOGIC_DIM_TABLE', - ], - 'required' => false, - ], - 'ProjectNameList' => [ - 'title' => '所属项目名称', - 'description' => '', + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'array', - 'items' => [ - 'title' => '所属项目名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['title' => '', 'description' => 'The rule type. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'required' => false, 'example' => 'CONSISTENT'], 'required' => false, + 'example' => '', ], - 'BizUnitNameList' => [ - 'title' => '所属板块名称', - 'description' => '', + 'SupportDataSourceTypeList' => [ + 'title' => '', + 'description' => 'The supported data source types, such as MAX_COMPUTE, MYSQL, and HIVE.', 'type' => 'array', - 'items' => [ - 'title' => '所属板块名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => false, - ], - 'CurrentUserOwned' => [ - 'title' => '我负责的监控任务对象', - 'description' => '', - 'type' => 'boolean', + 'items' => ['title' => '', 'description' => 'The supported data source types, such as MAX_COMPUTE, MYSQL, and HIVE.', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE'], 'required' => false, + 'example' => '', ], - 'QualityOwnerList' => [ - 'title' => '质量负责人', - 'description' => '', + 'TemplateTypeList' => [ + 'title' => '', + 'description' => 'The templatetype. Valid values:'."\n" + .'- FIELD_NULL_VALUE_VALIDATE: field null value check'."\n" + .'- FIELD_EMPTY_STRING_VALIDATE: field empty character string check'."\n" + .'- FIELD_UNIQUE_VALIDATE: field uniqueness check'."\n" + .'- FIELD_GROUP_COUNT_VALIDATE: field unique value count check'."\n" + .'- FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count check'."\n" + .'- FUNCTION_TIME_COMPARE: time function comparison'."\n" + .'- SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison'."\n" + .'- DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison'."\n" + .'- FIELD_FORMAT_VALIDATE: field format check'."\n" + .'- FIELD_LENGTH_VALIDATE: field length check'."\n" + .'- FIELD_VALUE_RANGE_VALIDATE: field value range check'."\n" + .'- CODE_TABLE_COMPARE: lookup table reference comparison'."\n" + .'- STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison'."\n" + .'- SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison'."\n" + .'- CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison'."\n" + .'- TABLE_STABILITY_VALIDATE: table stability check'."\n" + .'- TABLE_FLUCTUATION_VALIDATE: table fluctuation check'."\n" + .'- FIELD_STABILITY_VALIDATE: field stability check'."\n" + .'- FIELD_FLUCTUATION_VALIDATE: field fluctuation check'."\n" + .'- CUSTOM_STATISTICAL_VALIDATE: custom statistical metric check'."\n" + .'- CUSTOM_DATA_DETAILS_VALIDATE: custom data details check'."\n" + .'- DATASOURCE_AVAILABLE_CHECK: data source connectivity monitoring'."\n" + .'- TABLE_SCHEMA_CHECK: table schema change monitoring'."\n" + .'- REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison'."\n" + .'- REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring'."\n" + .'- REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison.', 'type' => 'array', - 'items' => [ - 'title' => '质量负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], + 'items' => ['title' => '', 'description' => 'The templatetype. Valid values:'."\n" + .'- FIELD_NULL_VALUE_VALIDATE: field null value check'."\n" + .'- FIELD_EMPTY_STRING_VALIDATE: field empty character string check'."\n" + .'- FIELD_UNIQUE_VALIDATE: field uniqueness check'."\n" + .'- FIELD_GROUP_COUNT_VALIDATE: field unique value count check'."\n" + .'- FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count check'."\n" + .'- FUNCTION_TIME_COMPARE: time function comparison'."\n" + .'- SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison'."\n" + .'- DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison'."\n" + .'- FIELD_FORMAT_VALIDATE: field format check'."\n" + .'- FIELD_LENGTH_VALIDATE: field length check'."\n" + .'- FIELD_VALUE_RANGE_VALIDATE: field value range check'."\n" + .'- CODE_TABLE_COMPARE: lookup table reference comparison'."\n" + .'- STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison'."\n" + .'- SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison'."\n" + .'- CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison'."\n" + .'- TABLE_STABILITY_VALIDATE: table stability check'."\n" + .'- TABLE_FLUCTUATION_VALIDATE: table fluctuation check'."\n" + .'- FIELD_STABILITY_VALIDATE: field stability check'."\n" + .'- FIELD_FLUCTUATION_VALIDATE: field fluctuation check'."\n" + .'- CUSTOM_STATISTICAL_VALIDATE: custom statistical metric check'."\n" + .'- CUSTOM_DATA_DETAILS_VALIDATE: custom data details check'."\n" + .'- DATASOURCE_AVAILABLE_CHECK: data source connectivity monitoring'."\n" + .'- TABLE_SCHEMA_CHECK: table schema change monitoring'."\n" + .'- REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison'."\n" + .'- REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring'."\n" + .'- REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison.', 'type' => 'string', 'required' => false, 'example' => 'FIELD_NULL_VALUE_VALIDATE'], 'required' => false, + 'example' => '', ], - 'StatusList' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', + 'WatchTypeList' => [ + 'title' => '', + 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table'."\n" + .'- DATASOURCE_TABLE: full-domain table'."\n" + .'- DATASOURCE: data source'."\n" + .'- INDEX: metric'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'array', - 'items' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'required' => false, - ], - 'BizDate' => [ - 'title' => '业务日期过滤', - 'description' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table'."\n" + .'- DATASOURCE_TABLE: full-domain table'."\n" + .'- DATASOURCE: data source'."\n" + .'- INDEX: metric'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => false, 'example' => 'TABLE'], 'required' => false, - 'example' => '2025-06-30', - ], - 'Keyword' => [ - 'title' => '搜索关键词: 监控表名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'example' => '', ], - 'DataSourceOwnerList' => [ - 'title' => '数据源负责人', - 'description' => '', + 'TemplateSourceList' => [ + 'title' => '', + 'description' => 'The template source. Valid values:'."\n" + .'- SYSTEM: system template'."\n" + .'- CUSTOM: custom template.', 'type' => 'array', - 'items' => [ - 'title' => '数据源负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], + 'items' => ['title' => '', 'description' => 'The template source. Valid values:'."\n" + .'- SYSTEM: system template'."\n" + .'- CUSTOM: custom template.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM'], 'required' => false, + 'example' => '', ], - 'TableOwnerList' => [ - 'title' => '表负责人', - 'description' => '', + 'CurrentUserOwned' => ['title' => '', 'description' => 'Specifies whether to query only templates owned by the current user.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'TemplateOwnerList' => [ + 'title' => '', + 'description' => 'The template owners.', 'type' => 'array', - 'items' => [ - 'title' => '表负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], - 'required' => false, - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['title' => '', 'description' => 'The template owners.', 'type' => 'string', 'required' => false, 'example' => '30012011'], 'required' => false, - 'example' => '20', + 'example' => '', ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. Template name filtering is supported.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], - 'QualityWatchTaskList' => [ - 'title' => '分页质量模板列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'QualityTemplateList' => [ + 'title' => '', + 'description' => 'The list of quality templates.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '监控任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StartTime' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00:00', - ], - 'EndTime' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 20:00:00', - ], - 'QualityOwner' => [ - 'title' => '质量负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', + 'Id' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The templatetype. Valid values:'."\n" + .'- FIELD_NULL_VALUE_VALIDATE: field null value check'."\n" + .'- FIELD_EMPTY_STRING_VALIDATE: field empty character string check'."\n" + .'- FIELD_UNIQUE_VALIDATE: field uniqueness check'."\n" + .'- FIELD_GROUP_COUNT_VALIDATE: field unique value count check'."\n" + .'- FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count check'."\n" + .'- FUNCTION_TIME_COMPARE: time function comparison'."\n" + .'- SINGLE_TABLE_TIME_COMPARE: non-partitioned table time field comparison'."\n" + .'- DOUBLE_TABLE_TIME_COMPARE: two-table time field comparison'."\n" + .'- FIELD_FORMAT_VALIDATE: field format check'."\n" + .'- FIELD_LENGTH_VALIDATE: field length check'."\n" + .'- FIELD_VALUE_RANGE_VALIDATE: field value range check'."\n" + .'- CODE_TABLE_COMPARE: lookup table reference comparison'."\n" + .'- STANDARD_CODE_TABLE_COMPARE: data standard lookup table reference comparison'."\n" + .'- SINGLE_TABLE_FIELD_VALUE_COMPARE: non-partitioned table field value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: non-partitioned table field statistical value consistency comparison'."\n" + .'- SINGLE_TABLE_FIELD_EXP_COMPARE: non-partitioned table field business logic consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_VALUE_COMPARE: two-table field value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: two-table field statistical value consistency comparison'."\n" + .'- CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source two-table field statistical value consistency comparison'."\n" + .'- DOUBLE_TABLE_FIELD_EXP_COMPARE: two-table field business logic consistency comparison'."\n" + .'- TABLE_STABILITY_VALIDATE: table stability check'."\n" + .'- TABLE_FLUCTUATION_VALIDATE: table fluctuation check'."\n" + .'- FIELD_STABILITY_VALIDATE: field stability check'."\n" + .'- FIELD_FLUCTUATION_VALIDATE: field fluctuation check'."\n" + .'- CUSTOM_STATISTICAL_VALIDATE: custom statistical metric check'."\n" + .'- CUSTOM_DATA_DETAILS_VALIDATE: custom data details check'."\n" + .'- DATASOURCE_AVAILABLE_CHECK: data source connectivity monitoring'."\n" + .'- TABLE_SCHEMA_CHECK: table schema change monitoring'."\n" + .'- REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison'."\n" + .'- REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring'."\n" + .'- REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-link comparison.', 'type' => 'string', 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'TypeName' => ['title' => '', 'description' => 'The display name of the templatetype.', 'type' => 'string', 'example' => '字段空值校验'], + 'Description' => ['title' => '', 'description' => 'The template description.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The user ID of the owner.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.', 'type' => 'string', 'example' => 'test'], + 'Catalog' => ['title' => '', 'description' => 'The template category. Valid values:'."\n" + .'- CONSISTENT: consistency'."\n" + .'- EFFECTIVE: validity'."\n" + .'- TIMELINESE: timeliness'."\n" + .'- ACCURATE: accuracy'."\n" + .'- UNIQUENESS: uniqueness'."\n" + .'- COMPLETENESS: completeness'."\n" + .'- STABILITY: stability'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'example' => 'CONSISTENT'], + 'CatalogName' => ['title' => '', 'description' => 'The display name of the template category.', 'type' => 'string', 'example' => '一致性'], + 'SupportAllDataSourceType' => ['title' => '', 'description' => 'Indicates whether all data source types are supported.', 'type' => 'boolean', 'example' => ''], + 'SupportDataSourceTypeList' => [ + 'title' => '', + 'description' => 'The supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', 'type' => 'string', 'example' => 'MySQL'], + 'example' => '', ], - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '质量规则Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - 'Status' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', + 'IsSystemTemplate' => ['title' => '', 'description' => 'Indicates whether the template is a system template.', 'type' => 'boolean', 'example' => ''], + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'The rule configuration key-value pairs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['title' => '', 'description' => 'The control type.', 'type' => 'string', 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'The property name.', 'type' => 'string', 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'The property value.', 'type' => 'string', 'example' => 'abc'], + ], + 'example' => '', + ], + 'example' => '', ], + 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], + 'ModifierName' => ['title' => '', 'description' => 'The name of the last modifier.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"SupportDataSourceTypeList\\": [\\n \\"MySQL\\"\\n ],\\n \\"IsSystemTemplate\\": false,\\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' => 'Query quality templates by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListQualityTemplates' => [ - 'summary' => '分页查询质量模板。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListQualityWatchTasks' => [ + 'summary' => 'Queries quality monitoring nodes by paged query.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -41034,381 +30064,311 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The paged query conditions.', 'type' => 'object', 'properties' => [ - 'CatalogList' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', + 'WatchTypeList' => [ + 'title' => '', + 'description' => 'The monitored object types. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: global table.'."\n" + .'- DATASOURCE: data source.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'array', - 'items' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CONSISTENT', - ], + 'items' => ['title' => '', 'description' => 'The monitored object types. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: global table.'."\n" + .'- DATASOURCE: data source.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => false, 'example' => 'TABLE'], 'required' => false, + 'example' => '', ], - 'SupportDataSourceTypeList' => [ - 'title' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', - 'description' => '', + 'DataSourceIdList' => [ + 'title' => '', + 'description' => 'The data source IDs.', 'type' => 'array', - 'items' => [ - 'title' => '支持的数据源类型: MAX_COMPUTE、MYSQL、HIVE等', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MAX_COMPUTE', - ], + 'items' => ['title' => '', 'description' => 'The data source IDs.', 'type' => 'string', 'required' => false, 'example' => '1'], 'required' => false, + 'example' => '', ], - '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' => '', + 'DataSourceScopeList' => [ + 'title' => '', + 'description' => 'The data source scopes. Valid values:'."\n" + .'- STREAMING: real-time only.'."\n" + .'- OFFLINE: offline only.'."\n" + .'- ALL: real-time and offline.', '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], + 'items' => ['title' => '', 'description' => 'The data source scopes. Valid values:'."\n" + .'- STREAMING: real-time only.'."\n" + .'- OFFLINE: offline only.'."\n" + .'- ALL: real-time and offline.', 'type' => 'string', 'required' => false, 'example' => 'ALL'], 'required' => false, + 'example' => '', ], - 'WatchTypeList' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', + 'DataSourceTypeList' => [ + 'title' => '', + 'description' => 'The data source types, such as MAX_COMPUTE, HADOOP, and MYSQL.', 'type' => 'array', - 'items' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TABLE', - ], + 'items' => ['title' => '', 'description' => 'The data source types, such as MAX_COMPUTE, HADOOP, and MYSQL.', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE'], 'required' => false, + 'example' => '', ], - 'TemplateSourceList' => [ - 'title' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', - 'description' => '', + 'ErrorRuleStrengthList' => [ + 'title' => '', + 'description' => 'The rule exception types. Valid values:'."\n" + .'- STRONG: strong.'."\n" + .'- WEAK: weak.', 'type' => 'array', - 'items' => [ - 'title' => '模板来源，SYSTEM 系统模板、CUSTOM 自定义模板', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOM', - ], + 'items' => ['title' => '', 'description' => 'The rule exception types. Valid values:'."\n" + .'- STRONG: strong.'."\n" + .'- WEAK: weak.', 'type' => 'string', 'required' => false, 'example' => 'STRONG'], 'required' => false, + 'example' => '', ], - 'CurrentUserOwned' => [ - 'title' => '是否当前用户负责的模板', - 'description' => '', - 'type' => 'boolean', + 'TableTypeList' => [ + 'title' => '', + 'description' => 'The table types. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: logical fact table.'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table.'."\n" + .'- LOGIC_LABEL_TABLE: logical label table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The table types. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: logical fact table.'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table.'."\n" + .'- LOGIC_LABEL_TABLE: logical label table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => false, 'example' => 'LOGIC_DIM_TABLE'], 'required' => false, + 'example' => '', ], - 'TemplateOwnerList' => [ - 'title' => '模板负责人', - 'description' => '', + 'ProjectNameList' => [ + 'title' => '', + 'description' => 'The project names.', 'type' => 'array', - 'items' => [ - 'title' => '模板负责人', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30012011', - ], + 'items' => ['title' => '', 'description' => 'The project names.', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, + 'example' => '', ], - 'Keyword' => [ - 'title' => '搜索词筛选，支持模板名称', - 'description' => '', - 'type' => 'string', + 'BizUnitNameList' => [ + 'title' => '', + 'description' => 'The business unit names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business unit names.', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, - 'example' => 'abc', + 'example' => '', ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'CurrentUserOwned' => ['title' => '', 'description' => 'Specifies whether to query only the quality monitoring node objects owned by the current user.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'QualityOwnerList' => [ + 'title' => '', + 'description' => 'The quality owners.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The quality owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], 'required' => false, - 'example' => '1', + 'example' => '', ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'StatusList' => [ + 'title' => '', + 'description' => 'The task statuses. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: running.'."\n" + .'- SUCCESS: succeeded.'."\n" + .'- FAILED: failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The task statuses. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: running.'."\n" + .'- SUCCESS: succeeded.'."\n" + .'- FAILED: failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'required' => false, + 'example' => '', + ], + 'BizDate' => ['title' => '', 'description' => 'The business date filter.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30'], + 'Keyword' => ['title' => '', 'description' => 'The search keyword, which is the name of the monitored table.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'DataSourceOwnerList' => [ + 'title' => '', + 'description' => 'The data source owners.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The data source owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], + 'required' => false, + 'example' => '', + ], + 'TableOwnerList' => [ + 'title' => '', + 'description' => 'The table owners.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The table owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], 'required' => false, - 'example' => '20', + 'example' => '', ], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error details from the backend.', 'type' => 'string', 'example' => 'internal error'], 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], - 'QualityTemplateList' => [ - 'title' => '分页质量模板列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'QualityWatchTaskList' => [ + 'title' => '', + 'description' => 'The list of quality watchtasks.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '模板Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'TypeName' => [ - 'title' => '模板类型展示名', - 'description' => '', - 'type' => 'string', - 'example' => '字段空值校验', - ], - 'Description' => [ - 'title' => '模板描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '归属人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '归属人名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'Id' => ['title' => '', 'description' => 'The quality watchtask ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'WatchId' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StartTime' => ['title' => '', 'description' => 'The start time, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-30 08:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time, in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2025-06-30 20:00:00'], + 'QualityOwner' => ['title' => '', 'description' => 'The user ID of the quality owner.', 'type' => 'string', 'example' => '30012011'], + 'QualityOwnerName' => ['title' => '', 'description' => 'The name of the quality owner.', 'type' => 'string', 'example' => 'test'], + 'RuleCountInfo' => [ + 'title' => '', + 'description' => 'The quality rule count information.', + 'type' => 'object', + 'properties' => [ + 'ValidateRuleCount' => [ + 'title' => '', + 'description' => 'The validation rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + 'StrongRuleCount' => [ + 'title' => '', + 'description' => 'The strong rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + 'WeakRuleCount' => [ + 'title' => '', + 'description' => 'The weak rule count.', + 'type' => 'object', + 'properties' => [ + 'TotalRuleCount' => ['title' => '', 'description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FinishedRuleCount' => ['title' => '', 'description' => 'The number of rules that have been executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ErrorRuleCount' => ['title' => '', 'description' => 'The number of rules that failed to execute.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SuccessRuleCount' => ['title' => '', 'description' => 'The number of rules that were executed successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Catalog' => [ - 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'ModifierName' => [ - 'title' => '最近修改人名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'RuleIdList' => [ + 'title' => '', + 'description' => 'The quality rule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The quality rule IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'example' => '', ], + 'Status' => ['title' => '', 'description' => 'The task statuses. Valid values:'."\n" + .'- NOT_RUN: not executed.'."\n" + .'- WAITING: waiting.'."\n" + .'- RUNNING: running.'."\n" + .'- SUCCESS: succeeded.'."\n" + .'- FAILED: failed.'."\n" + .'- CANCEL: canceled.'."\n" + .'- TIMEOUT: timed out.'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'example' => 'RUNNING'], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'BizDateFormat' => ['title' => '', 'description' => 'The business date format.', 'type' => 'string', 'example' => 'yyyy-MM-dd'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'List quality monitoring nodes by paged query', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListQualityRules' => [ - 'summary' => '分页查询质量规则。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListQualityWatches' => [ + 'summary' => 'Performs a paged query of quality monitored objects.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -41417,680 +30377,365 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The paged query conditions.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'WatchTypeList' => [ + 'title' => '', + 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table'."\n" + .'- DATASOURCE_TABLE: full-domain table'."\n" + .'- DATASOURCE: data source'."\n" + .'- INDEX: metric'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table'."\n" + .'- DATASOURCE_TABLE: full-domain table'."\n" + .'- DATASOURCE: data source'."\n" + .'- INDEX: metric'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => false, 'example' => 'TABLE'], 'required' => false, - 'example' => '1', + 'example' => '', ], 'StatusList' => [ - 'title' => '规则生效状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', + 'title' => '', + 'description' => 'The status of the monitored object. Valid values:'."\n" + .'- ENABLE: enabled'."\n" + .'- DISABLE: disabled.', 'type' => 'array', - 'items' => [ - 'title' => '规则生效状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLE', - ], + 'items' => ['title' => '', 'description' => 'The status of the monitored object. Valid values:'."\n" + .'- ENABLE: enabled'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'required' => false, 'example' => 'ENABLE'], 'required' => false, + 'example' => '', ], - 'CatalogList' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', + 'LatestWatchTaskStatusList' => [ + 'title' => '', + 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting'."\n" + .'- RUNNING: executing'."\n" + .'- SUCCESS: executed successfully'."\n" + .'- FAILED: execution failed'."\n" + .'- CANCEL: canceled'."\n" + .'- TIMEOUT: timed out'."\n" + .'- OFFLINE: offline.', 'type' => 'array', - 'items' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CONSISTENT', - ], + 'items' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + .'- NOT_RUN: not executed'."\n" + .'- WAITING: waiting'."\n" + .'- RUNNING: executing'."\n" + .'- SUCCESS: executed successfully'."\n" + .'- FAILED: execution failed'."\n" + .'- CANCEL: canceled'."\n" + .'- TIMEOUT: timed out'."\n" + .'- OFFLINE: offline.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'required' => false, + 'example' => '', ], - 'TemplateIdList' => [ - 'title' => '规则模板', - 'description' => '', + 'CurrentUserOwned' => ['title' => '', 'description' => 'Specifies whether to query only monitored objects owned by the current user.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'QualityOwnerList' => [ + 'title' => '', + 'description' => 'The quality owners.', 'type' => 'array', - 'items' => [ - 'title' => '规则模板', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => 'The quality owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], 'required' => false, + 'example' => '', ], - 'RuleStrengthList' => [ - 'title' => '规则强度: STRONG 强、WEAK 弱', - 'description' => '', + 'TableOwnerList' => [ + 'title' => '', + 'description' => 'The table owners.', 'type' => 'array', - 'items' => [ - 'title' => '规则强度: STRONG 强、WEAK 弱', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'STRONG', - ], + 'items' => ['title' => '', 'description' => 'The table owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], 'required' => false, + 'example' => '', ], - 'TestRunTaskValidateResultList' => [ - 'title' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', - 'description' => '', + 'TableTypeList' => [ + 'title' => '', + 'description' => 'The table type. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table'."\n" + .'- LOGIC_FACT_TABLE: logical fact table'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table'."\n" + .'- LOGIC_LABEL_TABLE: logical label table'."\n" + .'- PHYSICAL_TABLE: physical table'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'array', - 'items' => [ - 'title' => '规则试跑校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], + 'items' => ['title' => '', 'description' => 'The table type. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table'."\n" + .'- LOGIC_FACT_TABLE: logical fact table'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table'."\n" + .'- LOGIC_LABEL_TABLE: logical label table'."\n" + .'- PHYSICAL_TABLE: physical table'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => false, 'example' => 'LOGIC_DIM_TABLE'], 'required' => false, + 'example' => '', ], - 'TestRunTaskStatusList' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', + 'DataSourceIdList' => [ + 'title' => '', + 'description' => 'The data source IDs.', 'type' => 'array', - 'items' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], + 'items' => ['title' => '', 'description' => 'The data source IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], 'required' => false, + 'example' => '', ], - 'Keyword' => [ - 'title' => '搜索词筛选，支持规则名称和校验对象搜索', - 'description' => '', - 'type' => 'string', + 'DataSourceTypeList' => [ + 'title' => '', + 'description' => 'The data source type, such as MAX_COMPUTE, HADOOP, or MYSQL.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The data source type, such as MAX_COMPUTE, HADOOP, or MYSQL.', 'type' => 'string', 'required' => false, 'example' => 'MAX_COMPUTE'], 'required' => false, - 'example' => 'test', + 'example' => '', ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'BizUnitNameList' => [ + 'title' => '', + 'description' => 'The business unit names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business unit names.', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, - 'example' => '1', + 'example' => '', ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'ProjectNameList' => [ + 'title' => '', + 'description' => 'The project names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The project names.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', + ], + 'DataSourceScopeList' => [ + 'title' => '', + 'description' => 'The data source scope. Valid values:'."\n" + .'- STREAMING: real-time only'."\n" + .'- OFFLINE: offline only'."\n" + .'- ALL: real-time and offline.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The data source scope. Valid values:'."\n" + .'- STREAMING: real-time only'."\n" + .'- OFFLINE: offline only'."\n" + .'- ALL: real-time and offline.', 'type' => 'string', 'required' => false, 'example' => 'ALL'], + 'required' => false, + 'example' => '', + ], + 'DataSourceOwnerList' => [ + 'title' => '', + 'description' => 'The data source owners.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The data source owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], + 'required' => false, + 'example' => '', + ], + 'IndexOwnerList' => [ + 'title' => '', + 'description' => 'The metric owners.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The metric owners.', 'type' => 'string', 'required' => false, 'example' => '30001011'], + 'required' => false, + 'example' => '', + ], + 'IndexComputeTypeList' => [ + 'title' => '', + 'description' => 'The metric computation type. Valid values:'."\n" + .'- AUTO: automated coding'."\n" + .'- CUSTOM: expert coding'."\n" + .'- MOUNT: external table registration'."\n" + .'- COMBINE: derived metric specific.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The metric computation type. Valid values:'."\n" + .'- AUTO: automated coding'."\n" + .'- CUSTOM: expert coding'."\n" + .'- MOUNT: external table registration'."\n" + .'- COMBINE: derived metric specific.', 'type' => 'string', 'required' => false, 'example' => 'AUTO'], 'required' => false, - 'example' => '20', + 'example' => '', ], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. This is the name of the monitored table.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], - 'QualityRuleList' => [ - 'title' => '分页质量规则任务列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'QualityWatchList' => [ + 'title' => '', + 'description' => 'The paged list of quality watchtasks.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '质量规则Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'title' => '质量规则名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'title' => '质量规则状态: ENABLE，DISABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'ENABLE', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Strength' => [ - 'title' => '规则强弱: STRONG、WEAK', - 'description' => '', - 'type' => 'string', - 'example' => 'STRONG', - ], - 'CatalogList' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'example' => 'CONSISTENT', + 'Type' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table'."\n" + .'- DATASOURCE_TABLE: full-domain table'."\n" + .'- DATASOURCE: data source'."\n" + .'- INDEX: metric'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'TABLE'], + 'Id' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Name' => ['title' => '', 'description' => 'The monitored object name.', 'type' => 'string', 'example' => 'test'], + 'Status' => ['title' => '', 'description' => 'The status. Valid values:'."\n" + .'- ENABLE'."\n" + .'- DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'DataSourceInfo' => [ + 'title' => '', + 'description' => 'The data source details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The data source IDs.', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The data source type, such as MAX_COMPUTE or HADOOP.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The owner user ID.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The owner name.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- PROD'."\n" + .'- DEV.', 'type' => 'string', 'example' => 'DEV'], ], + 'example' => '', ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TemplateScope' => [ - 'title' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'WatchId' => [ - 'title' => '所属监控ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'TableInfo' => [ + 'title' => '', + 'description' => 'The monitored table object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type. Valid values:'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table'."\n" + .'- LOGIC_FACT_TABLE: logical fact table'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table'."\n" + .'- LOGIC_LABEL_TABLE: logical label table'."\n" + .'- PHYSICAL_TABLE: physical table'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'example' => 'LOGIC_DIM_TABLE'], + 'Catalog' => ['title' => '', 'description' => 'The table catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + 'Owner' => ['title' => '', 'description' => 'The owner user ID.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The owner name.', 'type' => 'string', 'example' => 'test'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'DataSourceType' => ['title' => '', 'description' => 'The data source type.', 'type' => 'string', 'example' => 'MAX_COMPUTE'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'example' => '22'], + 'IsPartitionTable' => ['title' => '', 'description' => 'Indicates whether the table is a partitioned table.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], - 'EnableErrorArchive' => [ - 'title' => '是否启动异常归档', - 'description' => '', - 'type' => 'boolean', - ], - 'ValidateConditionList' => [ - 'title' => '校验条件列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '条件节点id', - 'description' => '', - 'type' => 'string', - 'example' => '268', - ], - 'Type' => [ - 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', - 'description' => '', - 'type' => 'string', - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - 'TestRunRuleTaskId' => [ - 'title' => '最近一次试跑任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'TestRunRuleTaskStatus' => [ - 'title' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'TestRunRuleValidateResult' => [ - 'title' => '试跑校验是否通过', - 'description' => '', - 'type' => 'boolean', - ], - 'ScheduleBindList' => [ - 'title' => '规则绑定的调度列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ScheduleId' => [ - 'title' => '调度Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', - 'description' => '', - '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' => '', - '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', + 'IndexInfo' => [ + 'title' => '', + 'description' => 'The metric details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'Catalog' => ['title' => '', 'description' => 'The metric catalog.', 'type' => 'string', 'example' => 'test'], + 'Id' => ['title' => '', 'description' => 'The metric ID.', 'type' => 'string', 'example' => '11'], + 'Guid' => ['title' => '', 'description' => 'The metric GUID.', 'type' => 'string', 'example' => '1121'], + 'Name' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'logic'], + 'DisplayName' => ['title' => '', 'description' => 'The metric display name.', 'type' => 'string', 'example' => 'logic'], + 'GranularityId' => ['title' => '', 'description' => 'The statistical granularity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '18755764'], + 'GranularityDisplayName' => ['title' => '', 'description' => 'The statistical granularity name.', 'type' => 'string', 'example' => '全站汇总表'], + 'ComputeType' => ['title' => '', 'description' => 'The metric computation type. Valid values:'."\n" + .'- AUTO'."\n" + .'- CUSTOM'."\n" + .'- MOUNT'."\n" + .'- COMBINE.', 'type' => 'string', 'example' => 'AUTO'], + 'CellSumLogicTableName' => ['title' => '', 'description' => 'The cell aggregate table name.', 'type' => 'string', 'example' => 'dws_all'], + 'Type' => ['title' => '', 'description' => 'The metric type. Valid values:'."\n" + .'- INDEX.', 'type' => 'string', 'example' => 'INDEX'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1121'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The owner user ID.', 'type' => 'string', 'example' => '30012011'], + 'OwnerName' => ['title' => '', 'description' => 'The owner name.', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'DateType' => ['title' => '', 'description' => 'The metric data type.', 'type' => 'string', 'example' => 'bigint'], + ], + 'example' => '', ], + 'QualityOwner' => ['title' => '', 'description' => 'The quality owner user ID.', 'type' => 'string', 'example' => '30012011'], + 'QualityOwnerName' => ['title' => '', 'description' => 'The quality owner display name.', 'type' => 'string', 'example' => 'test'], + 'LatestWatchTaskId' => ['title' => '', 'description' => 'The record ID of the latest quality watchtask for the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LatestWatchTaskStatus' => ['title' => '', 'description' => 'The record status of the latest quality watchtask for the monitored object.', 'type' => 'string', 'example' => 'SUCCESS'], + 'RuleCount' => ['title' => '', 'description' => 'The number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'EnabledRuleCount' => ['title' => '', 'description' => 'The number of enabled rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Creator' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '30012011'], + 'CreatorName' => ['title' => '', 'description' => 'The creator name.', 'type' => 'string', 'example' => 'test'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Modifier' => ['title' => '', 'description' => 'The user ID of the last modifier.', 'type' => 'string', 'example' => '30012011'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false\\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' => 'Paged query of quality monitored objects', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListQualityRuleTasks' => [ - 'summary' => '分页查询质量规则任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ListResourcePermissionOperationLog' => [ + 'summary' => 'Retrieves a paginated list of permission operation logs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -42098,348 +30743,215 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'ListQuery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The paged request parameters.', 'type' => 'object', 'properties' => [ - 'WatchTaskId' => [ - 'title' => '监控表任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'CatalogList' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则类型: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CONSISTENT', - ], - 'required' => false, - ], - 'RuleStrengthList' => [ - 'title' => '规则强度: STRONG 强、WEAK 弱', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则强度: STRONG 强、WEAK 弱', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'STRONG', - ], - 'required' => false, - ], - 'StatusList' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'required' => false, - ], - 'ValidateResultList' => [ - 'title' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '校验结果: NOT_RUN 未执行、WAITING 等待执行、RUNNING 执行中、PASS 通过、NOT_PASS 不通过、FAILED 执行失败、OFFLINE 掉线,需要重新拉起、CANCEL 任务取消、TIMEOUT 任务超时', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'required' => false, - ], - 'RuleTagList' => [ - 'title' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则标签: DEFAULT 默认标签、DATA_STANDARD_MANUAL 手工创建的标准规则、、DATA_STANDARD_AUTO 标准自动创建的质量规则、PIPELINE PIPELINE创建的规则、DATA_MODELING 数据建模', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'TabType' => ['title' => '', 'description' => 'The tab name. Valid values:'."\n" + .'- TABLE: table'."\n" + .'- DATASOURCE: datasource.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'SearchText' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'PageResult' => [ - 'title' => '分页查询结果', - 'description' => '', + 'title' => '', + 'description' => 'The paging query result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], - 'QualityRuleTaskList' => [ - 'title' => '分页质量规则任务列表', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '121'], + 'Data' => [ + 'title' => '', + 'description' => 'The paginated records.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => '', + 'description' => 'Operation logs.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '所属监控ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'WatchTaskId' => [ - 'title' => '监控任务ID，试跑的规则任务这个ID为空', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'title' => '规则任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RuleId' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - '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', + 'OperateId' => ['title' => '', 'description' => 'The operation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123133'], + 'OperateType' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n" + .'- APPLY: Apply for permissions.'."\n" + .'- GRANT: Grant permissions.', 'type' => 'string', 'example' => 'APPLY'], + 'ResourceInfo' => [ + 'title' => '', + 'description' => 'The permission resource.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The permission resource ID.', 'type' => 'string', 'example' => 'a.tb1'], + 'Name' => ['title' => '', 'description' => 'The permission resource name.', 'type' => 'string', 'example' => 'tb1'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the resource.', 'type' => 'string', 'example' => 'tb1'], + 'Type' => ['title' => '', 'description' => 'The resource type. Valid values:'."\n" + .'- PHYSICAL_TABLE: physical table'."\n" + .'- PHYSICAL_VIEW: physical view'."\n" + .'- LOGICAL_TABLE: fact logical table'."\n" + .'- LOGICAL_VIEW: fact logical view'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table'."\n" + .'- REALTIME_MIRROR_TABLE: real-time meta table'."\n" + .'- DATASOURCE: datasource.', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'Env' => ['title' => '', 'description' => 'The resource environment. Valid values:'."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + 'BizUnitInfo' => [ + 'title' => '', + 'description' => 'The business unit information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Id', 'type' => 'string', 'example' => '121323'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'xx'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'xx'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values: '."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', + ], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'The project information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1123131'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'xx'], + 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'xx'], + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values: '."\n" + .'- DEV'."\n" + .'- PROD.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 00:00:00', + 'Account' => [ + 'title' => '', + 'description' => 'The operator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The account ID.'."\n" + .'- Individual account: the userId on the Dataphin side.'."\n" + .'- Production account: the UserId obtained by calling the GetProjectProduceUser operation.'."\n" + .'- User group: the user group ID obtained by calling the ListUserGroup operation.', 'type' => 'string', 'example' => '1212131'], + 'Name' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => 'xx'], + 'Type' => ['title' => '', 'description' => 'The authorization account type. Valid values:'."\n" + .'- PERSONAL: individual account'."\n" + .'- PRODUCE: production account'."\n" + .'- USER_GROUP: user group.', 'type' => 'string', 'example' => 'PERSONAL'], + ], + 'example' => '', ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 00:00:00', + 'TargetAccount' => [ + 'title' => '', + 'description' => 'The authorized object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => '1212131'], + 'Name' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => 'xx'], + 'Type' => ['title' => '', 'description' => 'The authorized account type.', 'type' => 'string', 'example' => 'PERSONAL'], + ], + 'example' => '', ], - 'Modifier' => [ - 'title' => '最近修改用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', + 'Reason' => ['title' => '', 'description' => 'The reason.', 'type' => 'string', 'example' => 'xx测试'], + 'OperateTime' => ['title' => '', 'description' => 'The operation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710012121000'], + 'Period' => [ + 'title' => '', + 'description' => 'The validity period settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The validity period type. Valid values:'."\n" + .'- CUSTOM: custom'."\n" + .'- LONG_TERM: permanently valid'."\n" + .'- DAYS_30: valid for 30 days'."\n" + .'- DAYS_90: valid for 90 days'."\n" + .'- DAYS_180: valid for 180 days.', 'type' => 'string', 'example' => 'CUSTOM'], + 'EndTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '1712000000000'], + ], + 'example' => '', ], + 'AuthScope' => ['title' => '', 'description' => 'The authorization scope of the table. Valid values:'."\n" + .'- selectTable: specified table'."\n" + .'- projectAllTable: all tables in the project'."\n" + .'- bizUnitAllLogicTable: all logical tables in the business unit.', 'type' => 'string', 'example' => 'selectTable'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List permission operation logs by page', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityWatchTaskLog' => [ - 'summary' => '获取监控任务对象的日志内容。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListResourcePermissionOperationLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListResourcePermissions' => [ + 'summary' => 'Retrieves permission authorization records with pagination.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -42447,930 +30959,989 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'WatchTaskId', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '监控任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Paginated request.', + 'type' => 'object', + 'properties' => [ + 'TabType' => ['title' => '', 'description' => 'Tab name. Table: TABLE. Data source: DATASOURCE.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'SearchText' => ['title' => '', 'description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Page' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a normal request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '121'], + 'Data' => [ + 'title' => '', + 'description' => 'Paginated list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Resource permission details.', + 'type' => 'object', + 'properties' => [ + 'RecordId' => ['title' => '', 'description' => 'Record ID.', 'type' => 'string', 'example' => '12123111'], + 'ResourceInfo' => [ + 'title' => '', + 'description' => 'Permission resource.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Permission resource ID.', 'type' => 'string', 'example' => 'a.tb1'], + 'Name' => ['title' => '', 'description' => 'Permission resource name.', 'type' => 'string', 'example' => 'tb1'], + 'DisplayName' => ['title' => '', 'description' => 'Resource display name.', 'type' => 'string', 'example' => 'tb1'], + 'Type' => ['title' => '', 'description' => 'Resource type. Valid values: PHYSICAL_TABLE, PHYSICAL_VIEW, LOGICAL_TABLE, LOGICAL_VIEW, REALTIME_LOGICAL_TABLE, REALTIME_MIRROR_TABLE, and DATASOURCE.', 'type' => 'string', 'example' => 'PHYSICAL_TABLE'], + 'Env' => ['title' => '', 'description' => 'Resource environment type. Development: DEV. Production: PROD.', 'type' => 'string', 'example' => 'DEV'], + 'BizUnitInfo' => [ + 'title' => '', + 'description' => 'Business unit.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => '121323'], + 'Name' => ['title' => '', 'description' => 'Name.', 'type' => 'string', 'example' => 'xx'], + 'DisplayName' => ['title' => '', 'description' => 'Display name.', 'type' => 'string', 'example' => 'xx'], + 'Env' => ['title' => '', 'description' => 'Environment identifier. Development: DEV. Production: PROD.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', + ], + 'ProjectInfo' => [ + 'title' => '', + 'description' => 'Project.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1123131'], + 'Name' => ['title' => '', 'description' => 'Name.', 'type' => 'string', 'example' => 'xx'], + 'DisplayName' => ['title' => '', 'description' => 'Display name.', 'type' => 'string', 'example' => 'xx'], + 'Env' => ['title' => '', 'description' => 'Environment identifier. Development: DEV. Production: PROD.', 'type' => 'string', 'example' => 'DEV'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'TargetAccount' => [ + 'title' => '', + 'description' => 'Authorized object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Personal account: the userId on the Dataphin side. Production account: the UserId obtained by calling the GetProjectProduceUser operation. User group: the user group ID obtained by calling the ListUserGroup operation.', 'type' => 'string', 'example' => '1212131'], + 'Name' => ['title' => '', 'description' => 'Personal account: the userId on the Dataphin side. Production account: the UserId obtained by calling the GetProjectProduceUser operation. User group: the user group ID obtained by calling the ListUserGroup operation.', 'type' => 'string', 'example' => 'xx'], + 'Type' => ['title' => '', 'description' => 'Authorization account type. Valid values: PERSONAL (personal account), PRODUCE (production account), and USER_GROUP (user group).', 'type' => 'string', 'example' => 'PERSONAL'], + ], + 'example' => '', + ], + 'Period' => [ + 'title' => '', + 'description' => 'Validity period settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Validity period type. Custom: CUSTOM. Long-term: LONG_TERM.', 'type' => 'string', 'example' => 'CUSTOM'], + 'EndTime' => ['title' => '', 'description' => 'Expiration time.', 'type' => 'string', 'example' => '1712000000000'], + ], + 'example' => '', + ], + 'AuthScope' => ['title' => '', 'description' => 'Authorization scope of the table. Specified table: selectTable. All tables in the project: projectAllTable. All logical tables in the business unit: bizUnitAllLogicTable.', 'type' => 'string', 'example' => 'selectTable'], + 'PermissionPeriodList' => [ + 'title' => '', + 'description' => 'List of validity periods for different permission types.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Permission validity period.', + 'type' => 'object', + 'properties' => [ + 'PermissionType' => ['title' => '', 'description' => 'Permission type.', 'type' => 'string', 'example' => 'SELECT'], + 'Period' => [ + 'title' => '', + 'description' => 'Validity period settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Validity period type. Custom: CUSTOM. Long-term: LONG_TERM.', 'type' => 'string', 'example' => 'CUSTOM'], + 'EndTime' => ['title' => '', 'description' => 'Expiration time.', 'type' => 'string', 'example' => '1712000000000'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieves permission authorization records with pagination', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityWatchTask' => [ - 'summary' => '获取监控任务对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListResourcePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListRowPermission' => [ + 'summary' => 'Performs a paged query of row-level permissions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'WatchTaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '监控任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'name' => 'PageRowPermissionQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The request command.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => '业务'], + 'PageNum' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'WatchTaskInfo' => [ - 'title' => '监控任务对象详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '监控任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StartTime' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00:00', - ], - 'EndTime' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 20:00:00', - ], - 'QualityOwner' => [ - 'title' => '质量负责人用户ID', - 'description' => '', - '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' => '执行成功规则数', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RowPermissionId' => ['title' => '', 'description' => 'The row-level permission ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30008888'], + 'RowPermissionDesc' => ['title' => '', 'description' => 'The description of the row-level permission.', 'type' => 'string', 'example' => '管控业务数据'], + 'RowPermissionName' => ['title' => '', 'description' => 'The name of the row-level permission.', 'type' => 'string', 'example' => '业务管控'], + 'MappingColumns' => [ + 'title' => '', + 'description' => 'The mapping fields.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'example' => 'business_id'], + 'ColumnType' => [ + 'title' => '', + 'description' => 'The type of the mapping field.', + 'type' => 'string', + 'enum' => ['STRING', 'NUMBER'], + 'example' => 'string', + ], + 'ColumnDesc' => ['title' => '', 'description' => 'The description of the mapping field.', 'type' => 'string', 'example' => '业务ID'], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - ], - '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' => '执行成功规则数', + 'Rules' => [ + 'title' => '', + 'description' => 'The rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'example' => '管控ID 100以内数据'], + 'ScopeType' => [ + 'title' => '', + 'description' => 'The scope type of the rule.', + 'type' => 'string', + 'enum' => ['ALL_COLUMN', 'SELECT_COLUMN'], + 'example' => 'SELECT_COLUMN', + ], + 'IsDelete' => [ + 'title' => '', + 'description' => 'Indicates whether the rule is deleted.', + 'type' => 'boolean', + 'enum' => ['0', '1'], + 'example' => '', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The rule status.', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1'], + 'example' => '1', + ], + 'Expressions' => [ + 'title' => '', + 'description' => 'The rule expressions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'example' => 'business_id'], + 'Values' => [ + 'title' => '', + 'description' => 'The operation values of the expression.', + 'type' => 'array', + 'items' => ['description' => 'The operation values of the expression.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'example' => '', + ], + 'Type' => [ + 'title' => '', + 'description' => 'The expression type.', + 'type' => 'string', + 'enum' => ['EXPRESSION', 'RELATION'], + 'example' => 'EXPRESSION', + ], + 'SubConditions' => [ + 'title' => '', + 'description' => 'The sub-expressions.', + 'type' => 'array', + 'items' => ['description' => 'The sub-expression. The structure is the same as Expressions.', 'type' => 'any', 'example' => '同Expressions', 'title' => ''], + 'example' => '', + ], + 'Operator' => [ + 'title' => '', + 'description' => 'The expression operator.', + 'type' => 'string', + 'enum' => ['EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND'], + 'example' => '30008888', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'UserMappingList' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountType' => ['title' => '', 'description' => 'The type of the account bound to the rule.', 'type' => 'string', 'example' => 'PERSONAL'], + 'Accounts' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '', 'description' => 'The ID of the account bound to the rule.', 'type' => 'string', 'example' => '30008888'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'enumValueTitles' => ['PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'APPLICATION' => 'APPLICATION', 'PRODUCE' => 'PRODUCE'], + 'enum' => ['PERSONAL', 'PRODUCE', 'USER_GROUP'], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - ], - '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' => '执行成功规则数', + 'Tables' => [ + 'title' => '', + 'description' => 'The related tables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'example' => 'business_id'], + 'ResourceId' => ['title' => '', 'description' => 'The GUID of the table.', 'type' => 'string', 'example' => 'odps.300199897.project_name.table_name'], + 'ColumnName' => ['title' => '', 'description' => 'The table field.', 'type' => 'string', 'example' => 'business_id'], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-08-23T08:01:44Z', 'title' => ''], + 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2025-02-12T02:16:45Z', 'title' => ''], + 'Creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => '30008888', 'title' => ''], + 'Modifier' => ['description' => 'The modifier.', 'type' => 'string', 'example' => '30008888', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', 'title' => ''], ], - ], - ], - 'RuleIdList' => [ - 'title' => '质量规则Id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '质量规则Id', 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'title' => '', + 'example' => '', ], - ], - 'Status' => [ - 'title' => '任务状态: NOT_RUN 未执行、WAITING 等待中、RUNNING 执行中、SUCCESS 执行成功、FAILED 执行失败、CANCEL 取消、TIMEOUT 超时、OFFLINE 离线', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - '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"}]', - ], - 'GetQualityWatchByObjectId' => [ - 'summary' => '通过监控对象原始ID获取监控对象记录，例如：数据源、表、指标等的ID。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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 \\"Id\\": 123,\\n \\"RuleName\\": \\"管控ID 100以内数据\\",\\n \\"ScopeType\\": \\"SELECT_COLUMN\\",\\n \\"IsDelete\\": false,\\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' => 'Paged query of row-level permissions', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + 'ramActions' => [], + ], + 'ListRowPermissionByUserId' => [ + 'summary' => 'Queries row-level permissions of a specified user by paging.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'WatchType', - 'in' => 'query', - 'schema' => [ - 'title' => '监控对象类型：TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TABLE', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'WatchObjectId', - 'in' => 'query', + 'name' => 'ListRowPermissionByUserIdQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '对象ID，例如表ID，数据源ID，指标ID等', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request command.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['title' => '', 'description' => 'The specified operator.', 'type' => 'string', 'required' => true, 'example' => '30008888'], + 'PageNum' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], 'required' => true, - 'example' => 'cc', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '121'], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'title' => '', + 'description' => 'The rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'example' => '业务管控'], + 'ScopeType' => [ + 'title' => '', + 'description' => 'The scope type of the rule.', + 'type' => 'string', + 'enum' => ['ALL_COLUMN', 'SELECT_COLUMN'], + 'example' => 'SELECT_COLUMN', + ], + 'IsDelete' => [ + 'title' => '', + 'description' => 'Indicates whether the rule is deleted.', + 'type' => 'boolean', + 'enum' => ['0', '1'], + 'example' => '0', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The rule status.', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1'], + 'example' => '1', + ], + 'Expressions' => [ + 'title' => '', + 'description' => 'The rule expressions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The mapping field name.', 'type' => 'string', 'example' => 'business_id'], + 'Values' => [ + 'title' => '', + 'description' => 'The expression operation values.', + 'type' => 'array', + 'items' => ['description' => 'The expression operation values.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'example' => '', + ], + 'Type' => [ + 'title' => '', + 'description' => 'The expression type.', + 'type' => 'string', + 'enum' => ['EXPRESSION', 'RELATION'], + 'example' => 'EXPRESSION', + ], + 'SubConditions' => [ + 'title' => '', + 'description' => 'The sub-expressions.', + 'type' => 'array', + 'items' => ['description' => 'The sub-expression. The structure is the same as Expressions.', 'type' => 'any', 'example' => '同Expressions', 'title' => ''], + 'example' => '', + ], + 'Operator' => [ + 'title' => '', + 'description' => 'The expression operator.', + 'type' => 'string', + 'enum' => ['EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND'], + 'example' => 'EQUAL', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'UserMappingList' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountType' => ['title' => '', 'description' => 'The type of the account bound to the rule.', 'type' => 'string', 'example' => 'PERSONAL'], + 'Accounts' => [ + 'title' => '', + 'description' => 'The accounts bound to the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '', 'description' => 'The ID of the account bound to the rule.', 'type' => 'string', 'example' => '30008888'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'enum' => ['PERSONAL', 'PRODUCE', 'USER_GROUP'], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'The related tables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The mapping field name.', 'type' => 'string', 'example' => '拦截规则'], + 'ResourceId' => ['title' => '', 'description' => 'The table GUID.', 'type' => 'string', 'example' => 'odps.300199897.project_name.table_name'], + 'ColumnName' => ['title' => '', 'description' => 'The table field.', 'type' => 'string', 'example' => 'business_id'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-03-30T21:37:23Z', 'title' => ''], + 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2025-03-03T10:14Z', 'title' => ''], + 'Creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => '30008888', 'title' => ''], + 'Modifier' => ['description' => 'The modifier.', 'type' => 'string', 'example' => '30008888', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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 \\"Id\\": 123\\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' => 'Query row-level permissions of a specified user by paging', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListSecurityIdentifyRecords' => [ + 'summary' => 'Queries identification records of security identification results by paging.'."\n" + .'Online version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The query conditions.', + 'type' => 'object', + 'properties' => [ + 'IsDatasourceTable' => ['title' => '', 'description' => 'Specifies whether the table is a datasource table. Default value: false (treated as a Dataphin table).', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name. This parameter is required only for datasource tables.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'DatasourceEnv' => ['title' => '', 'description' => 'The datasource environment identifier. This parameter is required only for datasource tables.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'TableCatalog' => ['title' => '', 'description' => 'The table catalog. For datasource tables, specify the database or schema name. For Dataphin physical tables, specify the project name in English. For Dataphin logical tables, specify the business unit name in English.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 't_test'], + 'FieldName' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'col1'], + 'Keyword' => ['title' => '', 'description' => 'The search keyword. The search scope is the field name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paging query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'IdentifyRecordList' => [ + 'title' => '', + 'description' => 'The list of identification records.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The identification record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'BizUnitName' => ['title' => '', 'description' => 'The business unit name.', 'type' => 'string', 'example' => 'test'], + 'BizUnitDisplayName' => ['title' => '', 'description' => 'The display name of the business unit.', 'type' => 'string', 'example' => 'test_abc'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectDisplayName' => ['title' => '', 'description' => 'The display name of the project.', 'type' => 'string', 'example' => 'test_abc'], + 'DatasourceId' => ['title' => '', 'description' => 'The datasource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DatasourceName' => ['title' => '', 'description' => 'The datasource name.', 'type' => 'string', 'example' => 'test'], + 'TableEnv' => ['title' => '', 'description' => 'The table environment.', 'type' => 'string', 'example' => 'DEV'], + 'TableId' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'example' => '1'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 't_test'], + 'TableDescription' => ['title' => '', 'description' => 'The table description.', 'type' => 'string', 'example' => 'test'], + 'TableType' => ['title' => '', 'description' => 'The table type. Valid values:'."\n" + .'- LOGIC_TABLE: logical table.'."\n" + .'- LOGIC_DIM_TABLE: logical dimension table.'."\n" + .'- LOGIC_FACT_TABLE: logical fact table.'."\n" + .'- LOGIC_SUM_TABLE: logical aggregate table.'."\n" + .'- LOGIC_ODM_SOURCE: source table.'."\n" + .'- LOGIC_LABEL_TABLE: logical label table.'."\n" + .'- PHYSICAL_TABLE: physical table.'."\n" + .'- REAL_TIME_LOGIC_TABLE: real-time configured logical table.', 'type' => 'string', 'example' => 'LOGIC_TABLE'], + 'FieldId' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => 't_test.col1'], + 'FieldName' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'example' => 'col1'], + 'FieldDescription' => ['title' => '', 'description' => 'The field description.', 'type' => 'string', 'example' => 'test'], + 'ActualIdentifyRate' => ['title' => '', 'description' => 'The actual match rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.1'], + 'ClassifyId' => ['title' => '', 'description' => 'The classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ClassifyName' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'example' => 'test'], + 'ClassifyAbbreviation' => ['title' => '', 'description' => 'The classification abbreviation.', 'type' => 'string', 'example' => 'test'], + 'ClassifyStatus' => ['title' => '', 'description' => 'The classification effective status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'example' => 'ENABLE'], + 'LevelIndex' => ['title' => '', 'description' => 'The classification level index.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LevelName' => ['title' => '', 'description' => 'The classification level name.', 'type' => 'string', 'example' => 'test'], + 'LevelAbbreviation' => ['title' => '', 'description' => 'The classification level abbreviation.', 'type' => 'string', 'example' => 'test'], + 'IsCustomIdentify' => ['title' => '', 'description' => 'Indicates whether a custom tagging rule is used.', 'type' => 'boolean', 'example' => ''], + 'IsLocked' => ['title' => '', 'description' => 'Indicates whether the record is locked.', 'type' => 'boolean', 'example' => ''], + 'IsBetterMatch' => ['title' => '', 'description' => 'Indicates whether this is a better match.', 'type' => 'boolean', 'example' => ''], + 'BizDate' => ['title' => '', 'description' => 'The business date.', 'type' => 'string', 'example' => '2025-06-30'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"IsLocked\\": false,\\n \\"IsBetterMatch\\": false,\\n \\"BizDate\\": \\"2025-06-30\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query identification records of security identification results by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListSecurityIdentifyResults' => [ + 'summary' => 'Query security identification results by page.'."\n" + .'Release version: 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' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Query conditions.', + 'type' => 'object', + 'properties' => [ + 'ClassifyId' => ['title' => '', 'description' => 'Data classification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Env' => ['title' => '', 'description' => 'Environment identifier of the data source, project, or business unit.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'BizUnitNameList' => [ + 'title' => '', + 'description' => 'Business unit names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Business unit name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', + 'ProjectNameList' => [ + 'title' => '', + 'description' => 'Project names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Project name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'DatasourceNameList' => [ + 'title' => '', + 'description' => 'Data source names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Data source name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', ], - 'QualityWatchInfo' => [ - 'title' => '监控对象详情', - 'description' => '', + 'Status' => ['title' => '', 'description' => 'Effective status filter: ENABLE or DISABLE.', 'type' => 'string', 'required' => false, 'example' => 'ENABLE'], + 'IsLocked' => ['title' => '', 'description' => 'Whether it is locked.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Keyword' => ['title' => '', 'description' => 'Keyword filter. Supports matching by table catalog, table name, table display name, and field name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend response error details.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'example' => 'TABLE', - ], - 'Id' => [ - 'title' => '监控Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Name' => [ - 'title' => '监控名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'title' => '状态：ENABLE，DISABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'ENABLE', - ], - 'DataSourceInfo' => [ - 'title' => '数据源详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Type' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'CreatorName' => [ - 'title' => '创建者名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_DIM_TABLE', - ], - 'Catalog' => [ - 'title' => '表catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '表Id', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'title' => '表名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Env' => [ - 'title' => '环境标识：DEV、PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '负责人用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '22', - ], - 'IsPartitionTable' => [ - 'title' => '是否分区表', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'IndexInfo' => [ - 'title' => '指标详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Catalog' => [ - 'title' => '指标catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '指标Id：', - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'Guid' => [ - 'title' => '指标guid：', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'Name' => [ - 'title' => '指标名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'DisplayName' => [ - 'title' => '指标展示名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'GranularityId' => [ - 'title' => '统计粒度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18755764', - ], - 'GranularityDisplayName' => [ - 'title' => '统计粒度名称', - 'description' => '', - 'type' => 'string', - 'example' => '全站汇总表', - ], - 'ComputeType' => [ - 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', - 'description' => '', - 'type' => 'string', - 'example' => 'AUTO', - ], - 'CellSumLogicTableName' => [ - 'title' => '单元汇总表名', - 'description' => '', - 'type' => 'string', - 'example' => 'dws_all', - ], - 'Type' => [ - 'title' => '指标类型：INDEX', - 'description' => '', - 'type' => 'string', - 'example' => 'INDEX', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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', + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'SecurityIdentifyResultList' => [ + 'title' => '', + 'description' => 'Paginated identification result list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Identification result ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ScanTaskId' => ['title' => '', 'description' => 'Scan task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'TableTaskId' => ['title' => '', 'description' => 'Table identification task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'ClassifyId' => ['title' => '', 'description' => 'Classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'ClassifyName' => ['title' => '', 'description' => 'Classification name.', 'type' => 'string', 'example' => 'test'], + 'ClassifyAbbreviation' => ['title' => '', 'description' => 'Classification abbreviation.', 'type' => 'string', 'example' => 'test'], + 'LevelIndex' => ['title' => '', 'description' => 'Security level index.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LevelName' => ['title' => '', 'description' => 'Security level name.', 'type' => 'string', 'example' => 'test'], + 'LevelAbbreviation' => ['title' => '', 'description' => 'Security level abbreviation.', 'type' => 'string', 'example' => 'test'], + 'LevelColor' => ['title' => '', 'description' => 'Security level color.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BizUnitId' => ['title' => '', 'description' => 'Business unit ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BizUnitName' => ['title' => '', 'description' => 'Business unit name.', 'type' => 'string', 'example' => 'LD_test'], + 'BizUnitDisplayName' => ['title' => '', 'description' => 'Business unit display name.', 'type' => 'string', 'example' => 'LD_test'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101121'], + 'ProjectName' => ['title' => '', 'description' => 'Project name.', 'type' => 'string', 'example' => 'test'], + 'ProjectDisplayName' => ['title' => '', 'description' => 'Project display name.', 'type' => 'string', 'example' => 'test'], + 'DatasourceId' => ['title' => '', 'description' => 'Data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101121'], + 'DatasourceName' => ['title' => '', 'description' => 'Data source name.', 'type' => 'string', 'example' => 'ds1'], + 'TableEnv' => ['title' => '', 'description' => 'Table environment.', 'type' => 'string', 'example' => 'DEV'], + 'TableType' => ['title' => '', 'description' => 'Table type. Valid values: LOGIC_TABLE (logical table), LOGIC_DIM_TABLE (dimension logical table), LOGIC_FACT_TABLE (fact logical table), LOGIC_SUM_TABLE (summary logical table), LOGIC_ODM_SOURCE (source table), LOGIC_LABEL_TABLE (label logical table), PHYSICAL_TABLE (physical table), REAL_TIME_LOGIC_TABLE (real-time configured logical table).', 'type' => 'string', 'example' => 'LOGIC_TABLE'], + 'TableCatalog' => ['title' => '', 'description' => 'Table catalog.', 'type' => 'string', 'example' => 'testdb'], + 'TableId' => ['title' => '', 'description' => 'Table ID.', 'type' => 'string', 'example' => '1'], + 'TableName' => ['title' => '', 'description' => 'Table name.', 'type' => 'string', 'example' => 't_test'], + 'TableDescription' => ['title' => '', 'description' => 'Table description.', 'type' => 'string', 'example' => 'test'], + 'FieldId' => ['title' => '', 'description' => 'Field ID.', 'type' => 'string', 'example' => 't_test.col1'], + 'FieldName' => ['title' => '', 'description' => 'Field name.', 'type' => 'string', 'example' => 'col1'], + 'FieldDescription' => ['title' => '', 'description' => 'Field description.', 'type' => 'string', 'example' => 'test'], + 'IsCustomIdentify' => ['title' => '', 'description' => 'Whether it is a custom tagging rule.', 'type' => 'boolean', 'example' => ''], + 'IsLocked' => ['title' => '', 'description' => 'Whether it is locked.', 'type' => 'boolean', 'example' => ''], + 'HasBetterRule' => ['title' => '', 'description' => 'Whether a better matching result exists.', 'type' => 'boolean', 'example' => ''], + 'IdentifyRecordId' => ['title' => '', 'description' => 'Identification record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'Status' => ['title' => '', 'description' => 'Status. Valid values: ENABLE and DISABLE.', 'type' => 'string', 'example' => 'ENABLE'], + 'BizDate' => ['title' => '', 'description' => 'Business date.', 'type' => 'string', 'example' => '2025-06-30'], + 'Creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '30012011'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2025-06-30 10:30:30'], + 'Modifier' => ['title' => '', 'description' => 'Modifier.', 'type' => 'string', 'example' => '30012011'], + 'ModifyTime' => ['title' => '', 'description' => 'Modification time.', 'type' => 'string', 'example' => '2025-06-30 10:30:30'], ], + 'example' => '', ], - ], - 'QualityOwner' => [ - 'title' => '质量负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'QualityOwnerName' => [ - 'title' => '质量负责人显示名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LatestWatchTaskId' => [ - 'title' => '最近一次监控对象校验记录ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"IsLocked\\": false,\\n \\"HasBetterRule\\": false,\\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' => 'Query Security Identification Results by Page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetQualityWatch' => [ - 'summary' => '获取质量监控对象。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListStandards' => [ + 'summary' => 'Query the standard list by page.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -43379,489 +31950,527 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '监控Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Search conditions.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'Search keyword: fuzzy search by standard name, English name, or code. Case-insensitive, sorted by relevance.', 'type' => 'string', 'required' => false, 'example' => 'Test'], + 'Directory' => ['title' => '', 'description' => 'Directory of the standard.', 'type' => 'string', 'required' => false, 'example' => '/dir1/dir2'], + 'StandardTypeList' => [ + 'title' => '', + 'description' => 'Standard type: Basic, EMPTY indicates the standard type is empty.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Standard type: Basic, EMPTY indicates the standard type is empty.', 'type' => 'string', 'required' => false, 'example' => 'EMPTY'], + 'required' => false, + 'example' => '', + ], + 'StandardStage' => ['title' => '', 'description' => 'Stage of the standard: DEV or PROD.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'StandardTemplateIdList' => [ + 'title' => '', + 'description' => 'Standard template ID list.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Standard template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, + 'example' => '', + ], + 'StandardSetIdList' => [ + 'title' => '', + 'description' => 'Standard set ID list.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, + 'example' => '', + ], + 'StandardStatusList' => [ + 'title' => '', + 'description' => 'Standard status list. Standard statuses under DEV stage: DRAFT, UNDER_REVISION, UNDER_REVIEW, REVIEW_PASSED, IN_PUBLISH. Standard statuses under PROD stage: NOT_ACTIVATED, ACTIVE, EXPIRED.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Standard status. Standard statuses under DEV stage: DRAFT, UNDER_REVISION, UNDER_REVIEW, REVIEW_PASSED, IN_PUBLISH. Standard statuses under PROD stage: NOT_ACTIVATED, ACTIVE, EXPIRED.', 'type' => 'string', 'required' => false, 'example' => 'DRAFT'], + 'required' => false, + 'example' => '', + ], + 'UserId' => ['title' => '', 'description' => 'User ID: only queries standards visible to this user ID. If empty, queries standards visible to the current user.', 'type' => 'string', 'required' => false, 'example' => '30012011'], + 'PageNo' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'QualityWatchInfo' => [ - 'title' => '监控对象详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Details of the backend response error.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'Paginated query result.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '监控对象类型: TABLE Dataphin表，DATASOURCE_TABLE 全域表，DATASOURCE 数据源,INDEX 指标，REALTIME_LOGICAL_TABLE 实时元表', - 'description' => '', - 'type' => 'string', - 'example' => 'TABLE', - ], - 'Id' => [ - 'title' => '监控Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Name' => [ - 'title' => '监控名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'title' => '状态：ENABLE，DISABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'ENABLE', - ], - 'DataSourceInfo' => [ - 'title' => '数据源详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源Id', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Type' => [ - 'title' => '数据源类型: MAX_COMPUTE、HADOOP', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'CreatorName' => [ - 'title' => '创建者名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DEV', + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], + 'StandardList' => [ + 'title' => '', + 'description' => 'Standard list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Version' => ['title' => '', 'description' => 'Version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['title' => '', 'description' => 'Status of the standard.', 'type' => 'string', 'example' => 'draft'], + 'Stage' => ['title' => '', 'description' => 'Stage of the standard.', 'type' => 'string', 'example' => 'dev'], + 'StandardTemplate' => [ + 'title' => '', + 'description' => 'Standard template that the current standard depends on.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Standard template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'Standard template name.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'Standard template code.', 'type' => 'string', 'example' => '1121'], + 'TemplateFrom' => ['title' => '', 'description' => 'Standard template source: CUSTOM for custom standard templates, SYSTEM for system built-in standard templates.', 'type' => 'string', 'example' => 'SYSTEM'], + 'Version' => ['title' => '', 'description' => 'Version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + 'StandardSet' => [ + 'title' => '', + 'description' => 'Standard set that the current standard depends on.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Standard set ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'Standard set name.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'Standard set code.', 'type' => 'string', 'example' => 'cc'], + 'Directory' => ['title' => '', 'description' => 'Directory of the standard set.', 'type' => 'string', 'example' => '/dir1'], + ], + 'example' => '', + ], + 'EffectiveTimeConfig' => [ + 'title' => '', + 'description' => 'Effective time configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Effective time type: FOREVER for permanent, TIME_PERIOD for a time period.', 'type' => 'string', 'example' => 'TIME_PERIOD'], + 'StartTime' => ['title' => '', 'description' => 'Start time of the effective period.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'End time of the effective period.', 'type' => 'string', 'example' => '2025-12-30 00:00:00'], + ], + 'example' => '', + ], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'test'], + 'Owner' => [ + 'title' => '', + 'description' => 'Owner.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'User name.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'Name' => ['title' => '', 'description' => 'Standard name.', 'type' => 'string', 'example' => 'test'], + 'EnglishName' => ['title' => '', 'description' => 'Standard English name.', 'type' => 'string', 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'Standard code.', 'type' => 'string', 'example' => 'zz'], + 'Type' => ['title' => '', 'description' => 'Standard type.', 'type' => 'string', 'example' => 'zz'], + 'ModifyTime' => ['title' => '', 'description' => 'Last modified time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'LastModifier' => [ + 'title' => '', + 'description' => 'Last modifier.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'User name.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'Creator' => [ + 'title' => '', + 'description' => 'Creator.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'example' => '300000913'], + 'Name' => ['title' => '', 'description' => 'User name.', 'type' => 'string', 'example' => 'susan'], + ], + 'example' => '', + ], + 'AttributeWithValueList' => [ + 'title' => '', + 'description' => 'Attribute value configuration list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '', + 'description' => 'Attribute details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Attribute name.', 'type' => 'string', 'example' => 'attr1'], + 'Code' => ['title' => '', 'description' => 'Attribute code.', 'type' => 'string', 'example' => 'test_attr'], + 'Type' => ['title' => '', 'description' => 'Attribute type: BIZ_ATTRIBUTE for business attribute, TECH_ATTRIBUTE for technical attribute, MANAGEMENT_ATTRIBUTE for management attribute, QUALITY_ATTRIBUTE for quality attribute, MASTER_DATA_ATTRIBUTE for master data attribute, LIFECYCLE_ATTRIBUTE for lifecycle attribute, SECURITY_ATTRIBUTE for security attribute.', 'type' => 'string', 'example' => 'BIZ_ATTRIBUTE'], + 'Required' => ['title' => '', 'description' => 'Whether it is required.', 'type' => 'boolean', 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'Value configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Attribute value type: CUSTOMIZED for custom input, SINGLE_ENUM for single enumeration value, MULTIPLE_ENUMS for multiple enumeration values, RANGE for range value.', 'type' => 'string', 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'Data type of the attribute value: STRING for string, BIGINT for numeric type, DOUBLE for floating-point type, DATE for date accurate to day, DATETIME for date accurate to milliseconds, BOOLEAN for boolean.', 'type' => 'string', 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'Attribute value length. If empty or -1, the length is not limited. Typically, only string types limit the attribute value length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ValueRange' => [ + 'title' => '', + 'description' => 'Value range.', + 'type' => 'object', + 'properties' => [ + 'ValueConstraint' => ['title' => '', 'description' => 'Value constraint: NONE for no constraint, LIST for obtaining from a list, LOOKUP_TABLE for lookup table, MIN_MAX for values between minimum and maximum, DATAPHIN_ATTRIBUTE for Dataphin system attribute, BUILT_IN_DATA_TYPES for built-in data types, BUILT_IN_DATA_CLASSIFICATION for built-in data classification, BUILT_IN_DATA_LEVEL for built-in data security level.', 'type' => 'string', 'example' => 'NONE'], + 'ValueList' => [ + 'title' => '', + 'description' => 'Value range, effective when value constraint is LIST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Value range, effective when value constraint is LIST.', 'type' => 'string', 'example' => '1'], + 'example' => '', + ], + 'MinMaxValueConfig' => [ + 'title' => '', + 'description' => 'Value range, effective when value constraint is MIN_MAX.', + 'type' => 'object', + 'properties' => [ + 'MinValue' => ['title' => '', 'description' => 'Minimum value.', 'type' => 'string', 'example' => '0'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Whether to include the minimum value.', 'type' => 'boolean', 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'Maximum value.', 'type' => 'string', 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Whether to include the maximum value.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'LookupTableReference' => [ + 'title' => '', + 'description' => 'Value range, effective when value constraint is LOOKUP_TABLE.', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'Lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Column' => ['title' => '', 'description' => 'Referenced lookup table column.', 'type' => 'string', 'example' => 'col1'], + ], + 'example' => '', + ], + 'DataphinAttributeType' => ['title' => '', 'description' => 'Value range, effective when value constraint is DATAPHIN_ATTRIBUTE: BIZ_UNIT for data business unit, PROJECT for project, USER for user, USER_GROUP for user group.', 'type' => 'string', 'example' => 'DATAPHIN_ATTRIBUTE'], + ], + 'example' => '', + ], + 'DefaultValue' => ['title' => '', 'description' => 'Default value.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'MonitorConfig' => [ + 'title' => '', + 'description' => 'Monitor configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Monitor type: METADATA for metadata monitoring, QUALITY for data quality monitoring.', 'type' => 'string', 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'Column to check.', 'type' => 'string', 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Whether case-sensitive.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'EnableMonitorConfig' => ['title' => '', 'description' => 'Whether to enable monitor configuration.', 'type' => 'boolean', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'test'], + 'RefAttribute' => [ + 'title' => '', + 'description' => 'Referenced attribute information.', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'Attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'AttributeFromInfo' => [ + 'title' => '', + 'description' => 'Attribute source.', + 'type' => 'object', + 'properties' => [ + 'AttributeFrom' => ['title' => '', 'description' => 'Attribute source: SYSTEM for system attribute, CUSTOM for custom attribute, STANDARD for standard.', 'type' => 'string', 'example' => 'CUSTOM'], + 'StandardReference' => [ + 'title' => '', + 'description' => 'Corresponding standard, effective when attribute source is STANDARD.', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'Standard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'Version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Id' => ['title' => '', 'description' => 'Attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + ], + 'example' => '', + ], + 'Value' => ['title' => '', 'description' => 'Attribute value.', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'example' => '', + ], ], + 'example' => '', ], + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_DIM_TABLE', - ], - 'Catalog' => [ - 'title' => '表catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '表Id', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'title' => '表名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Env' => [ - 'title' => '环境标识：DEV、PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '负责人用户名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '22', - ], - 'IsPartitionTable' => [ - 'title' => '是否分区表', - 'description' => '', - 'type' => 'boolean', - ], - ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\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\\": false,\\n \\"MaxValue\\": \\"100\\",\\n \\"IncludeMaxValue\\": false\\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\\": false\\n },\\n \\"EnableMonitorConfig\\": false,\\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' => 'Query Standard List by Page', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListSubmitRecords' => [ + 'summary' => 'Paginate and retrieve the list of pending deployment records.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Query command.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'SearchFilter' => [ + 'title' => '', + 'description' => 'Pending deployment record filter.', + 'type' => 'object', + 'properties' => [ + 'ProjectIdList' => [ + 'title' => '', + 'description' => 'Project ID.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '121321313519086'], + 'required' => true, + 'example' => '', ], - 'IndexInfo' => [ - 'title' => '指标详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Catalog' => [ - 'title' => '指标catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'title' => '指标Id：', - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'Guid' => [ - 'title' => '指标guid：', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'Name' => [ - 'title' => '指标名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'DisplayName' => [ - 'title' => '指标展示名：', - 'description' => '', - 'type' => 'string', - 'example' => 'logic', - ], - 'GranularityId' => [ - 'title' => '统计粒度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18755764', - ], - 'GranularityDisplayName' => [ - 'title' => '统计粒度名称', - 'description' => '', - 'type' => 'string', - 'example' => '全站汇总表', - ], - 'ComputeType' => [ - 'title' => '指标计算类型类型：AUTO、CUSTOM、MOUNT、COMBINE', - 'description' => '', - 'type' => 'string', - 'example' => 'AUTO', - ], - 'CellSumLogicTableName' => [ - 'title' => '单元汇总表名', - 'description' => '', - 'type' => 'string', - 'example' => 'dws_all', - ], - 'Type' => [ - 'title' => '指标类型：INDEX', - 'description' => '', - 'type' => 'string', - 'example' => 'INDEX', - ], - 'BizUnitId' => [ - 'title' => '业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1121', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人用户ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'QualityOwnerName' => [ - 'title' => '质量负责人显示名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'LatestWatchTaskId' => [ - 'title' => '最近一次监控对象校验记录ID', - 'description' => '', - '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', + 'SubmitterList' => [ + 'title' => '', + 'description' => 'Submitter.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Submitter.', 'type' => 'string', 'required' => true, 'example' => '3434222'], + 'required' => false, + 'example' => '', ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 00:00:00', + 'ChangeTypeList' => [ + 'title' => '', + 'description' => 'List of change types (0: Create / 1: Update / 2: Delete).', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Change type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'required' => false, + 'example' => '', ], - 'Modifier' => [ - 'title' => '最近修改用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', + 'SubmitStartTime' => ['title' => '', 'description' => 'Submission start time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00'], + 'SubmitEndTime' => ['title' => '', 'description' => 'Submission end time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2024-10-10 10:00:00'], + 'Page' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'ListResult' => [ + 'title' => '', + 'description' => 'Query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Data' => [ + 'title' => '', + 'description' => 'List of pending deployment records.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Pending deployment record.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Pending deployment record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1241844456'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'example' => '1241844456'], + 'Submitter' => ['title' => '', 'description' => 'Submitter ID.', 'type' => 'string', 'example' => '307999999'], + 'SubmitterName' => ['title' => '', 'description' => 'Submitter name.', 'type' => 'string', 'example' => '张三'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'GmtModify' => ['title' => '', 'description' => 'Modification time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'ChangeType' => ['title' => '', 'description' => 'Change type. 0: Create / 1: Update / 2: Delete.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ObjectType' => ['title' => '', 'description' => 'Object type. Valid values:'."\n" + .'- MaxCompute SQL task: MAX_COMPUTE_SQL'."\n" + .'- MaxCompute MR task: MAX_COMPUTE_MR'."\n" + .'- Spark JAR on MaxCompute: SPARK_JAR_ON_MAX_COMPUTE'."\n" + .'- Shell task: SHELL'."\n" + .'- Python task: PYTHON'."\n" + .'- Perl script: PERL'."\n" + .'- Check: CHECK'."\n" + .'- Sync task: DATA_X'."\n" + .'- Virtual node: VIRTUAL'."\n" + .'- Resource: IDE_RESOURCE'."\n" + .'- Function: UDF'."\n" + .'- Hive SQL task: HIVE_SQL'."\n" + .'- Hadoop MR task: HADOOP_MR'."\n" + .'- Spark JAR on Hive task: SPARK_JAR_ON_HIVE'."\n" + .'- Flink SQL task: FLINK_SQL'."\n" + .'- Flink SQL template task: FLINK_TEMPLATE_SQL'."\n" + .'- Stream computing template: STREAM_TEMPLATE'."\n" + .'- Metatable: META_TABLE'."\n" + .'- Stream computing function: STREAM_UDF'."\n" + .'- Real-time Flink DataStream: FLINK_DATASTREAM'."\n" + .'- Real-time custom data source: STREAM_CUSTOM_DATASOURCE'."\n" + .'- AnalyticDB for PostgreSQL task: ADB_FOR_PG'."\n" + .'- TDH SQL task: INCEPTOR_SQL'."\n" + .'- Mirror table: MIRROR_TABLE'."\n" + .'- Intermediate table: MIDDLE_TABLE'."\n" + .'- Application table: APPLICATION_TABLE'."\n" + .'- Impala SQL task: IMPALA_SQL'."\n" + .'- Offline pipeline task: OFFLINE_PIPELINE'."\n" + .'- Real-time pipeline task: REAL_TIME_PIPELINE'."\n" + .'- Dimension logical table: DIM_LOGICAL_TABLE'."\n" + .'- Fact logical table: FCT_LOGICAL_TABLE'."\n" + .'- Business condition: BIZ_CONDITION'."\n" + .'- Atomic metric: ATOM_INDEX'."\n" + .'- Derived metric: DERIVED_INDEX'."\n" + .'- Calculated derived metric: CALC_DERIVED_INDEX'."\n" + .'- PAI task: PAI_DESIGNER'."\n" + .'- ArgoDB SQL task: ARGODB_SQL'."\n" + .'- Hologres SQL task: HOLOGRES_SQL'."\n" + .'- Impala SQL task: IMPALA_SQL'."\n" + .'- StarRocks SQL task: STARROCKS_SQL'."\n" + .'- Database SQL task: DATABASE_SQL'."\n" + .'- Spark SQL task: SPARK_SQL'."\n" + .'- Compute template: TASK_TEMPLATE'."\n" + .'- External trigger node: EXTERNAL_TRIGGER'."\n" + .'- Gauss SQL task: GAUSS_SQL', 'type' => 'string', 'example' => '2024-10-10 10:00:00'], + 'ObjectName' => ['title' => '', 'description' => 'Object name.', 'type' => 'string', 'example' => '对象A'], + 'ObjectId' => ['title' => '', 'description' => 'Object ID.', 'type' => 'string', 'example' => '1234567'], + 'NodeId' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'ObjectVersion' => ['title' => '', 'description' => 'Object version.', 'type' => 'string', 'example' => '1'], + 'SubmitComment' => ['title' => '', 'description' => 'Submission comment.', 'type' => 'string', 'example' => '提交信息'], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Paginate and Query Pending Deployment Records', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityTemplate' => [ - 'summary' => '获取质量模板对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListSubmitRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListTables' => [ + 'summary' => 'Performs a paged query to retrieve asset table metadata.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -43870,255 +32479,149 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'title' => '', + 'description' => 'The paged query conditions.', + 'type' => 'object', + 'properties' => [ + 'Catalog' => ['title' => '', 'description' => 'The asset catalog, such as the project name or business unit name.', 'type' => 'string', 'required' => true, 'example' => 'LD_test01_dev'], + 'Keyword' => ['title' => '', 'description' => 'The keyword for searching. Table names are supported.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PageNo' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'QualityTemplateInfo' => [ - 'title' => '模板对象详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '模板Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'TypeName' => [ - 'title' => '模板类型展示名', - 'description' => '', - 'type' => 'string', - 'example' => '字段空值校验', - ], - 'Description' => [ - 'title' => '模板描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '归属人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '归属人名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Catalog' => [ - 'title' => '模板分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '支持特定数据源类型：MySQL、Oracle、Microsoft SQL Server、MaxCompute、Hive等', - 'description' => '', - 'type' => 'string', - 'example' => 'MySQL', - ], - ], - 'IsSystemTemplate' => [ - 'title' => '是否系统模板', - 'description' => '', - 'type' => 'boolean', - ], - 'FormPropertyList' => [ - 'title' => '规则配置键值对', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '68'], + 'TableList' => [ + 'title' => '', + 'description' => 'The list of tables.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'title' => '控件类型', - 'description' => '', - 'type' => 'string', - 'example' => 'expression', - ], - 'Name' => [ - 'title' => '属性名', - 'description' => '', - 'type' => 'string', - 'example' => 'col', + 'Guid' => ['title' => '', 'description' => 'The GUID of the table.', 'type' => 'string', 'example' => '10011'], + 'DataSourceId' => ['title' => '', 'description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '3301'], + 'TableSizeInBytes' => ['title' => '', 'description' => 'The total storage size of the table, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10241024'], + 'LifeCycle' => ['title' => '', 'description' => 'The lifecycle of the table, in days.', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'LastDdlTime' => ['title' => '', 'description' => 'The time when the table DDL was last modified.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'LastQueryTime' => ['title' => '', 'description' => 'The time when the data was last viewed.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Owner' => ['title' => '', 'description' => 'The Dataphin user ID of the table owner. This value may be empty if the owner is not bound.', 'type' => 'string', 'example' => '30011211'], + 'Creator' => ['title' => '', 'description' => 'The ID of the creator.', 'type' => 'string', 'example' => '30011211'], + 'VisitCount30d' => ['title' => '', 'description' => 'The number of visits in the last 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values:'."\n" + .'- dev'."\n" + .'- prod.', 'type' => 'string', 'example' => 'dev'], + 'Name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'example' => 't_test01'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the table.', 'type' => 'string', 'example' => '学生'], + 'LastDmlTime' => ['title' => '', 'description' => 'The time when the table data was last updated.', 'type' => 'string', 'example' => '2025-06-30 00:00:00'], + 'Comment' => ['title' => '', 'description' => 'The comment of the table.', 'type' => 'string', 'example' => 'test'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '2011'], + 'BizUnitName' => ['title' => '', 'description' => 'The name of the business unit.', 'type' => 'string', 'example' => 'LD_test01'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '211'], + 'DataDomainName' => ['title' => '', 'description' => 'The name of the data domain.', 'type' => 'string', 'example' => '211'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the logical project.', 'type' => 'integer', 'format' => 'int64', 'example' => '1011'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the logical project.', 'type' => 'string', 'example' => 'testPrj'], + 'ParentModelId' => ['title' => '', 'description' => 'The ID of the parent model. This value is used to navigate to the ODM model.', 'type' => 'string', 'example' => '1'], + 'FileId' => ['title' => '', 'description' => 'The file ID. This value is used to navigate to the ODM model.', 'type' => 'string', 'example' => '2'], + 'IsPartitionTable' => ['title' => '', 'description' => 'Indicates whether the table is a partitioned table.', 'type' => 'boolean', 'example' => ''], + 'StorageType' => ['title' => '', 'description' => 'The storage type. Valid values:'."\n" + .'- HIVE'."\n" + .'- MAX_COMPUTE.', 'type' => 'string', 'example' => 'HIVE'], + 'StreamTableConfig' => [ + 'title' => '', + 'description' => 'The dynamic properties of the real-time meta table.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'v1'], + ], + 'example' => '', + ], + 'example' => '', ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'string', - 'example' => 'abc', + 'IsBasicMode' => ['title' => '', 'description' => 'Indicates whether the project or business version to which the table belongs is in Basic mode.', 'type' => 'boolean', 'example' => ''], + 'AssetTagList' => [ + 'title' => '', + 'description' => 'The asset inventory tags.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The asset inventory tags.', 'type' => 'string', 'example' => 'LYDAAS'], + 'example' => '', ], + 'SecurityLevel' => ['title' => '', 'description' => 'The security classification.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SecurityLevelName' => ['title' => '', 'description' => 'The name of the security classification.', 'type' => 'string', 'example' => '高级'], + 'SecurityLevelAbbreviation' => ['title' => '', 'description' => 'The abbreviation of the security classification name.', 'type' => 'string', 'example' => '高级'], ], + 'example' => '', ], - ], - 'Creator' => [ - 'title' => '创建人用户ID', - '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' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'ModifierName' => [ - 'title' => '最近修改人名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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\\": false,\\n \\"StorageType\\": \\"HIVE\\",\\n \\"StreamTableConfig\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"IsBasicMode\\": false,\\n \\"AssetTagList\\": [\\n \\"LYDAAS\\"\\n ],\\n \\"SecurityLevel\\": 1,\\n \\"SecurityLevelName\\": \\"高级\\",\\n \\"SecurityLevelAbbreviation\\": \\"高级\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query asset table metadata by paging', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetQualitySchedulesByWatchId' => [ - 'summary' => '通过监控对象ID获取调度设置列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ListTenantMembers' => [ + 'summary' => 'Queries the list of tenant members.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44126,237 +32629,183 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'WatchId', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'Page' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + 'SearchText' => ['title' => '', 'description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => '测试'], + 'UserGroupIdList' => [ + 'title' => '', + 'description' => 'The IDs of the user groups to which the member belongs.', + 'type' => 'array', + 'items' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => false, 'example' => '1213111', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'RoleList' => [ + 'title' => '', + 'description' => 'The member roles:'."\n" + .'- SUPER_ADMIN: Dataphin super administrator'."\n" + .'- SYSTEM_ADMIN: system administrator'."\n" + .'- COMMON_USER: Dataphin user'."\n" + .'- DATA_ADMIN: Dataphin data administrator'."\n" + .'- EXPORT_ADMIN: export administrator'."\n" + .'- SECURITY_ADMIN: security administrator'."\n" + .'- DATASOURCE_MANAGER: data source administrator'."\n" + .'- QUALITY_MANAGER: asset quality manager'."\n" + .'- DATA_STANDARD_MANAGER: data standard administrator'."\n" + .'- LABELS_BUSINESS_PLANNER: tag business planner'."\n" + .'- BUSINESS_MEMBER: general business user'."\n" + .'- DATAPRO_OPERATE_SUPER_ADMIN: operations super administrator'."\n" + .'- DATAPRO_OPERATE_ADMIN: operations administrator'."\n" + .'- DATAPRO_OPERATE_MEMBER: operations member'."\n" + .'- DATAPRO_BUSINESS_ANALYST: business analyst'."\n" + .'- LABELS_BUSINESS_MEMBER: tag business member'."\n" + .'- DATAPRO_BUSINESS_MEMBER: DATAPRO general business user', + 'type' => 'array', + 'items' => ['description' => 'The member role.', 'type' => 'string', 'required' => false, 'example' => 'DATA_ADMIN', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The 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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Id' => [ - 'title' => '调度对象Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PERIOD_SCHEDULE', - ], - 'PartitionType' => [ - 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'PartitionExpression' => [ - 'title' => '分区表达式-自定义表达式', - 'description' => '', - 'type' => 'string', - 'example' => 'ds=${yyyyMMdd}', - ], - 'TriggerType' => [ - 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'ONE_TASKS_FINISHED', - ], - 'PeriodScheduleIntervalType' => [ - 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'PeriodScheduleParamList' => [ - 'title' => '定时调度-调度周期值', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '定时调度-调度周期值', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paginated query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '110'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '132321'], + 'SourceType' => ['title' => '', 'description' => 'The user source.', 'type' => 'string', 'example' => 'aliyun'], + 'SourceId' => ['title' => '', 'description' => 'The user source ID.', 'type' => 'string', 'example' => '213213232422222'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the user.', 'type' => 'string', 'example' => 'zhangsan'], + 'DisplayNameWithoutStatus' => ['title' => '', 'description' => 'The display name of the user without status.', 'type' => 'string', 'example' => 'zhangsan'], + 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => 'zhangsan'], + 'RealName' => ['title' => '', 'description' => 'The real name of the user.', 'type' => 'string', 'example' => '张三'], + 'NickName' => ['title' => '', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'susan'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the user was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730000000000'], + 'MobilePhone' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '13888888888'], + 'Mail' => ['title' => '', 'description' => 'The email address.', 'type' => 'string', 'example' => '123@aliyun.com'], + 'DingNumber' => ['title' => '', 'description' => 'The DingTalk number.', 'type' => 'string', 'example' => 'dd123123'], + 'EnableWhiteIp' => ['title' => '', 'description' => 'Indicates whether the IP address whitelist is enabled.', 'type' => 'string', 'example' => 'true'], + 'WhiteIp' => ['title' => '', 'description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '0.0.0.0/0'], + 'GmtModified' => ['description' => 'The time when the user was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730000000000', 'title' => ''], + 'UserGroupList' => [ + 'title' => '', + 'description' => 'The list of user groups to which the user belongs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '121313'], + 'Name' => ['title' => '', 'description' => 'The name of the user group.', 'type' => 'string', 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '测试'], + 'Active' => ['title' => '', 'description' => 'Indicates whether the user group is enabled.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '232424', + ], + 'example' => '', + ], + 'RoleList' => [ + 'title' => '', + 'description' => 'The list of member roles.', + 'type' => 'array', + 'items' => ['description' => 'The role.', 'type' => 'string', 'example' => 'DATA_ADMIN', 'title' => ''], + 'example' => '', + ], ], + 'example' => '', ], - 'CronExpression' => [ - 'title' => '定时调度-cron表达式', - 'description' => '', - 'type' => 'string', - 'example' => '* * 1/* * * *', - ], - 'ValidatePartitionType' => [ - 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', - 'description' => '', - 'type' => 'string', - 'example' => 'TASK_REFERRED_PARTITION', - ], - 'Creator' => [ - 'title' => '创建人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'Modifier' => [ - 'title' => '最近修改人ID', - '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', - ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'ListTenantMembers', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualitySchedule' => [ - 'summary' => '获取质量调度对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListTenantMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListUserGroupMembers' => [ + 'summary' => 'Performs a paging query of user group members.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44364,232 +32813,144 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '调度对象Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The paged query parameters.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'The username keyword.', 'type' => 'string', 'required' => false, 'example' => 'a'], + 'UserGroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => false, 'example' => '232231'], + 'UserIdList' => [ + 'title' => '', + 'description' => 'The user ID.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '2231111'], + 'required' => false, + 'example' => '', + ], + 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'QualityScheduleInfo' => [ - 'title' => '调度对象详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Id' => [ - 'title' => '调度对象Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PERIOD_SCHEDULE', - ], - 'PartitionType' => [ - 'title' => '分区类型: EVERY_DAY 每天、PRE_DAY 昨天、TODAY 当天、FIRST_DAY_OF_WEEK 每周第一天(周日)、CUSTOM 自定义等', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'PartitionExpression' => [ - 'title' => '分区表达式-自定义表达式', - 'description' => '', - 'type' => 'string', - 'example' => 'ds=${yyyyMMdd}', - ], - 'TriggerType' => [ - 'title' => '触发调度-触发方式：STATIC_TASK_TRIGGER 固定任务触发、CODE_CHECK_TRIGGER 代码检查触发', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'ONE_TASKS_FINISHED', - ], - 'PeriodScheduleIntervalType' => [ - 'title' => '定时调度-调度周期类型: DAILY 天、WEEKLY 周、MONTHLY 月、HOURLY 小时、MINUTELY 分钟', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'PeriodScheduleParamList' => [ - 'title' => '定时调度-调度周期值', - 'description' => '', + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '217'], + 'MemberList' => [ + 'title' => '', + 'description' => 'The paged list.', 'type' => 'array', 'items' => [ - 'title' => '定时调度-调度周期值', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', + 'description' => 'The user group member.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user group member ID.', 'type' => 'string', 'example' => '2324211'], + 'UserGroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '231111'], + 'UserInfo' => [ + 'title' => '', + 'description' => 'The user group member.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '13232'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'xx测试'], + 'AccountName' => ['title' => '', 'description' => 'The account name of the user.', 'type' => 'string', 'example' => 'atest'], + ], + 'example' => '', + ], + 'UserRole' => ['title' => '', 'description' => 'The role of the member in the user group.', 'type' => 'string', 'example' => 'SECURITY_ADMIN'], + 'Creator' => [ + 'title' => '', + 'description' => 'The user who added the member.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12121111'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'zhangsan'], + 'AccountName' => ['title' => '', 'description' => 'The account name of the user.', 'type' => 'string', 'example' => '12121111'], + ], + 'example' => '', + ], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the member was added to the user group.', 'type' => 'integer', 'format' => 'int64', 'example' => 'zhangsan'], + ], + 'title' => '', + 'example' => '', ], - ], - 'CronExpression' => [ - 'title' => '定时调度-cron表达式', - 'description' => '', - 'type' => 'string', - 'example' => '* * 1/* * * *', - ], - 'ValidatePartitionType' => [ - 'title' => '校验范围: TASK_REFERRED_PARTITION 任务更新分区,USER_DEFINED_PARTITION 自定义分区', - 'description' => '', - 'type' => 'string', - 'example' => 'TASK_REFERRED_PARTITION', - ], - 'Creator' => [ - 'title' => '创建人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'Modifier' => [ - 'title' => '最近修改人ID', - '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', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Paging query of user group members', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityRuleTaskLog' => [ - 'summary' => '获取质量任务对象日志内容。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListUserGroupMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ListUserGroups' => [ + 'summary' => 'Queries user groups by paging.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44597,1095 +32958,428 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RuleTaskId', - 'in' => 'query', + 'name' => 'ListQuery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '规则任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The paged query parameters.', + 'type' => 'object', + 'properties' => [ + 'Keyword' => ['title' => '', 'description' => 'The keyword for the user group name.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Active' => ['title' => '', 'description' => 'Specifies whether the user group is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AdminIdList' => [ + 'title' => '', + 'description' => 'The user IDs of the user group administrators.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user IDs of the user group administrators.', 'type' => 'string', 'required' => false, 'example' => '131311'], + 'required' => false, + 'example' => '', + ], + 'FilterMine' => ['title' => '', 'description' => 'Specifies whether to filter user groups that the current user belongs to.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PageResult' => [ + 'title' => '', + 'description' => 'The paged query result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '49'], + 'UserGroupList' => [ + 'title' => '', + 'description' => 'The paged list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The user group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => '31313232'], + 'Name' => ['title' => '', 'description' => 'The user group name.', 'type' => 'string', 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'The description of the user group.', 'type' => 'string', 'example' => 'xx 测试'], + 'Active' => ['title' => '', 'description' => 'Specifies whether the user group is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'AdminList' => [ + 'title' => '', + 'description' => 'The administrators of the user group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The administrators of the user group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '32313131'], + 'DisplayName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '张三'], + 'AccountName' => ['title' => '', 'description' => 'The account name of the user.', 'type' => 'string', 'example' => 'zhangsan'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'MyRole' => ['title' => '', 'description' => 'The role of the current user in the user group.', 'type' => 'string', 'example' => 'SECURITY_ADMIN'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Paged query of user groups', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityRuleTask' => [ - 'summary' => '获取质量任务对象详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListUserGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'OfflineBatchTask' => [ + 'summary' => 'Offlines a batch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RuleTaskId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '规则任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node ID in the node directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The remarks for the offline operation.', 'type' => 'string', 'required' => true, 'example' => 'test xx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'RuleTaskInfo' => [ - 'title' => '规则任务详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'OfflineResult' => [ + 'title' => '', + 'description' => 'The offline result.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '所属监控ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'WatchTaskId' => [ - 'title' => '监控任务ID，试跑的规则任务这个ID为空', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'title' => '规则任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RuleId' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30012011', - ], + 'PublishObjectId' => ['title' => '', 'description' => 'The ID of the object to be published.', 'type' => 'integer', 'format' => 'int64', 'example' => '10211123'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"OfflineResult\\": {\\n \\"PublishObjectId\\": 10211123\\n }\\n}","type":"json"}]', + 'title' => 'Offline a batch task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityRule' => [ - 'summary' => '获取质量规则对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OfflineBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'OfflineBizEntity' => [ + 'summary' => 'Offline a business entity.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'OfflineCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Offline request', + 'type' => 'object', + 'properties' => [ + 'BizUnitId' => ['title' => '', 'description' => 'Business unit ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], + 'Type' => ['title' => '', 'description' => 'Business entity type. For more information, see the "CreateBizEntity" operation.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + 'Id' => ['title' => '', 'description' => 'Business entity ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + 'Comment' => ['title' => '', 'description' => 'Offline comment', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'title' => '质量规则名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'title' => '质量规则状态: ENABLE，DISABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'ENABLE', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Strength' => [ - 'title' => '规则强弱: STRONG、WEAK', - 'description' => '', - 'type' => 'string', - 'example' => 'STRONG', - ], - 'CatalogList' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则分类: CONSISTENT 一致性，EFFECTIVE 有效性，TIMELINESE 时效性，ACCURATE 准确性，UNIQUENESS 唯一性，COMPLETENESS 完整性，STABILITY 稳定性，CUSTOM 自定义', - 'description' => '', - 'type' => 'string', - 'example' => 'CONSISTENT', - ], - ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FIELD_NULL_VALUE_VALIDATE', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TemplateScope' => [ - 'title' => '模板类型分组: SYSTEM 系统预置、CUSTOM 自定义模板、TEMPLATE SYSTEM及CUSTOM并集、 CUSTOM_SQL 自定义SQL模板', - 'description' => '', - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'WatchId' => [ - 'title' => '所属监控ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '268', - ], - 'Type' => [ - 'title' => '条件类型: RELATION 关系，EXPRESSION：表达式', - 'description' => '', - 'type' => 'string', - 'example' => 'RELATION', - ], - 'Operator' => [ - 'title' => '操作符: EQUAL，NOT_EQUAL，LARGER，SMALLER，LARGE_OR_EQUAL，SMALLER_OR_EQUAL，AND，OR', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - 'TestRunRuleTaskId' => [ - 'title' => '最近一次试跑任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'TestRunRuleTaskStatus' => [ - 'title' => '最近一次试跑任务状态：NOT_RUN，WAITING，RUNNING，SUCCESS，FAILED', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'TestRunRuleValidateResult' => [ - 'title' => '试跑校验是否通过', - 'description' => '', - 'type' => 'boolean', - ], - 'ScheduleBindList' => [ - 'title' => '规则绑定的调度列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ScheduleId' => [ - 'title' => '调度Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOMIZED', - ], - 'DataType' => [ - 'title' => '属性字段类型: STRING 文本型,BIGINT 数值整型,DOUBLE 数值浮点型,BOOLEAN 布尔型,DATE 日期型,DATETIME 时间型', - 'description' => '', - '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' => '', - '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code of the request. OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message of the request', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'OfflineBizEntity', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:26:34.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetQualityAlertOfAllRuleScopeByWatchId' => [ - 'summary' => '通过监控对象ID获取告警设置。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OfflineBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'OfflinePipeline' => [ + 'summary' => 'Offlines an integration pipeline node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The current operating environment. Valid values:'."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', ], ], [ - 'name' => 'WatchId', - 'in' => 'query', + 'name' => 'OfflineCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The offline command for the pipeline node.', + 'type' => 'object', + 'properties' => [ + 'Delete' => ['title' => '', 'description' => 'Specifies whether to delete the node.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the integration node. You can specify any one of PipelineId, FileId, or NodeId.', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The primary key of the integration pipeline. You can specify any one of PipelineId, FileId, or NodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'The file ID of the integration node. You can specify any one of PipelineId, FileId, or NodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + ], 'required' => true, - 'example' => '11', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'QualityAlertInfo' => [ - 'title' => '告警设置详情', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error message returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The result of offlining the pipeline node.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - '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' => '', - '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' => '', - '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', - ], - ], + 'SubmitId' => ['title' => '', 'description' => 'The submit ID of the pending publish list generated by submitting the pipeline. Use this ID to publish through the publish domain.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'HostMachine' => ['title' => '', 'description' => 'The name and IP address of the server that executed the request.', 'type' => 'string', 'example' => 'hostName:hostIp'], + 'Version' => ['title' => '', 'description' => 'The version number generated after submission.', 'type' => 'string', 'example' => '1'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline node after successful creation.', 'type' => 'string', 'example' => '123'], + 'PipelineId' => ['title' => '', 'description' => 'The pipeline ID after successful creation.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Offline a pipeline node', + 'extraInfo' => 'For usage details, refer to the demo in the utility package: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteQualityWatches' => [ - 'summary' => '批量删除质量监控对象。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OfflinePipelineByAsync' => [ + 'summary' => 'Asynchronously offlines an integration pipeline node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -45694,127 +33388,93 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The environment for the current operation. Valid values:'."\n" + ."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', ], ], [ - 'name' => 'DeleteCommand', + 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The offline pipeline node command.', 'type' => 'object', 'properties' => [ - 'WatchIdList' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - 'required' => true, - ], + 'Delete' => ['title' => '', 'description' => 'Specifies whether to delete the node.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'NodeId' => ['title' => '', 'description' => 'The schedule node ID of the integration node. You can use this parameter to query the node.', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The primary key ID of the integration pipeline. You can use this parameter to query the node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'The file ID of the integration node. You can use this parameter to query the node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The query ID for the asynchronous execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Asynchronously offline a pipeline node', + 'extraInfo' => 'For usage details, refer to the demo in the utility package: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteQualityTemplates' => [ - 'summary' => '批量删除质量模板对象。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OfflineStandard' => [ + 'summary' => 'Offlines a standard.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -45823,128 +33483,68 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'OfflineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The offline instruction.', 'type' => 'object', 'properties' => [ - 'TemplateIdList' => [ - 'title' => '模板对象ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '模板对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - 'required' => true, - ], + 'Id' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Comment' => ['title' => '', 'description' => 'The review remarks. The value can be up to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Offline a standard', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteQualitySchedules' => [ - 'summary' => '批量删除质量调度对象。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'OnlineBizEntity' => [ + 'summary' => 'Brings a business entity online.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45952,128 +33552,89 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'OnlineCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The online request.', 'type' => 'object', 'properties' => [ - 'ScheduleIdList' => [ - 'title' => '调度对象ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '调度对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - 'required' => true, - ], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the entity belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], + 'Type' => ['title' => '', 'description' => 'The business type. Valid values:'."\n" + .'- BIZ_OBJECT'."\n" + .'- BIZ_PROCESS.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + 'Id' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + 'Comment' => ['title' => '', 'description' => 'The remarks for the offline operation.', 'type' => 'string', 'required' => true, 'example' => 'test'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Bring a business entity online', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:50.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteQualityRules' => [ - 'summary' => '批量删除质量规则对象。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OnlineBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'OperateInstance' => [ + 'summary' => 'Performs batch O&M operations on instances. Both physical instances and logical table instances are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46081,277 +33642,285 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'OperateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'The operation request.', 'type' => 'object', 'properties' => [ - 'RuleIdList' => [ - 'title' => '规则ID', - 'description' => '', + 'InstanceIdList' => [ + 'title' => '', + 'description' => 'The list of instances to operate on.', 'type' => 'array', 'items' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The instance to operate on.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 't_32111312', 'title' => ''], + 'FieldInstanceIdList' => [ + 'description' => 'The field instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The field instance IDs.', 'type' => 'string', 'required' => false, 'example' => 't_2311', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '11', + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '', ], + 'Operation' => ['title' => '', 'description' => 'The operation to perform. Valid values: '."\n" + .'- RERUN: Reruns the instance.'."\n" + .'- PAUSE: Pauses the instance.'."\n" + .'- RESUME: Resumes the instance.'."\n" + .'- TERMINATE: Stops the instance.'."\n" + .'- SET_SUCCESS: Sets the instance status to successful.', 'type' => 'string', 'required' => true, 'example' => 'RERUN'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '132311'], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment. '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'InstanceStatusList' => [ + 'title' => '', + 'description' => 'The O&M results of the instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The O&M results of the instances.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 't_132435'], + 'Name' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'xx测试'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the instance.', 'type' => 'string', 'example' => 'xx测试'], + 'Status' => ['title' => '', 'description' => 'The result of the operation, which indicates success or failure.', 'type' => 'string', 'example' => 'SUCCESS'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message returned when the operation fails.', 'type' => 'string', 'example' => 'xx'], + 'OwnerId' => ['title' => '', 'description' => 'The owner of the instance.', 'type' => 'string', 'example' => '121311'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the instance.', 'type' => 'string', 'example' => 'xx测试'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - '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 \\"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' => 'Instance O&M', + 'changeSet' => [ + ['createdAt' => '2025-02-20T10:46:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T08:23:50.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'AssignQualityRuleOfAllRuleScopeSchedules' => [ - 'summary' => '指定质量规则和调度设置进行绑定。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OperateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'ParseBatchTaskDependency' => [ + 'summary' => 'Parses the logical table dependencies of an offline compute node. The parsing result may contain self-dependent nodes in the upstream dependency information, where the upstream node ID is the same as the node ID of the parsed code. You must handle such cases on your own.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AssignCommand', + 'name' => 'ParseCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分派绑定指令', - 'description' => '', + 'title' => '', + 'description' => 'The parse request.', 'type' => 'object', 'properties' => [ - 'WatchId' => [ - 'title' => '监控对象ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '平均值', - ], - 'RuleIdList' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - 'required' => true, - ], - 'ScheduleIdList' => [ - 'title' => '调度ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '调度ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '22', - ], - 'required' => true, - ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'Code' => ['title' => '', 'description' => 'The SQL code to be parsed.', 'type' => 'string', 'required' => true, 'example' => 'select * from t_test limit 1;'], + 'IncludeAllInputTables' => ['title' => '', 'description' => 'Specifies whether to include dependency information for input tables that have no corresponding nodes. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'NeedQueryLineages' => ['title' => '', 'description' => 'Specifies whether to query data lineage when querying upstream dependencies. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'OperatorType' => ['title' => '', 'description' => 'The node type, such as MAX_COMPUTE_SQL.', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL'], + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for a database SQL node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for a database SQL node. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for a database SQL node. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'required' => false, 'example' => 'erp'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'ParseResult' => [ + 'title' => '', + 'description' => 'The parsing result.', + 'type' => 'object', + 'properties' => [ + 'DependNodeList' => [ + 'title' => '', + 'description' => 'The list of dependent nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The list of dependent nodes.', + 'type' => 'object', + 'properties' => [ + 'NodeIoType' => ['title' => '', 'description' => 'The input/output type. Valid values: input (dependent node) and output (node output name).', 'type' => 'string', 'example' => 'input'], + 'ScheduleNodeInfoList' => [ + 'title' => '', + 'description' => 'The list of schedule nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node details.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['title' => '', 'description' => 'The output table name of the node.', 'type' => 'string', 'example' => 't_test'], + 'OutputName' => ['title' => '', 'description' => 'The output name of the node.', 'type' => 'string', 'example' => 't_test'], + 'FieldList' => [ + 'title' => '', + 'description' => 'The list of fields. This parameter applies only to logical table dependencies.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The field.', 'type' => 'string', 'example' => 'column1'], + 'example' => '', + ], + 'OwnerUserId' => ['title' => '', 'description' => 'The owner of the node. This parameter is empty if no node is found for the corresponding input table.', 'type' => 'string', 'example' => '201122301'], + 'OwnerName' => ['title' => '', 'description' => 'The owner of the node. This parameter is empty if no node is found for the corresponding input table.', 'type' => 'string', 'example' => '张三'], + 'NodeId' => ['title' => '', 'description' => 'The node ID. A value of -1 is returned if no node is found for the corresponding input table.', 'type' => 'string', 'example' => 'n_11013121'], + 'NodeName' => ['title' => '', 'description' => 'The node name. This parameter is empty if no node is found for the corresponding input table.', 'type' => 'string', 'example' => 'test11'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\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' => 'Parse logical table dependencies of an offline compute node', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:50.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateSecurityLevel' => [ - 'summary' => '通过分级顺序更新数据分级。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:ParseBatchTaskDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'PausePhysicalNode' => [ + 'summary' => 'Pauses the scheduling of physical nodes. This stops the scheduling of nodes, and downstream nodes cannot be triggered. Currently, only offline code nodes and integration nodes are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46359,128 +33928,116 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'PauseCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The pause scheduling request.', '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', + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13222210'], + 'NodeIdList' => [ + 'title' => '', + 'description' => 'The list of node IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'n_2311121'], + 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment identifier. Valid values:'."\n" + .'- DEV: development environment '."\n" + .'- PROD (default): production environment.', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'NodeOperateResultList' => [ + 'title' => '', + 'description' => 'The results of the pause scheduling operations on the nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The results of the pause scheduling operations on the nodes.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'Status' => ['title' => '', 'description' => 'The operation result.', 'type' => 'string', 'example' => 'SUCCESS'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message returned when the operation fails.', 'type' => 'string', 'example' => 'xx '], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Pause physical node scheduling', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:50.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateSecurityIdentifyResultStatus' => [ - 'summary' => '更新安全识别结果的生效状态。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:PausePhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PublishDataServiceApi' => [ + 'summary' => 'Publishes a data service API to the production environment.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -46489,132 +34046,67 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '识别结果ID列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'required' => true, - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The API version number.', 'type' => 'string', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Publish a data service API', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateSecurityClassifyCatalog' => [ - 'summary' => '更新数据分类目录。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'PublishObjectList' => [ + 'summary' => 'Publishes objects in batches.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46622,153 +34114,109 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'PublishCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The publish command.', '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' => '', + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], + 'SubmitIdList' => [ + 'title' => '', + 'description' => 'The list of pending publish record IDs to be published. A maximum of 50 submit IDs can be specified.', 'type' => 'array', - 'items' => [ - 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', - ], - 'required' => false, - ], - 'VisibleType' => [ - 'title' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', + 'items' => ['title' => '', 'description' => 'The pending publish record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'], + 'required' => true, + 'example' => '', ], + 'Comment' => ['title' => '', 'description' => 'The publish comment. The string can be up to 1024 characters in length.', 'type' => 'string', 'required' => true, 'example' => '发布'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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/', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'PublishResult' => [ + 'title' => '', + 'description' => 'The publish result.', + 'type' => 'object', + 'properties' => [ + 'SubmitIdList' => [ + 'title' => '', + 'description' => 'The list of pending publish record IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The pending publish record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"PublishResult\\": {\\n \\"SubmitIdList\\": [\\n 12345\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Batch publish objects', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:50.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'UpdateSecurityClassify' => [ - 'summary' => '更新数据分类。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:PublishObjectList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PublishStandard' => [ + 'summary' => 'Publishes a standard.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -46777,1449 +34225,404 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateCommand', + 'name' => 'PublishCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The publish command.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '分类ID，不传递时按照分类名称+分类父路径匹配分类进行更新', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'AdvancedConditionList' => [ - 'title' => '高级配置', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Version' => ['title' => '', 'description' => 'The version number. Default value: -1 (latest version).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'StandardStage' => ['title' => '', 'description' => 'The stage of the standard. Valid values: DEV and PROD. Default value: DEV.', 'type' => 'string', 'required' => false, 'example' => 'DEV'], + 'AutoPublishAfterApproval' => ['title' => '', 'description' => 'Specifies whether to automatically publish after approval. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'ReviewerIdList' => [ + 'title' => '', + 'description' => 'The specified reviewers.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'title' => '特征条件父节点', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'Id' => [ - 'title' => '特征条件节点id，由业务随机生成且确保唯一', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '234', - ], - 'Relation' => [ - 'title' => '条件关系: EXPRESSION 表达式、RELATION 关系', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'EXPRESSION', - ], - 'Property' => [ - 'title' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'The specified reviewer.', 'type' => 'string', 'required' => false, 'example' => '1'], 'required' => false, - 'example' => 'ENABLE', + 'example' => '', ], + 'Comment' => ['title' => '', 'description' => 'The review comment. Maximum length: 128 characters.', 'type' => 'string', 'required' => true, 'example' => 'test'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'PublishStandard', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListSecurityIdentifyResults' => [ - 'summary' => '分页查询安全识别结果。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RemoveDataServiceAppMember' => [ + 'summary' => 'Remove regular members from a data service application. Only the application owner can perform this operation.'."\n" + .'Released version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'title' => '', + 'description' => 'Remove regular members from a data service application', 'type' => 'object', 'properties' => [ - 'ClassifyId' => [ - 'title' => '数据分类Id', - 'description' => '', - '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' => '', + 'AppId' => ['title' => '', 'description' => 'Application ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200000000'], + 'MemberIds' => [ + 'title' => '', + 'description' => 'List of application member IDs', 'type' => 'array', - 'items' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => false, - ], - 'Status' => [ - 'title' => '生效状态筛选: ENABLE 开启、DISABLE 关闭', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLE', - ], - 'IsLocked' => [ - 'title' => '是否已锁定', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Keyword' => [ - 'title' => '搜索词筛选: 支持按表catalog、表名、表中文名、字段名匹配', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'items' => ['title' => '', 'description' => 'List of application member IDs', 'type' => 'string', 'required' => true, 'example' => '200000245'], + 'required' => true, + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ScanTaskId' => [ - 'title' => '扫描任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'TableTaskId' => [ - 'title' => '识别表任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'ClassifyId' => [ - 'title' => '分类ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101121', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectDisplayName' => [ - 'title' => '项目中文名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DatasourceId' => [ - 'title' => '数据源ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_TABLE', - ], - 'TableCatalog' => [ - 'title' => '表Catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'testdb', - ], - 'TableId' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_test', - ], - 'TableDescription' => [ - 'title' => '表描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'FieldId' => [ - 'title' => '字段ID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99', - ], - 'Status' => [ - 'title' => '状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Backend exception details', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Remove regular members from a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListSecurityIdentifyRecords' => [ - 'summary' => '分页查询安全识别结果的识别记录。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RemoveProjectMember' => [ + 'summary' => 'Deletes a project member.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + ], + [ + 'name' => 'RemoveCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '检索条件', - 'description' => '', + 'title' => '', + 'description' => 'The command to remove a member.', 'type' => 'object', 'properties' => [ - 'IsDatasourceTable' => [ - 'title' => '是否数据源表, 默认否(视为Dataphin表)', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'DatasourceName' => [ - 'title' => '数据源名称,仅数据源表需要填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'DatasourceEnv' => [ - 'title' => '数据源环境标识,仅数据源表需要填写', - 'description' => '', - 'type' => 'string', + 'Env' => ['title' => '', 'description' => 'The environment identifier. Valid values: DEV and PROD.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'UserIdList' => [ + 'title' => '', + 'description' => 'The user IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user IDs.', 'type' => 'string', 'example' => '30012011', 'required' => false], 'required' => false, - 'example' => 'DEV', - ], - 'TableCatalog' => [ - 'title' => '表Catalog,数据源表请填写所属db或schema名称；Dataphin物理表请填写项目英文名；Dataphin逻辑表请填写板块英文名', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'BizUnitId' => [ - 'title' => '业务板块ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DatasourceName' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TableEnv' => [ - 'title' => '表环境', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'TableId' => [ - 'title' => '表ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_TABLE', - ], - 'FieldId' => [ - 'title' => '字段ID', - 'description' => '', - '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' => '', - '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' => '', - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Delete a project member', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetSecuritySecretKey' => [ - 'summary' => '通过密钥名称获取密钥值。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RemoveQualityRuleSchedules' => [ + 'summary' => 'Deletes the bindings between quality rules and schedules in batches.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'RemoveCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '密钥名称', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The unbinding instruction.', + 'type' => 'object', + 'properties' => [ + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '平均值'], + 'RuleId' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'ScheduleIdList' => [ + 'title' => '', + 'description' => 'The schedule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The schedule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'test', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'HASH', - ], - 'AlgorithmType' => [ - 'title' => '算法类型: AES、DES、DESEDE、SM2、SM4、RSA、FF1', - 'description' => '', - 'type' => 'string', - 'example' => 'AES', - ], - 'GenerationType' => [ - 'title' => '生成方式: SYSTEM_GENERATION 系统生成、USER_GENERATION 用户生成', - 'description' => '', - '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' => '', - 'type' => 'boolean', - ], - 'AlgorithmTypeAlias' => [ - 'title' => '算法类型alias', - 'description' => '', - 'type' => 'string', - 'example' => 'AES', - ], - 'Owner' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'OwnerName' => [ - 'title' => '负责人名称', - 'description' => '', - 'type' => 'string', - 'example' => '张三', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 0\\n}","type":"json"}]', + 'title' => 'Delete bindings between quality rules and schedules in batches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetSecurityLevel' => [ - 'summary' => '获取数据分级详情。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'RemoveTenantMember' => [ + 'summary' => 'Removes a tenant member. Only superusers and system administrators can call this API operation.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Index', - 'in' => 'query', + 'name' => 'RemoveCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据分级敏感程度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request command.', + 'type' => 'object', + 'properties' => [ + 'SourceId' => ['title' => '', 'description' => 'The source ID of the user.', 'type' => 'string', 'required' => true, 'example' => '123@xx.com'], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response result.', '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '绑定当前数据分级的数据分类Id列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Remove a tenant member', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetSecurityIdentifyResult' => [ - 'summary' => '获取识别结果详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:RemoveTenantMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'RemoveUserGroupMember' => [ + 'summary' => 'Removes members from a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -48227,341 +34630,93 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'RemoveCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '识别结果ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The command to remove user group members.', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => '2311'], + 'UserIdList' => [ + 'title' => '', + 'description' => 'The list of user IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '131313'], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ScanTaskId' => [ - 'title' => '扫描任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'TableTaskId' => [ - 'title' => '识别表任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'ClassifyId' => [ - 'title' => '分类ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101121', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectDisplayName' => [ - 'title' => '项目中文名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DatasourceId' => [ - 'title' => '数据源ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'LOGIC_TABLE', - ], - 'TableCatalog' => [ - 'title' => '表Catalog', - 'description' => '', - 'type' => 'string', - 'example' => 'testdb', - ], - 'TableId' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_test', - ], - 'TableDescription' => [ - 'title' => '表描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'FieldId' => [ - 'title' => '字段ID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99', - ], - 'Status' => [ - 'title' => '状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', - '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of removing members from the user group.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Remove user group members', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetSecurityClassify' => [ - 'summary' => '获取数据分类详情。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:RemoveUserGroupMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ReplaceProjectWhiteLists' => [ + 'summary' => 'Updates the whitelist of a project.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -48570,156 +34725,91 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ 'name' => 'Id', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1030111021'], + ], + [ + 'name' => 'ReplaceCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '分类ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The edit command.', + 'type' => 'object', + 'properties' => [ + 'WhiteLists' => [ + 'title' => '', + 'description' => 'The project whitelist.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '测试'], + 'Ip' => ['title' => '', 'description' => 'ip', 'type' => 'string', 'required' => true, 'example' => '10.1.0.2'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'string', 'required' => true, 'example' => '5432'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LevelName' => [ - 'title' => '分级名称', - 'description' => '', - 'type' => 'string', - 'example' => 'lv_teat', - ], - 'LevelAbbreviation' => [ - 'title' => '分级缩写名', - 'description' => '', - 'type' => 'string', - 'example' => 'lv_test', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Replace project whitelist', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteSecurityLevel' => [ - 'summary' => '删除数据分级。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ResetDataServiceAppSecret' => [ + 'summary' => 'Reset the Data Service application key. Only the application owner can perform this operation.'."\n" + .'Release version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -48728,152 +34818,84 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'Reset Data Service Application Key', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'title' => '分级敏感等级,当不传递时将按照分级名称进行精确匹配删除', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Name' => [ - 'title' => '分级名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'AppId' => ['title' => '', 'description' => 'Application ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12345'], + 'AppKey' => ['title' => '', 'description' => 'The new application key, which must be globally unique and is used when calling APIs.'."\n" + .'The length is 8 to 128 English characters, and can contain digits, underscores (_), and hyphens (-).'."\n" + .'Customization is supported only when using Alibaba Cloud API Gateway or the built-in gateway. This configuration is ignored when using a dedicated cloud gateway.', 'type' => 'string', 'required' => false, 'example' => '200000001', 'maxLength' => 128, 'minLength' => 8], + 'AppSecret' => ['title' => '', 'description' => 'The new application secret.'."\n" + .'If this parameter is left empty, the system automatically generates a new AppSecret value.'."\n" + .'The length is 8 to 127 English characters, and can contain digits, underscores (_), and hyphens (-).'."\n" + .'Customization is supported only when using Alibaba Cloud API Gateway or the built-in gateway. This configuration is ignored when using a dedicated cloud gateway.', 'type' => 'string', 'required' => false, 'example' => 'abc123456789', 'maxLength' => 127, 'minLength' => 8], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'DeleteResult' => [ - 'title' => '删除结果', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Backend exception details', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => ''], + 'Data' => [ + 'title' => '', + 'description' => 'Reset Data Service application key result', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'ErrorCode' => [ - 'title' => '异常代码', - 'description' => '', - 'type' => 'string', - 'example' => 'E10012011', - ], - 'RelatedClassifyIdList' => [ - 'title' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '绑定当前分级的数据分类ID清单,仅触发该报错时返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], + 'AppKey' => ['title' => '', 'description' => 'The new application key', 'type' => 'string', 'example' => '200000001'], + 'AppSecret' => ['title' => '', 'description' => 'The new application secret', 'type' => 'string', 'example' => 'abc123456789'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false,\\n \\"Data\\": {\\n \\"AppKey\\": \\"200000001\\",\\n \\"AppSecret\\": \\"abc123456789\\"\\n }\\n}","type":"json"}]', + 'title' => 'Reset Data Service Application Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteSecurityIdentifyResults' => [ - 'summary' => '批量删除安全识别结果。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'ResumePhysicalNode' => [ + 'summary' => 'Resume physical node scheduling.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -48881,281 +34903,188 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'ResumeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'title' => '', + 'description' => 'Resume scheduling request.', 'type' => 'object', 'properties' => [ - 'IdentifyResultIdList' => [ - 'title' => '识别结果ID列表', - 'description' => '', + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102011'], + 'NodeIdList' => [ + 'title' => '', + 'description' => 'Node ID list.', 'type' => 'array', - 'items' => [ - 'title' => '识别结果ID列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, + 'items' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'required' => true, 'example' => '30132'], + 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Environment identifier.'."\n" + .'- DEV: Development environment'."\n" + .'- PROD (default): Production environment', 'type' => 'string', 'required' => false, 'example' => 'PROD'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response result.', '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' => '', - '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', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates a successful request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], + 'NodeOperateResultList' => [ + 'title' => '', + 'description' => 'Results of the node resume scheduling operation.', + 'type' => 'array', + 'items' => [ + 'description' => 'Result of the node resume scheduling operation.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => 'n_123456'], + 'Status' => ['title' => '', 'description' => 'Operation result.', 'type' => 'string', 'example' => 'SUCCESS'], + 'ErrorMessage' => ['title' => '', 'description' => 'Error message returned when the operation fails.', 'type' => 'string', 'example' => 'xx'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Resume physical node scheduling', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteSecurityClassifyCatalog' => [ - 'summary' => '删除数据分类目录。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:ResumePhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'RetryTransferOwnership' => [ + 'summary' => 'Retransfers a failed transfer task.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'PrivilegeTransferRecord', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除指令', - 'description' => '', + 'description' => 'The transfer information.', 'type' => 'object', 'properties' => [ - 'Path' => [ - 'title' => '原目录的完整路径', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/d1/d2/', - ], - 'ReturnRemovedDetails' => [ - 'title' => '是否返回删除详情,默认: true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], + 'Id' => ['title' => '', 'description' => 'The ID of the transfer task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'NewOwner' => ['title' => '', 'description' => 'The user ID of the recipient.', 'type' => 'string', 'required' => true, 'example' => '30000001'], + 'TransferComment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '被连带删除的分类ID列表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The ID of the transfer record.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 2\\n}","type":"json"}]', + 'title' => 'Retransfer a failed transfer task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteSecurityClassify' => [ - 'summary' => '删除数据分类。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RevokeDataServiceApi' => [ + 'summary' => 'Revokes API authorization.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -49164,134 +35093,86 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteCommand', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data service project ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '102102'], + ], + [ + 'name' => 'RevokeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新指令', - 'description' => '', + 'title' => '', + 'description' => 'The revoke instruction.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '分类ID, 不传递时按照分类名称+分类父路径匹配分类进行删除', - 'description' => '', - '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' => '/', - ], + 'AppId' => ['title' => '', 'description' => 'The ID of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1203'], + 'ApiId' => ['title' => '', 'description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1021'], + 'Reason' => ['title' => '', 'description' => 'The reason for the request.', 'type' => 'string', 'required' => true, 'example' => 'test', 'maxLength' => 128], + 'Env' => ['title' => '', 'description' => 'The API environment. Valid values:'."\n" + .'- DEV: development environment'."\n" + .'- PROD: production environment.', 'type' => 'string', 'example' => 'PROD', 'required' => false], + 'AuthType' => ['title' => '', 'description' => 'The permission type. Valid values:'."\n" + .'- USE: use permission'."\n" + .'- DELEGATION: delegation permission.', 'type' => 'string', 'example' => 'USE', 'default' => 'USE', 'required' => false], + 'GranteeType' => ['title' => '', 'description' => 'The authorization object type. Valid values:'."\n" + .'- APP: application'."\n" + .'- USER: user.', 'type' => 'string', 'example' => 'APP', 'default' => 'APP', 'required' => false], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '12345', 'required' => false], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - '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"}]', - ], - 'CreateSecurityLevel' => [ - 'summary' => '新建数据分级。', - 'methods' => [ - 'post', + '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' => 'Revoke data service API authorization', + 'changeSet' => [ + ['createdAt' => '2026-02-27T08:12:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [], + 'ramActions' => [], + ], + 'RevokeResourcePermission' => [ + 'summary' => 'Revokes resource authorization from a user.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49299,143 +35180,111 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'RevokeCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The authorization revocation request.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '分级名称', - 'description' => '', - 'type' => 'string', + 'ResourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'PHYSICAL_TABLE'], + 'ResourceList' => [ + 'title' => '', + 'description' => 'The list of resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'odps.300002102.beginner_test.amin_table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'test', - ], - 'Abbreviation' => [ - 'title' => '分级缩写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Index' => [ - 'title' => '分级顺序，不传递将默认生成当前最大顺序Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'example' => '', ], - 'Description' => [ - 'title' => '分级描述', - 'description' => '', - 'type' => 'string', + 'OperateList' => [ + 'title' => '', + 'description' => 'The list of operations.', + 'type' => 'array', + 'items' => ['description' => 'The operation.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], 'required' => false, - 'example' => 'test', + 'example' => '', ], + 'Reason' => ['title' => '', 'description' => 'The reason for revoking the authorization.', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '13131'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The 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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Revoke user resource authorization', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateSecurityIdentifyResult' => [ - 'summary' => '新建安全识别结果。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:RevokeResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'StopAdHocTask' => [ + 'summary' => 'Stops an ad hoc query task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49443,178 +35292,78 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant 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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'Enable' => [ - 'title' => '生效状态: true开启、false关闭, 默认: true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ConflictStrategy' => [ - 'title' => '去重策略: COVER_ALL 覆盖线上全部打标、COVER_UNLOCKED 仅覆盖线上未锁定打标、NOT_COVER 不覆盖,保留线上打标', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'COVER_ALL', - ], - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute_SQL_300000843_1611548758327'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '识别结果ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Stop an ad hoc query task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateSecurityClassifyCatalog' => [ - 'summary' => '新建数据分类目录。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:StopAdHocTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'SubmitBatchTask' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49622,2062 +35371,1210 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'The submit request.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '分类目录名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101'], + 'FileId' => ['title' => '', 'description' => 'The node ID in the directory tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + 'Comment' => ['title' => '', 'description' => 'The comment for the submit operation.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Name' => ['title' => '', 'description' => 'The name of the batch task.', 'type' => 'string', 'required' => true, 'example' => 'test111'], + 'NodeOutputNameList' => [ + 'title' => '', + 'description' => 'The list of node output names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The node output name.', 'type' => 'string', 'required' => true, 'example' => 'test1011'], + 'required' => false, + 'example' => '', ], - 'ParentPath' => [ - 'title' => '分类父目录完整路径,默认/', - 'description' => '', - 'type' => 'string', + 'NodeDescription' => ['title' => '', 'description' => 'The description of the node.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Engine' => ['title' => '', 'description' => 'The execution engine for the node, such as for Python tasks. Valid values:'."\n" + .'- PYTHON2_7'."\n" + .'- PYTHON3_7'."\n" + .'- PYTHON3_11', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7'], + 'SchedulePeriod' => ['title' => '', 'description' => 'The schedule period. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY', 'type' => 'string', 'required' => false, 'example' => 'DAILY'], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for automatic scheduling. Refer to the Linux cron expression syntax.', 'type' => 'string', 'required' => false, 'example' => '0 0 1 * * ?'], + 'CustomScheduleConfig' => [ + 'title' => '', + 'description' => 'The custom schedule interval configuration.', + 'type' => 'object', + 'properties' => [ + 'SchedulePeriod' => ['title' => '', 'description' => 'The schedule period. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY', 'type' => 'string', 'required' => true, 'example' => 'DAILY'], + 'Interval' => ['title' => '', 'description' => 'The custom interval.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'IntervalUnit' => ['title' => '', 'description' => 'The interval unit. Valid values:'."\n" + .'- MINUTE: minute'."\n" + .'- HOUR: hour', 'type' => 'string', 'required' => true, 'example' => 'HOUR'], + 'StartTime' => ['title' => '', 'description' => 'The start time in the format of HH:mm.', 'type' => 'string', 'required' => true, 'example' => '10:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time in the format of HH:mm.', 'type' => 'string', 'required' => true, 'example' => '10:00'], + ], 'required' => false, - 'example' => '/d1/', + 'example' => '', ], - 'OwnerList' => [ - 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', - 'description' => '', + 'Code' => ['title' => '', 'description' => 'The code of the node.', 'type' => 'string', 'required' => true, 'example' => 'show tables;'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The list of custom parameters.', 'type' => 'array', 'items' => [ - 'title' => '管理员ID列表，仅当所属父目录为根目录时填写有效', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30001011', + 'title' => '', + 'description' => 'The runtime parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => true, 'example' => 'key'], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => true, 'example' => 'key'], + ], + 'required' => true, + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'VisibleType' => [ - 'title' => '分类可见范围：PUBLIC 公开、PRIVATE 仅管理员可查看,默认PUBLIC;仅当所属父目录为根目录时填写有效', - 'description' => '', - 'type' => 'string', + 'Priority' => ['title' => '', 'description' => 'The scheduling priority of the node. Valid values: 1 to 9. A larger value indicates a lower priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'NodeStatus' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + .'- 1: Normal.'."\n" + .'- 2: Paused.'."\n" + .'- 3: Dry run.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'UpStreamList' => [ + 'title' => '', + 'description' => 'The upstream dependencies.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node association.', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['title' => '', 'description' => 'The type of the upstream dependency node. Valid values:'."\n" + .'- PHYSICAL: physical node'."\n" + .'- LOGICAL: logical table dependency', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL'], + 'SourceNodeId' => ['title' => '', 'description' => 'The ID of the upstream node.', 'type' => 'string', 'required' => false, 'example' => 'n_2001'], + 'SourceNodeOutputName' => ['title' => '', 'description' => 'The output name of the upstream node.', 'type' => 'string', 'required' => true, 'example' => 't_input1'], + 'SourceTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'required' => false, 'example' => 't_input1'], + 'PeriodDiff' => ['title' => '', 'description' => 'The period difference. A value of 0 indicates a same-period dependency. A positive number indicates a dependency on the previous N periods.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'FieldList' => [ + 'title' => '', + 'description' => 'The dependent logical table fields.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The dependent logical table fields.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'required' => false, + 'example' => '', + ], + 'SourceNodeEnabled' => ['title' => '', 'description' => 'Indicates whether the upstream node is enabled.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'DependStrategy' => ['title' => '', 'description' => 'The dependency strategy. Valid values:'."\n" + .'- ALL: all'."\n" + .'- FIRST: first'."\n" + .'- LAST: last'."\n" + .'- NEAR: nearest', 'type' => 'string', 'required' => false, 'example' => 'ALL'], + 'DependPeriod' => [ + 'title' => '', + 'description' => 'The dependency period.', + 'type' => 'object', + 'properties' => [ + 'PeriodType' => ['title' => '', 'description' => 'The dependency period type. Valid values:'."\n" + .'- CURRENT_PERIOD: current period'."\n" + .'- LAST_PERIOD: previous period'."\n" + .'- LAST_N_PERIOD: last N days'."\n" + .'- LAST_24_HOUR: last 24 hours', 'type' => 'string', 'required' => true, 'example' => 'CURRENT_PERIOD'], + 'PeriodOffset' => ['title' => '', 'description' => 'The period offset. This parameter is required when dependencyPeriodType is set to LAST_N_PERIOD.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], 'required' => false, - 'example' => 'PUBLIC', + 'example' => '', + ], + 'PythonModuleList' => [ + 'title' => '', + 'description' => 'The Python third-party packages that the node depends on.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The Python third-party package.', 'type' => 'string', 'required' => true, 'example' => 'numpy'], + 'required' => false, + 'example' => '', + ], + 'SparkClientInfo' => [ + 'title' => '', + 'description' => 'The Spark client information.', + 'type' => 'object', + 'properties' => [ + 'SparkClientVersion' => ['title' => '', 'description' => 'The version name of the Spark client.', 'type' => 'string', 'required' => true, 'example' => 'abc'], + ], + 'required' => false, + 'example' => '', + ], + 'OfflineCodeTemplateId' => ['type' => 'string', 'required' => false, 'example' => 'template_123456', 'description' => '', 'title' => ''], + 'CodeTemplateVersion' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'description' => '', 'title' => ''], + 'OfflineCodeTemplateParams' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'required' => false, 'example' => 'paramKey', 'description' => '', 'title' => ''], + 'Description' => ['type' => 'string', 'required' => false, 'example' => '参数说明', 'description' => '', 'title' => ''], + 'Value' => ['type' => 'string', 'required' => false, 'example' => 'paramValue', 'description' => '', 'title' => ''], + 'EncryptEnabled' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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/', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'SubmitResult' => [ + 'title' => '', + 'description' => 'The submit result.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '', 'description' => 'The ID of the scheduling node.', 'type' => 'string', 'example' => 'n_12113111'], + 'SubmitId' => ['title' => '', 'description' => 'The ID of the object pending publish.', 'type' => 'integer', 'format' => 'int64', 'example' => '1010312911'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit a batch task', + 'summary' => 'Submits a batch task.', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateSecurityClassify' => [ - 'summary' => '新建数据分类。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:SubmitBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SubmitResult\\": {\\n \\"NodeId\\": \\"n_12113111\\",\\n \\"SubmitId\\": 1010312911\\n }\\n}","type":"json"}]', + ], + 'SubmitQualityRuleTasks' => [ + 'summary' => 'Batch submit rule tasks with support for test runs.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建指令', - 'description' => '', + 'title' => '', + 'description' => 'Submit command', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'AdvancedConditionList' => [ - 'title' => '高级配置', - 'description' => '', + 'IsTestRun' => ['title' => '', 'description' => 'Whether it is a test run: true for test run, false for formal run.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'WatchRuleIdList' => [ + 'title' => '', + 'description' => 'Monitoring object and rule IDs', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ - 'ParentId' => [ - 'title' => '特征条件父节点', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'Id' => [ - 'title' => '特征条件节点id，由业务随机生成且确保唯一', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '234', - ], - 'Relation' => [ - 'title' => '条件关系: EXPRESSION 表达式、RELATION 关系', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'EXPRESSION', - ], - 'Property' => [ - 'title' => '特征属性: TABLE_NAME 表名称、TABLE_DESC 表描述、FIELD_CONTENT 字段内容、FIELD_NAME 字段名称、FIELD_DESC 字段描述、FIELD_TYPE 字段类型', - 'description' => '', - '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' => '', - '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, - ], + 'WatchId' => ['title' => '', 'description' => 'Monitoring object ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'RuleId' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], 'required' => false, + 'description' => '', + 'example' => '', ], - 'required' => false, - ], - 'Status' => [ - 'title' => '分类生效状态: ENABLE 启用、DISABLE 禁用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLE', + 'required' => true, + 'example' => '', ], + 'PartitionExpressionFrom' => ['title' => '', 'description' => 'Source of the test run partition expression: SCHEDULE for existing schedule, CUSTOM for custom.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM'], + 'ScheduleId' => ['title' => '', 'description' => 'Existing schedule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'PartitionExpression' => ['title' => '', 'description' => 'Partition expression - custom expression', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}'], + 'BizDate' => ['title' => '', 'description' => 'Business date, format: yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-06-30'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request was successful', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Details of the backend response exception', 'type' => 'string', 'example' => 'internal error'], + 'SubmitResult' => [ + 'title' => '', + 'description' => 'Execution result', + 'type' => 'object', + 'properties' => [ + 'RuleTaskIdList' => [ + 'title' => '', + 'description' => 'Rule task IDs, returned in the test run scenario', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Rule task IDs, returned in the test run scenario', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'example' => '', + ], + 'WatchTaskIdList' => [ + 'title' => '', + 'description' => 'Monitoring object task IDs, returned in non-test run scenarios', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Monitoring object task IDs, returned in non-test run scenarios', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\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' => 'Batch Submit Rule Tasks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetTableLineages' => [ - 'summary' => '查询资产表血缘信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitQualityWatchTasks' => [ + 'summary' => 'Submits quality watchtask check tasks in batches.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'title' => '表Guid, 每个资产的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1121', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FilterQuery', + 'name' => 'SubmitCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '过滤条件', - 'description' => '', + 'title' => '', + 'description' => 'The submit command.', 'type' => 'object', 'properties' => [ - 'NodeEnv' => [ - 'title' => '用于过滤要查询的任务所属环境: dev、prod', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dev', - ], - 'NodeIdList' => [ - 'title' => '用于过滤要查询的任务Id列表', - 'description' => '', + 'WatchIdList' => [ + 'title' => '', + 'description' => 'The monitored object IDs.', 'type' => 'array', - 'items' => [ - 'title' => '用于过滤要查询的任务Id列表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '110021', - ], - 'required' => false, - ], - 'NeedUpstream' => [ - 'title' => '是否查询上游血缘, 默认：false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'NeedDownstream' => [ - 'title' => '是否查询下游血缘, 默认：false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'NeedNotExistObject' => [ - 'title' => '返回在资产清单中不存在的表, 默认：false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'items' => ['title' => '', 'description' => 'The monitored object IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'required' => true, + 'example' => '', ], + 'PartitionExpression' => ['title' => '', 'description' => 'The partition expression. This is a custom expression.', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}'], + 'BizDate' => ['title' => '', 'description' => 'The business date, in the yyyy-MM-dd format.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '110021', - ], - 'NodeEnv' => [ - 'title' => '任务所属环境: dev、prod', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'InputTableEnv' => [ - 'title' => '输入表所属环境: dev、prod', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'InputTableGuid' => [ - 'title' => '输入表Guid, 每个资产都有唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '123211', - ], - 'InputTableName' => [ - 'title' => '输入表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_input', - ], - 'InputProjectId' => [ - 'title' => '输入表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1233', - ], - 'InputBizUnitId' => [ - 'title' => '输入表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InputDataSourceId' => [ - 'title' => '输入表所属数据源Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'OutputTableGuid' => [ - 'title' => '输出表Guid, 每个资产都有唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '2231', - ], - 'OutputTableName' => [ - 'title' => '输出表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_output', - ], - 'OutputProjectId' => [ - 'title' => '输出表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1233', - ], - 'OutputBizUnitId' => [ - 'title' => '输出表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutputDataSourceId' => [ - 'title' => '输出表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutputDataSourceType' => [ - 'title' => '输出表所属数据源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputTableDeleted' => [ - 'title' => '输出表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'SubmitResult' => [ + 'title' => '', + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'WatchTaskIdList' => [ + 'title' => '', + 'description' => 'The list of quality watchtask IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The quality watchtask ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"SubmitResult\\": {\\n \\"WatchTaskIdList\\": [\\n 1\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Submit quality watchtask check tasks in batches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetBelongAssetMapping' => [ - 'summary' => '根据归属资产GUID查询映射关系。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'SyncDepartment' => [ + 'summary' => 'Synchronizes department information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AssetMappingQuery', + 'name' => 'SyncDepartmentCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询指令', - 'description' => '', + 'title' => '', + 'description' => 'The request command.', 'type' => 'object', 'properties' => [ - 'BelongGuid' => [ - 'title' => '归属资产Guid', - 'description' => '', - 'type' => 'string', + 'DepartmentList' => [ + 'description' => 'The department list (full organization tree).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepartmentId' => ['title' => '', 'description' => 'The department ID (unique identifier of the department).', 'type' => 'string', 'required' => true, 'example' => '10001'], + 'DepartmentName' => ['title' => '', 'description' => 'The display name of the department.', 'type' => 'string', 'required' => true, 'example' => '研发中心'], + 'ParentDepartmentId' => ['title' => '', 'description' => 'The parent department ID (unique identifier of the parent department). Set to null if no parent department exists.', 'type' => 'string', 'example' => '10001', 'required' => false], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1121', - ], - 'RelationType' => [ - 'title' => '映射关系类型: VALID 已映射、INVALID 无效映射', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VALID', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'MappingRelationList' => [ - 'title' => '映射关系列表', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'The synchronization result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Synchronize department information', + 'description' => 'Queries the details of a published API operation by AppKey.', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'SyncDepartmentUser' => [ + 'summary' => 'Synchronizes department member information.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'SyncDepartmentUserCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The request command.', + 'type' => 'object', + 'properties' => [ + 'DeptUserMapping' => [ + 'description' => 'The mapping between users and their affiliated departments.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', 'type' => 'object', 'properties' => [ - 'ModifyTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 00:00:00', - ], - 'Guid' => [ - 'title' => '资产guid', - 'description' => '', - 'type' => 'string', - 'example' => '1122', - ], - 'Name' => [ - 'title' => '资产名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'AssetType' => [ - 'title' => '资产类型: COLUMN 字段、INDEX 指标', - 'description' => '', - 'type' => 'string', - 'example' => 'COLUMN', - ], - 'StandardId' => [ - 'title' => '标准id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StandardName' => [ - 'title' => '标准名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'StandardCode' => [ - 'title' => '标准编码', - 'description' => '', - 'type' => 'string', - 'example' => 'cc', - ], - 'StandardSetId' => [ - 'title' => '标准集id', - 'description' => '', - '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', + 'SourceUserId' => ['title' => '', 'description' => 'The user ID in the user system. This value is the unique identifier of the user.', 'type' => 'string', 'required' => true, 'example' => '30000001'], + 'DepartmentIdList' => [ + 'title' => '', + 'description' => 'The list of department IDs to which the user belongs. If this parameter is left empty, the user-department affiliation is deleted.', + 'type' => 'array', + 'items' => ['description' => 'The department ID to which the user belongs.', 'type' => 'string', 'required' => true, 'example' => 'DEPT_1', 'title' => ''], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned for the request.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'The response data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Sync department member information', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetAssetMappingRelations' => [ - 'summary' => '根据资产对象GUID查询映射关系。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'TransferOwnershipForAllObject' => [ + 'summary' => 'Transfers ownership to a new owner in one click.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AssetMappingQuery', + 'name' => 'PrivilegeTransferRecord', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询指令', - 'description' => '', + 'description' => 'The transfer information.', 'type' => 'object', 'properties' => [ - 'Guid' => [ - 'title' => '资产对象guid', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1121', - ], - 'AssetType' => [ - 'title' => '资产对象类型: COLUMN 字段、INDEX 指标', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'INDEX', - ], - 'RelationType' => [ - 'title' => '映射关系类型: VALID 已映射、INVALID 无效映射', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'VALID', - ], + 'OldOwner' => ['title' => '', 'description' => 'The user ID of the original owner.', 'type' => 'string', 'required' => true, 'example' => '30000001'], + 'NewOwner' => ['title' => '', 'description' => 'The user ID of the new owner.', 'type' => 'string', 'required' => true, 'example' => '30000002'], + 'TransferComment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '1122', - ], - 'Name' => [ - 'title' => '资产名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'AssetType' => [ - 'title' => '资产类型: COLUMN 字段、INDEX 指标', - 'description' => '', - 'type' => 'string', - 'example' => 'COLUMN', - ], - 'StandardId' => [ - 'title' => '标准id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StandardName' => [ - 'title' => '标准名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'StandardCode' => [ - 'title' => '标准编码', - 'description' => '', - 'type' => 'string', - 'example' => 'cc', - ], - 'StandardSetId' => [ - 'title' => '标准集id', - 'description' => '', - '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', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The transfer record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Transfer ownership in one click', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListTables' => [ - 'summary' => '分页查询查询资产表元数据。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'UpdateAdHocFile' => [ + 'summary' => 'Modifies an ad hoc query file.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The update request.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1212313'], + 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2311113'], + 'Content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'required' => true, 'example' => 'select 1;'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '10011', - ], - 'DataSourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3301', - ], - 'TableSizeInBytes' => [ - 'title' => '表存储总量, 单位：byte', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '30011211', - ], - 'Creator' => [ - 'title' => '创建人id', - 'description' => '', - 'type' => 'string', - 'example' => '30011211', - ], - 'VisitCount30d' => [ - 'title' => '最近30天的访问次数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'Env' => [ - 'title' => '所属环境：dev、prod', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2011', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'LD_test01', - ], - 'DataDomainId' => [ - 'title' => '数据域id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '211', - ], - 'DataDomainName' => [ - 'title' => '主题域名称', - 'description' => '', - 'type' => 'string', - 'example' => '211', - ], - 'ProjectId' => [ - 'title' => '逻辑项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1011', - ], - 'ProjectName' => [ - 'title' => '逻辑项目名', - 'description' => '', - 'type' => 'string', - 'example' => 'testPrj', - ], - 'ParentModelId' => [ - 'title' => '父模型ID, 跳转ODM模型使用', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'FileId' => [ - 'title' => '文件ID, 跳转ODM模型使用', - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'IsPartitionTable' => [ - 'title' => '是否分区键', - 'description' => '', - 'type' => 'boolean', - ], - 'StorageType' => [ - 'title' => '存储类型：HIVE、MAX_COMPUTE', - 'description' => '', - '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' => '', - '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' => '高级', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Modify an ad hoc query file', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetTableColumnLineages' => [ - 'summary' => '查询资产表字段血缘信息。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'UpdateBatchTask' => [ + 'summary' => 'Updates an offline compute node.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '表Guid，在资产唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1121', - ], - ], - [ - 'name' => 'FilterQuery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '过滤条件', - 'description' => '', + 'title' => '', + 'description' => 'The update request.', 'type' => 'object', 'properties' => [ - 'NodeEnv' => [ - 'title' => '用于过滤要查询的任务所属环境: dev、prod', - 'description' => '', - 'type' => 'string', + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10121101'], + 'Name' => ['title' => '', 'description' => 'The name of the offline node.', 'type' => 'string', 'required' => true, 'example' => 'test111'], + 'FileId' => ['title' => '', 'description' => 'The ID of the node in the folder tree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + 'NodeOutputNameList' => [ + 'title' => '', + 'description' => 'The list of node output names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The node output name.', 'type' => 'string', 'required' => true, 'example' => 'test1011'], 'required' => false, - 'example' => 'dev', + 'example' => '', ], - 'NodeIdList' => [ - 'title' => '用于过滤要查询的任务Id列表', - 'description' => '', + 'NodeDescription' => ['title' => '', 'description' => 'The description of the node.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Engine' => ['title' => '', 'description' => 'The execution engine for the node, such as a Python node. Valid values:'."\n" + .'- PYTHON2_7'."\n" + .'- PYTHON3_7'."\n" + .'- PYTHON3_11.', 'type' => 'string', 'required' => false, 'example' => 'PYTHON3_7'], + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY.', 'type' => 'string', 'required' => false, 'example' => 'DAILY'], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for automatic scheduling. Refer to the Linux cron expression syntax.', 'type' => 'string', 'required' => false, 'example' => '0 0 1 * * ?'], + 'CustomScheduleConfig' => [ + 'title' => '', + 'description' => 'The custom scheduling interval configuration.', + 'type' => 'object', + 'properties' => [ + 'SchedulePeriod' => ['title' => '', 'description' => 'The scheduling period. Valid values:'."\n" + .'- YEARLY'."\n" + .'- MONTHLY'."\n" + .'- WEEKLY'."\n" + .'- DAILY'."\n" + .'- HOURLY'."\n" + .'- MINUTELY.', 'type' => 'string', 'required' => true, 'example' => 'DAILY'], + 'Interval' => ['title' => '', 'description' => 'The custom interval.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'IntervalUnit' => ['title' => '', 'description' => 'The interval unit. Valid values:'."\n" + .'- MINUTE: minute'."\n" + .'- HOUR: hour.', 'type' => 'string', 'required' => true, 'example' => 'HOUR'], + 'StartTime' => ['title' => '', 'description' => 'The start time in the format of HH:mm.', 'type' => 'string', 'required' => true, 'example' => '08:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time in the format of HH:mm.', 'type' => 'string', 'required' => true, 'example' => '20:59'], + ], + 'required' => false, + 'example' => '', + ], + 'Code' => ['title' => '', 'description' => 'The node code.', 'type' => 'string', 'required' => true, 'example' => 'show tables;'], + 'ParamList' => [ + 'title' => '', + 'description' => 'The list of custom parameters.', 'type' => 'array', 'items' => [ - 'title' => '用于过滤要查询的任务Id列表', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '110021', + 'title' => '', + 'description' => 'The runtime parameter.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => true, 'example' => 'key'], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => true, 'example' => 'value'], + ], + 'required' => true, + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'NeedUpstream' => [ - 'title' => '是否查询上游血缘, 默认：true', - 'description' => '', - 'type' => 'boolean', + 'Priority' => ['title' => '', 'description' => 'The scheduling priority of the node. Valid values: 1 to 9. A larger value indicates a lower priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'NodeStatus' => ['title' => '', 'description' => 'The node status. Valid values:'."\n" + .'- 1: Normal.'."\n" + .'- 2: Paused.'."\n" + .'- 3: Dry run.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'TaskType' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + .'- 1: Hive_SQL.'."\n" + .'- 5: MaxCompute_SQL.'."\n" + .'- 10: Shell.'."\n" + .'- 21: Python.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '21'], + 'UpStreamList' => [ + 'title' => '', + 'description' => 'The upstream dependencies.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The node association.', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['title' => '', 'description' => 'The type of the upstream dependency node. Valid values:'."\n" + .'- PHYSICAL: physical node.'."\n" + .'- LOGICAL: logical table dependency.', 'type' => 'string', 'required' => false, 'example' => 'PHYSICAL'], + 'SourceNodeId' => ['title' => '', 'description' => 'The ID of the upstream node.', 'type' => 'string', 'required' => false, 'example' => 'n_2001'], + 'SourceNodeOutputName' => ['title' => '', 'description' => 'The output name of the upstream node.', 'type' => 'string', 'required' => true, 'example' => 't_input1'], + 'SourceTableName' => ['title' => '', 'description' => 'The name of the input table.', 'type' => 'string', 'required' => false, 'example' => 't_input1'], + 'PeriodDiff' => ['title' => '', 'description' => 'The period offset. A value of 0 indicates a same-period dependency. A positive integer indicates a dependency on the previous N periods.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'FieldList' => [ + 'title' => '', + 'description' => 'The fields of the dependent logical table.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The fields of the dependent logical table.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'required' => false, + 'example' => '', + ], + 'DependPeriod' => [ + 'title' => '', + 'description' => 'The dependency period.', + 'type' => 'object', + 'properties' => [ + 'PeriodType' => ['title' => '', 'description' => 'The dependency period type. Valid values:'."\n" + .'- CURRENT_PERIOD: current period.'."\n" + .'- LAST_PERIOD: previous period.'."\n" + .'- LAST_N_PERIOD: last N days.'."\n" + .'- LAST_24_HOUR: last 24 hours.', 'type' => 'string', 'required' => true, 'example' => 'CURRENT_PERIOD'], + 'PeriodOffset' => ['title' => '', 'description' => 'The period offset. This parameter is required when dependencyPeriodType is set to LAST_N_PERIOD.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + 'DependStrategy' => ['title' => '', 'description' => 'The dependency strategy. Valid values:'."\n" + .'- ALL: all.'."\n" + .'- FIRST: first.'."\n" + .'- LAST: last.'."\n" + .'- NEAR: nearest.', 'type' => 'string', 'required' => false, 'example' => 'LAST'], + 'SourceNodeEnabled' => ['title' => '', 'description' => 'Specifies whether the upstream node is enabled.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], 'required' => false, + 'example' => '', ], - 'NeedDownstream' => [ - 'title' => '是否查询下游血缘, 默认：true', - 'description' => '', - 'type' => 'boolean', + 'DataSourceId' => ['title' => '', 'description' => 'The data source ID for database SQL nodes.', 'type' => 'string', 'required' => false, 'example' => '12131111'], + 'DataSourceCatalog' => ['title' => '', 'description' => 'The catalog for database SQL nodes. This parameter takes effect only for data source types that require a catalog, such as Presto.', 'type' => 'string', 'required' => false, 'example' => 'mysql_catalog'], + 'DataSourceSchema' => ['title' => '', 'description' => 'The schema for database SQL nodes. This parameter takes effect only for data source types that require a schema, such as Oracle.', 'type' => 'string', 'required' => false, 'example' => 'erp'], + 'PythonModuleList' => [ + 'title' => '', + 'description' => 'The third-party Python packages that the node depends on.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The third-party Python package.', 'type' => 'string', 'required' => true, 'example' => 'numpy'], 'required' => false, + 'example' => '', ], - 'NeedNotExistObject' => [ - 'title' => '返回在资产清单中不存在的表, 默认：false', - 'description' => '', - 'type' => 'boolean', + 'SparkClientInfo' => [ + 'title' => '', + 'description' => 'The Spark client information.', + 'type' => 'object', + 'properties' => [ + 'SparkClientVersion' => ['title' => '', 'description' => 'The version name of the Spark client.', 'type' => 'string', 'required' => true, 'example' => 'abc'], + ], 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '110021', - ], - 'NodeEnv' => [ - 'title' => '任务所属环境: dev、prod', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'InputTableEnv' => [ - 'title' => '输入表所属环境: dev、prod', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'InputTableGuid' => [ - 'title' => '输入表Guid, 每个资产都有唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '123211', - ], - 'InputTableName' => [ - 'title' => '输入表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_input', - ], - 'InputColumnName' => [ - 'title' => '输入字段名称', - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - 'InputColumnGuid' => [ - 'title' => '输入字段Guid, 格式: 表Guid.字段名', - 'description' => '', - 'type' => 'string', - 'example' => '1121.col1', - ], - 'InputProjectId' => [ - 'title' => '输入表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1233', - ], - 'InputBizUnitId' => [ - 'title' => '输入表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InputDataSourceId' => [ - 'title' => '输入表所属数据源Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'OutputTableGuid' => [ - 'title' => '输出表Guid, 每个资产都有唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '2231', - ], - 'OutputTableName' => [ - 'title' => '输出表名', - 'description' => '', - 'type' => 'string', - 'example' => 't_output', - ], - 'OutputColumnName' => [ - 'title' => '输出字段名称', - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - 'OutputColumnGuid' => [ - 'title' => '输出字段Guid, 格式为: 表Id.字段名', - 'description' => '', - 'type' => 'string', - 'example' => '2231.col2', - ], - 'OutputProjectId' => [ - 'title' => '输出表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1233', - ], - 'OutputBizUnitId' => [ - 'title' => '输出表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutputDataSourceId' => [ - 'title' => '输出表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutputDataSourceType' => [ - 'title' => '输出表所属数据源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputTableDeleted' => [ - 'title' => '输出表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'UpdateResult' => [ + 'title' => '', + 'description' => 'The update result.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['title' => '', 'description' => 'The ID of the node in the folder tree.', 'type' => 'integer', 'format' => 'int64', 'example' => '12113111'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"UpdateResult\\": {\\n \\"FileId\\": 12113111\\n }\\n}","type":"json"}]', + 'title' => 'Update an offline compute node', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetTableColumns' => [ - 'summary' => '查询资产清单中Dataphin表的字段。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'UpdateBatchTaskUdfLineages' => [ + 'summary' => 'Edits the custom data lineage of a batch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Catalog', - 'in' => 'query', - 'schema' => [ - 'title' => '资产表catalog: 业务板块或项目空间的名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'LD_test01_dev', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't_test01', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The update instruction.', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - 'ColumnList' => [ - 'title' => '资产表列列表', - 'description' => '', + 'ProjectId' => ['title' => '', 'description' => 'The project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '131211211'], + 'FileId' => ['title' => '', 'description' => 'The node ID in the logical definition subtree.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12113111'], + 'LineageGroupList' => [ + 'title' => '', + 'description' => 'The list of lineage groups.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => '', + 'description' => 'The lineage group.', 'type' => 'object', 'properties' => [ - 'Guid' => [ - 'title' => '列Guid', - 'description' => '', - 'type' => 'string', - 'example' => '1121.col1', - ], - 'Env' => [ - 'title' => '所属环境：dev、prod', - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'TableGuid' => [ - 'title' => '表Guid', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'DataSourceId' => [ - 'title' => '数据源ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'ClassifyName' => [ - 'title' => '数据分类名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'InputLineageList' => [ + 'title' => '', + 'description' => 'The collection of lineage input tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The lineage table.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 't_input'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values: prod, dev, and auto.', 'type' => 'string', 'required' => true, 'example' => 'dev'], + 'FullTable' => ['title' => '', 'description' => 'Specifies whether to select the full table.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ColumnList' => [ + 'title' => '', + 'description' => 'The list of lineage fields.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The collection of lineage-related fields. This parameter is mutually exclusive with FullTable. The full table is selected by default.', 'type' => 'string', 'required' => true, 'example' => 'column1'], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'required' => true, + 'example' => '', ], - 'LevelAbbreviation' => [ - 'title' => '数据分级缩写', - 'description' => '', - 'type' => 'string', - 'example' => 'L1', + 'OutputLineageList' => [ + 'title' => '', + 'description' => 'The collection of lineage output tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The lineage table.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 't_output'], + 'Env' => ['title' => '', 'description' => 'The environment. Valid values: prod, dev, and auto.', 'type' => 'string', 'required' => true, 'example' => 'dev'], + 'FullTable' => ['title' => '', 'description' => 'Specifies whether to select the full table.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ColumnList' => [ + 'title' => '', + 'description' => 'The list of lineage fields.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The collection of lineage-related fields. This parameter is mutually exclusive with FullTable. The full table is selected by default.', 'type' => 'string', 'required' => true, 'example' => 'column1'], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'required' => true, + 'example' => '', ], ], + 'required' => true, + 'example' => '', ], + 'required' => true, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Update custom data lineage of a batch task', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:23:42.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'CreateBizMetric' => [ - 'summary' => '新建业务指标', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBatchTaskUdfLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + ], + 'UpdateBizEntity' => [ + 'summary' => 'Updates a business entity.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51685,345 +36582,346 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateBizMetricCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '创建请求', - 'description' => '', + 'title' => '', + 'description' => 'The update request.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '业务指标名称，需要在租户内唯一。仅支持输入英文字母、数字及部分特殊符号(-_/\\·#$^&*()%+=)，最多256字符。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Metric1', - 'maxLength' => 256, - ], - 'DisplayName' => [ - 'title' => '展示名称', - 'description' => '', - 'type' => 'string', + 'Id' => ['title' => '', 'description' => 'The ID of the business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '101001201'], + 'Type' => ['title' => '', 'description' => 'The type of the business entity. For more information, refer to the create business entity operation.', 'type' => 'string', 'required' => true, 'example' => 'BIZ_OBJECT'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20101011'], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the business unit to which the business process belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6798087749072704'], + 'BizObject' => [ + 'title' => '', + 'description' => 'The business object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The code name of the business object. The name can be up to 64 characters in length and can contain only letters, digits, and underscores. For the ADB_PG engine, the code name can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'create_object_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business object. The name can be up to 64 characters in length and can contain only Chinese characters, letters, digits, underscores, and hyphens.', 'type' => 'string', 'required' => true, 'example' => 'create_object_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business object. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the business object owner.', 'type' => 'string', 'required' => true, 'example' => '30010010'], + 'ParentId' => ['title' => '', 'description' => 'The inherited entity of the business object. Only common business objects support inherited entity configuration, and only online business objects can be inherited.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '116306'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs. If this parameter is not specified, the existing values are cleared.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the associated online business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106'], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'MetricDisplayName', - 'maxLength' => 256, + 'example' => '', ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', + 'BizProcess' => [ + 'title' => '', + 'description' => 'The business process.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The code name of the business process. The name can be up to 64 characters in length and can contain only letters, digits, and underscores. For the ADB_PG engine, the code name can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'create_process_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the business process. The name can be up to 64 characters in length and can contain only Chinese characters, letters, digits, underscores, and hyphens.', 'type' => 'string', 'required' => true, 'example' => 'create_process_name'], + 'Description' => ['title' => '', 'description' => 'The description of the business process. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'OwnerUserId' => ['title' => '', 'description' => 'The user ID of the business process owner.', 'type' => 'string', 'required' => true, 'example' => '30010010'], + 'RefBizEntityIdList' => [ + 'title' => '', + 'description' => 'The list of associated online business entity IDs. If this parameter is not specified, the existing values are cleared.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of the associated online business entity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '116106'], + 'required' => false, + 'example' => '', + ], + 'BizEventEntityIdList' => [ + 'title' => '', + 'description' => 'The list of business event activity IDs contained in the business flow activity. This parameter is valid only when the current entity is a business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The business event activity contained in the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106'], + 'required' => false, + 'example' => '', + ], + 'PreBizProcessIdList' => [ + 'title' => '', + 'description' => 'The preceding business flow activities of the business flow activity.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The preceding business flow activities of the business flow activity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1016106'], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'MetricDesc', - 'maxLength' => 1000, + 'example' => '', ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'successful'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Update a business entity', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateBizMetric' => [ + 'summary' => 'Update a business metric.'."\n" + .'Release version: 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' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateBizMetricCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Update request', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Enter the name of the business metric to update', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'example' => 'Metric1'], + 'NewName' => ['title' => '', 'description' => 'The new name. Enter this when you need to modify the metric name', 'type' => 'string', 'maxLength' => 256, 'required' => false, 'example' => 'Metric1_new'], + 'DisplayName' => ['title' => '', 'description' => 'Display name', 'type' => 'string', 'maxLength' => 256, 'required' => false, 'example' => 'Metric1_DisplayName'], + 'Description' => ['title' => '', 'description' => 'Description', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'Metric Desc'], 'Labels' => [ - 'title' => '资产标签', - 'description' => '', + 'title' => '', + 'description' => 'Asset labels', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Label1', - ], + 'items' => ['title' => '', 'description' => 'Label value', 'type' => 'string', 'required' => false, 'example' => 'Label'], 'required' => false, + 'example' => '', ], 'CatalogIds' => [ - 'title' => '归属目录ID', - 'description' => '', + 'title' => '', + 'description' => 'List of catalog IDs', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234567890', - ], - 'required' => false, - ], - 'BizOwnerName' => [ - 'title' => '业务负责人名称，请填写负责人账号的用户名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SuperAdmin', - ], - 'MetricDefinition' => [ - 'title' => '指标口径，如需引用其他业务指标，请使用半角中括号[ ]包裹指标名称', - 'description' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'Catalog ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789'], 'required' => false, - 'example' => '[Metric1]+[Metric2]', - 'maxLength' => 2000, + 'example' => '', ], + 'BizOwnerName' => ['title' => '', 'description' => 'Business owner. Enter the username of the owner account', 'type' => 'string', 'example' => 'SuperAdmin', 'required' => false], + 'MetricDefinition' => ['title' => '', 'description' => 'Metric definition. To reference other business metrics, enclose the metric name in square brackets [ ]', 'type' => 'string', 'required' => false, 'maxLength' => 2000, 'example' => '[Metric2]+[Metric3]'], 'RelatedBizMetrics' => [ - 'title' => '相关业务指标列表，请填写相关业务指标名称及其关联关系', - 'description' => '', + 'title' => '', + 'description' => 'List of related business metrics', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'Related business metric', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '指标名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Metric2', - ], + 'Name' => ['title' => '', 'description' => 'Business metric name', 'type' => 'string', 'required' => false, 'example' => 'Metric2'], 'RelationType' => [ - 'title' => '关联关系：POSITIVE正相关；NEGATIVE负相关；OTHER其他', - 'description' => '', + 'title' => '', + 'description' => 'Correlation type. Valid values: POSITIVE (positive correlation), NEGATIVE (negative correlation), and OTHER (other)', 'type' => 'string', 'required' => false, 'example' => 'POSITIVE', - 'enum' => [ - 'POSITIVE', - 'NEGATIVE', - 'OTHER', - ], + 'enum' => ['POSITIVE', 'NEGATIVE', 'OTHER'], ], ], 'required' => false, + 'example' => '', ], 'required' => false, + 'example' => '', ], 'AssociatedTechMetricFullNames' => [ - 'title' => '关联技术指标全名列表。请填写技术指标的“所属表全名.指标名称”，其中“所属表全名”等于“资产来源.所属表名”。一个技术指标只能被一个业务指标关联，无法重复关联', - 'description' => '', + 'title' => '', + 'description' => 'List of associated technical metrics. Enter the full name of the technical metric in the format of "TableFullName.MetricName", where "TableFullName" equals "AssetSource.TableName". A technical metric can only be associated with one business metric and cannot be associated repeatedly', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LD_bizunit.table1.index1', - ], + 'items' => ['title' => '', 'description' => 'Full name of the technical metric', 'type' => 'string', 'required' => false, 'example' => 'LD_BizUnit.test_table.tech_index'], 'required' => false, + 'example' => '', ], - 'MetricRelationDiagramSwitchOpen' => [ - 'title' => '指标关系图开关：true开启；false关闭。当且仅当至少有一个“相关业务指标”时可开启，否则会自动关闭', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'MetricRelationDiagramExpression' => [ - 'title' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[Metric1]+[Metric2]', - ], - 'OperateInstructionEnabled' => [ - 'title' => '操作说明是否开启：true开启；false关闭', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'OperateInstructionContent' => [ - 'title' => '操作说明内容，仅支持文本格式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'content', - ], + 'MetricRelationDiagramSwitchOpen' => ['title' => '', 'description' => 'Metric relationship diagram switch. Valid values: true (enabled) and false (disabled). This can be enabled only when at least one related business metric exists. Otherwise, it is automatically disabled', 'type' => 'boolean', 'default' => 'False', 'required' => false, 'example' => 'true'], + 'MetricRelationDiagramExpression' => ['title' => '', 'description' => 'This parameter is read only when the metric relationship diagram is enabled. Only a calculation expression composed of metric names selected from related business metrics is supported. Supported operators include +, -, *, /, (), %, and ∑. Each metric name must be enclosed in square brackets [ ]. If no operator is specified between two metrics, the system automatically fills in a placeholder. If no metric relationship expression is configured, the metric relationship diagram switch is automatically disabled', 'type' => 'string', 'required' => false, 'example' => '[Metric1]+[Metric2]'], + 'OperateInstructionEnabled' => ['title' => '', 'description' => 'Specifies whether the usage instructions are enabled. Valid values: true (enabled) and false (disabled)', 'type' => 'boolean', 'default' => 'False', 'required' => false, 'example' => 'true'], + 'OperateInstructionContent' => ['title' => '', 'description' => 'Content of the usage instructions. Only text format is supported', 'type' => 'string', 'required' => false, 'example' => 'content test'], 'ViewScope' => [ - 'title' => '可见范围', - 'description' => '', + 'title' => '', + 'description' => 'Visibility scope', 'type' => 'object', 'properties' => [ 'ScopeType' => [ - 'title' => '可见范围类型：ALL_USERS_CAN_VIEW全部用户可见；PART_USERS_CAN_VIEW部分用户可见；PART_USERS_CAN_NOT_VIEW部分用户不可见', - 'description' => '', + 'title' => '', + 'description' => 'Visibility scope type. Valid values: ALL_USERS_CAN_VIEW (visible to all users), PART_USERS_CAN_VIEW (visible to specified users), and PART_USERS_CAN_NOT_VIEW (invisible to specified users)', 'type' => 'string', 'required' => false, - 'example' => 'PART_USERS_CAN_VIEW', - 'enum' => [ - 'ALL_USERS_CAN_VIEW', - 'PART_USERS_CAN_VIEW', - 'PART_USERS_CAN_NOT_VIEW', - ], + 'example' => 'ALL_USERS_CAN_VIEW', + 'enum' => ['ALL_USERS_CAN_VIEW', 'PART_USERS_CAN_VIEW', 'PART_USERS_CAN_NOT_VIEW'], ], 'UserNames' => [ - 'title' => '请填写个人账号的用户名，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时有效', - 'description' => '', + 'title' => '', + 'description' => 'Enter the usernames of individual accounts. This parameter takes effect only when the visibility scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SuperAdmin', - ], + 'items' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'SuperAdmin', 'required' => false], 'required' => false, + 'maxItems' => 500, + 'example' => '', ], 'UserGroupNames' => [ - 'title' => '请填写用户组名称，当且仅当资产“可见范围”为“部分用户可见”或“部分用户不可见”时会读取此信息', - 'description' => '', + 'title' => '', + 'description' => 'Enter user group names. This parameter is read only when the visibility scope is set to PART_USERS_CAN_VIEW or PART_USERS_CAN_NOT_VIEW', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'UserGroup1', - ], + 'items' => ['title' => '', 'description' => 'User group name', 'type' => 'string', 'example' => '运营用户组', 'required' => false], 'required' => false, + 'maxItems' => 500, + 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'CustomAttribute' => [ - 'title' => '自定义属性', - 'description' => '', + 'title' => '', + 'description' => 'List of custom attributes. Enter the attribute code and attribute values for each', 'type' => 'array', 'items' => [ - 'title' => '自定义属性列表，请分别填写属性的编码及属性值', - 'description' => '', + 'title' => '', + 'description' => 'Custom attribute', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '自定义属性编码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CustomAttributeCode', - ], + 'Code' => ['title' => '', 'description' => 'Custom attribute code', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeCode'], 'Values' => [ - 'title' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', - 'description' => '', + 'title' => '', + 'description' => 'List of attribute values. 1. For custom input and single-select dropdown attributes, only the first value in the list is read. 2. For multi-select dropdown attributes, all values in the list are read. 3. For hyperlink attributes, the first value is used as the display text and the second value is used as the link URL.', 'type' => 'array', - 'items' => [ - 'title' => '自定义属性值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CustomAttributeValue', - ], + 'items' => ['title' => '', 'description' => 'Custom attribute value', 'type' => 'string', 'required' => false, 'example' => 'CustomAttributeValue'], 'required' => false, + 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Error code. A value of OK indicates the request was successful', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], 'Data' => [ - 'title' => '操作结果', - 'description' => '', + 'title' => '', + 'description' => 'Operation result', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否创建成功：true成功；false失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '异常信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Success' => ['title' => '', 'description' => 'Indicates whether the update was successful. Valid values: true (success) and false (failure)', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Exception message', 'type' => 'string', 'example' => 'npe'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Edit Business Metric', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'UpdateBizMetric' => [ - 'summary' => '更新业务指标', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateBizUnit' => [ + 'summary' => 'Updates a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52031,773 +36929,195 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'UpdateBizMetricCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '更新请求', - 'description' => '', + 'title' => '', + 'description' => 'The update request.', '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '归属目录ID', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'False', - ], - 'MetricRelationDiagramExpression' => [ - 'title' => '仅当“指标关系图”开启时会读取此信息。仅支持填写从“相关业务指标”中选取的指标名称组成的一个计算表达式，运算符号仅支持+、-、*、/、（）、%、∑，各指标名称需用半角中括号[ ]包裹。如果两个指标之间未填写运算符，系统将自动填充占位符。如果未配置指标关系表达式，则“指标关系图”开关将自动关闭', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[Metric1]+[Metric2]', - ], - 'OperateInstructionEnabled' => [ - 'title' => '使用说明是否开启：true开启；false关闭', - 'description' => '', - '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' => '', - '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' => '', + 'BizUnitId' => ['title' => '', 'description' => 'The data domain ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456'], + 'Name' => ['title' => '', 'description' => 'The data domain code.', 'type' => 'string', 'required' => true, 'example' => 'bz_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the data domain.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Icon' => ['title' => '', 'description' => 'The preset icon. For more information, refer to the create data domain operation.', 'type' => 'string', 'required' => true, 'example' => 'icon-environment'], + 'BizUnitAccountList' => [ + 'title' => '', + 'description' => 'The domain architects.', 'type' => 'array', 'items' => [ - 'title' => '自定义属性', - 'description' => '', + 'title' => '', + 'description' => 'The domain architects.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '自定义属性编码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CustomAttributeCode', - ], - 'Values' => [ - 'title' => '属性值列表：1、自定义输入和下拉单选属性仅读取列表第一个属性值；2、下拉多选属性，读取列表全部属性值；3、超链接属性，读取列表第一个属性值作为展示文本，第二个属性值作为跳转链接。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '自定义属性值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CustomAttributeValue', - ], - 'required' => false, - ], + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '20001201'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否更新成功：true成功；false失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '异常信息', - 'description' => '', - 'type' => 'string', - 'example' => 'npe', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Update a data domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetBizMetricByName' => [ - 'summary' => '查询业务指标详情', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateComputeSource' => [ + 'summary' => 'Edits a compute source. Business unit administrators and project administrators have permissions to perform this operation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'BizMetricByNameQuery', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询请求', - 'description' => '', + 'title' => '', + 'description' => 'The edit command.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '业务指标名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Metric1', - ], - 'Draft' => [ - 'title' => '查询草稿态或已发布资产详情：True草稿态；False已发布', - 'description' => '', - 'type' => 'boolean', + 'Id' => ['title' => '', 'description' => 'The ID of the compute source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102311'], + 'Name' => ['title' => '', 'description' => 'The name of the compute source.', 'type' => 'string', 'required' => true, 'example' => 'test1021'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The type of the compute source.', 'type' => 'string', 'required' => true, 'example' => 'MacCompute'], + 'ConfigList' => [ + 'title' => '', + 'description' => 'The connection configuration items.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + 'Key' => ['title' => '', 'description' => 'The key of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'True', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001011', - ], - 'Guid' => [ - 'title' => '业务指标GUID', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43297700', - ], - 'TopicName' => [ - 'title' => '目录所属专题名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test topic', - ], - 'CatalogId' => [ - 'title' => '目录ID', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'CUSTOM_INDEX', - ], - ], - ], - ], - 'MetricRelationDiagramSwitchOpen' => [ - 'title' => '指标关系图是否开启：true开启；false关闭', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MetricRelationDiagramExpression' => [ - 'title' => '指标关系图表达式', - 'description' => '', - 'type' => 'string', - 'example' => '[Metric2]*10', - ], - 'OperateInstructionEnabled' => [ - 'title' => '使用说明是否开启：true开启；false关闭', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '自定义属性值', - 'description' => '', - 'type' => 'string', - 'example' => 'CustomAttributeValue', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Edit a compute source', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'DeleteBizMetric' => [ - 'summary' => '删除业务指标', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataDomain' => [ + 'summary' => 'Updates a data domain.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52805,141 +37125,91 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteBizMetricCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '删除请求', - 'description' => '', + 'title' => '', + 'description' => 'The update request.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '待删除的业务指标名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Metric1', - 'maxLength' => 256, - ], + 'BizUnitId' => ['title' => '', 'description' => 'The ID of the data board.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '545844456'], + 'DataDomainId' => ['title' => '', 'description' => 'The ID of the data domain.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1241844456'], + 'Name' => ['title' => '', 'description' => 'The code of the data domain.', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the data domain.', 'type' => 'string', 'required' => true, 'example' => '主题域测试'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the data domain.', 'type' => 'string', 'required' => true, 'example' => 'dm_code_name'], + 'Description' => ['title' => '', 'description' => 'The description of the data domain.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the parent data domain.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10232311'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '删除结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否删除成功：true成功；false失败', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '异常信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Update a data domain', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'DeleteRegisterLineage' => [ - 'summary' => '删除注册血缘。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDataServiceApp' => [ + 'summary' => 'Updates a data service application. Only super administrators, system administrators, and application owners can perform this operation.'."\n" + .'Release version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -52948,428 +37218,79 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DeleteRegisterLineageCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '注册血缘, 删除血缘command', - 'description' => '', + 'title' => '', + 'description' => 'The command to update the data service application.', 'type' => 'object', 'properties' => [ - 'Source' => [ - 'title' => '血缘的source', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'Target' => [ - 'title' => '血缘的target', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'DetailedLineages' => [ - 'title' => '详细血缘关系. 对于表, 这里的详细血缘关系就是字段血缘', - 'description' => '', + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12345'], + 'AppGroupId' => ['title' => '', 'description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200000000'], + 'Scenarios' => ['title' => '', 'description' => 'Application scenarios.', 'type' => 'string', 'required' => false, 'example' => '数据分析'], + 'OwnerIds' => [ + 'title' => '', + 'description' => 'List of owner IDs.', 'type' => 'array', - 'items' => [ - 'title' => '子对象血缘关系', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'IsDirect' => [ - 'title' => '是否是直接血缘, 默认为true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'Source' => [ - 'title' => 'source资产引用', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'odps.300000001.project1.table1', - ], - 'ParentGuid' => [ - 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'Target' => [ - 'title' => 'target资产引用', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'odps.300000001.project1.table1', - ], - 'ParentGuid' => [ - 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'CascadeDeleteLineage' => [ - 'title' => '是否在删除完所有detailedLineage后, 自动删除对象血缘, 默认为true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], - 'TenantId' => [ - 'title' => '租户Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300001234', - ], - 'UserId' => [ - 'title' => '当前用户Id', - 'description' => '', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'Owner ID.', 'type' => 'string', 'example' => '12345', 'required' => false], 'required' => false, - 'example' => '300004567', + 'example' => '', ], + 'AppName' => ['title' => '', 'description' => 'Application name.', 'type' => 'string', 'required' => false, 'example' => '默认应用'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'Backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Update Data Service Application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'AddRegisterLineage' => [ - 'summary' => '新增注册血缘。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataServiceAppGroup' => [ + 'summary' => 'Updates a data service application group. Only superusers and system administrators can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -53378,2993 +37299,1460 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'AddRegisterLineageCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '注册血缘, 增加血缘command', - 'description' => '', + 'title' => '', + 'description' => 'The update command for the data service application group.', 'type' => 'object', 'properties' => [ - 'Source' => [ - 'title' => 'source资产', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'Target' => [ - 'title' => 'target资产', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'odps.300000001.project1.table1.column1', - ], - 'ParentGuid' => [ - 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'Target' => [ - 'title' => 'target资产引用', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceType' => [ - 'title' => '资产引用类型: BY_GUID, BY_PROPERTY', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BY_GUID, BY_PROPERTY', - ], - 'Guid' => [ - 'title' => '资产guid, 在referenceType为BY_GUID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'odps.300000001.project1.table1.column1', - ], - 'ParentGuid' => [ - 'title' => '父资产的guid. 如果当前对象是字段, 那么parentGuid是字段所属表的Guid', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dataphin', - ], - 'Schema' => [ - 'title' => 'schema, 资产属性. 对于表而言, 一般是项目或者业务板块.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project1, bizUnit1', - ], - 'Env' => [ - 'title' => 'env, 所属环境.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV, PROD', - ], - 'Name' => [ - 'title' => 'name, 资产名称.该属性用于在referenceType为BY_PROPERTY时根据属性确定对应的资产, 如果referenceType为BY_GUID, 该属性无需填写', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - 'ExtProperties' => [ - 'title' => '扩展属性', - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'IsDirect' => [ - 'title' => '是否是直接血缘, 默认为true', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300001234', - ], - 'UserId' => [ - 'title' => '当前用户Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '300004567', - ], + 'GroupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'required' => true, 'example' => '默认应用分组', 'maxLength' => 64], + 'GroupId' => ['title' => '', 'description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12345'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the backend encounters an exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Update a data service application group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetTableLineageByTaskId' => [ - 'summary' => '查询表血缘信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataServiceAppMember' => [ + 'summary' => 'Updates the regular members of a data service application. Only the application owner can perform this operation.'."\n" + .'Online version: v6.0.0.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'TableLineageByTaskIdQuery', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询表血缘的数据结构', - 'description' => '', + 'title' => '', + 'description' => 'The command to update regular members of a data service application.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '用于过滤要查询的任务(节点)Id', - 'description' => '', - 'type' => 'string', + 'AppId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200000000'], + 'MemberList' => [ + 'title' => '', + 'description' => 'The list of members.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'EffectiveEnd' => ['title' => '', 'description' => 'The authorization expiration time.', 'type' => 'string', 'required' => true, 'example' => '2026-12-12'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'n_123', - ], - 'TaskEnv' => [ - 'title' => '用于过滤要查询的任务所属的环境 DEV/PROD', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV', - ], - 'NeedNotExistObject' => [ - 'title' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '请求成功与否', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'title' => '后端响应HttpCode', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - 'title' => '请求错误码, OK表示请求正常', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - 'title' => '请求错误信息', - ], - 'Data' => [ - 'title' => '查询结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TenantId' => [ - 'title' => '租户id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TaskId' => [ - 'title' => '血缘对应的任务(节点)Id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_123', - ], - 'TaskEnv' => [ - 'title' => '血缘对应的任务(节点)所属环境 DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'InputEnv' => [ - 'title' => '输入表所属的env, DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'InputTableId' => [ - 'title' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" - .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" - .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" - .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'InputDataSourceType' => [ - 'title' => '输入表存储格式', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'InputDbType' => [ - 'title' => '输入数据源类型', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'InputProjectId' => [ - 'title' => '输入表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputBizUnitId' => [ - 'title' => '输入表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputDataSourceId' => [ - 'title' => '输入表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputTableDeleted' => [ - 'title' => '输入表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - 'OutputTableType' => [ - 'title' => '输出表类型, 枚举值见: InputTableType', - 'description' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'OutputEnv' => [ - 'title' => '输出表所属的env, DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV/PROD', - ], - 'OutputBizUnitId' => [ - 'title' => '输出表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputDataSourceType' => [ - 'title' => '输出表存储格式', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputDbType' => [ - 'title' => '输出数据源类型', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputProjectId' => [ - 'title' => '输出表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputDataSourceId' => [ - 'title' => '输出表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputTableId' => [ - 'title' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', - 'description' => '', - 'type' => 'string', - 'example' => 'odps.123.test_project.order', - ], - 'OutputTableName' => [ - 'title' => '输出表名', - 'description' => '', - 'type' => 'string', - 'example' => 'order', - ], - 'OutputTableDeleted' => [ - 'title' => '输出表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Update regular members of a data service application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetTableColumnLineageByTaskId' => [ - 'summary' => '查询表字段血缘信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [], + 'UpdateDataSourceBasicInfo' => [ + 'summary' => 'Edits the basic information of a data source. Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators have permissions to perform this operation.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The basic information to edit for the data source.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23231'], + 'Name' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'required' => true, 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'The data source description.', 'type' => 'string', 'required' => true, 'example' => 'xx'], + ], 'required' => true, - 'example' => '30001011', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of editing the basic information of the data source.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Edit basic information of a data source', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataSourceBasicInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateDataSourceConfig' => [ + 'summary' => 'Edits the connection configuration items of a data source. Tenant administrators, data administrators, business unit administrators, project administrators, and operations administrators have permissions to perform this operation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableColumnLineageByTaskIdQuery', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询表字段血缘的数据结构', - 'description' => '', + 'title' => '', + 'description' => 'The data source configuration item change.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '用于过滤要查询的任务(节点)Id', - 'description' => '', - 'type' => 'string', + 'Id' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13231313'], + 'ConfigItemList' => [ + 'title' => '', + 'description' => 'The connection configuration items.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The connection configuration items.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key ID of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], + 'required' => true, + 'example' => '', + ], 'required' => true, - 'example' => 'n_123', - ], - 'TaskEnv' => [ - 'title' => '用于过滤要查询的任务所属的环境 DEV/PROD', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DEV', - ], - 'NeedNotExistObject' => [ - 'title' => '是否返回在资产清单中不存在的表, 不传不会返回不存在的表', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '请求成功与否', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'title' => '后端响应HttpCode', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - 'title' => '请求错误码, OK表示请求正常', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - 'title' => '请求错误信息', - ], - 'Data' => [ - 'title' => '查询结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '血缘详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TenantId' => [ - 'title' => '租户id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TaskId' => [ - 'title' => '血缘对应的任务(节点)Id', - 'description' => '', - 'type' => 'string', - 'example' => 'n_123', - ], - 'TaskEnv' => [ - 'title' => '血缘对应的任务(节点)所属环境 DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'InputEnv' => [ - 'title' => '输入表所属的env, DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'InputTableId' => [ - 'title' => '输入表guid, 每个资产都有唯一的guid, 格式为: '."\n" - .'- 逻辑表：dp_table.[租户Id].[业务板块名].[表名]'."\n" - .'- 计算源物理表：[引擎类型].[租户Id].[项目名].[表名]'."\n" - .'- 数据源表：dp_ds_table.[租户Id].[数据源Id].[schema名].[表名]', - 'description' => '', - 'type' => 'string', - 'example' => 'odps.123.test_project.order', - ], - 'InputTableName' => [ - 'title' => '输入表名', - 'description' => '', - 'type' => 'string', - 'example' => 'order', - ], - 'InputColumnId' => [ - 'title' => '输入字段guid', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'InputDataSourceType' => [ - 'title' => '输入表存储格式', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'InputDbType' => [ - 'title' => '输入数据源类型', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'InputProjectId' => [ - 'title' => '输入表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputBizUnitId' => [ - 'title' => '输入表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputDataSourceId' => [ - 'title' => '输入表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputTableDeleted' => [ - 'title' => '输入表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - 'OutputTableType' => [ - 'title' => '输出表类型, 枚举值见: InputTableType', - 'description' => '', - 'type' => 'string', - 'example' => 'PHYSICAL_TABLE', - ], - 'OutputEnv' => [ - 'title' => '输出表所属的env, DEV/PROD', - 'description' => '', - 'type' => 'string', - 'example' => 'DEV', - ], - 'OutputBizUnitId' => [ - 'title' => '输出表所属业务板块Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputDataSourceType' => [ - 'title' => '输出表存储格式', - 'description' => '', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputDbType' => [ - 'title' => '输出数据源类型', - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'OutputProjectId' => [ - 'title' => '输出表所属项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputDataSourceId' => [ - 'title' => '输出表所属数据源Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputTableId' => [ - 'title' => '输出表guid, 每个资产都有唯一的guid, 格式为参照InputTableId', - 'description' => '', - 'type' => 'string', - 'example' => 'odps.123.test_project.order', - ], - 'OutputTableName' => [ - 'title' => '输出表名', - 'description' => '', - 'type' => 'string', - 'example' => 'order', - ], - 'OutputColumnId' => [ - 'title' => '输出字段guid', - 'description' => '', - 'type' => 'string', - 'example' => 'odps.123.test_project.input_table.id', - ], - 'OutputColumnName' => [ - 'title' => '输出字段名', - 'description' => '', - 'type' => 'string', - 'example' => 'id', - ], - 'OutputTableDeleted' => [ - 'title' => '输出表是否已删除', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of editing the data source connection configuration items.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Edit data source connection configuration items', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetInstanceUpDownStream' => [ - 'summary' => '查询实例的上下游，支持逻辑表和代码任务。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataSourceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDataset' => [ + 'summary' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011', 'title' => '', 'description' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '7273382541481536'], + ], + [ + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '中心节点', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '实例id/', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't_123456', - ], - 'FieldInstanceIdList' => [ - 'title' => '当节点时逻辑表实例id时可以传，不传默认是全表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'example' => '7280832407583104', 'title' => ''], + 'Name' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'audio_dataset'], + 'Type' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'HYBRID'], + 'DataCellId' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '78201'], + 'Owner' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '300001391'], + 'Description' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '测试数据集'], + 'StorageType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'OSS'], + 'MetadataStorageType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'POSTGRESQL'], + 'ContentType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'GENERAL'], + 'Scenario' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'OFFLINE'], + 'FileId' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '7261110566632832'], + 'Version' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'V1'], + 'VersionConfig' => [ + 'type' => 'object', + 'properties' => [ + 'VersionDescription' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '测试数据集版本'], + 'FileStorageConfig' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '7445343860022804608'], + 'DataSourceName' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '测试数据源'], + 'DevPath' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'HTML正文提取/test423/'], + 'ProdPath' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'HTML正文提取/test423/'], + 'MountPath' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '/var/run/openresty/cache/corp'], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'MetadataStorageConfig' => [ + 'type' => 'object', + 'properties' => [ + 'MetadataStorageMode' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'CREATE'], + 'MetadataStorageType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'MILVUS'], + 'DataSourceId' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '7429133693081710272'], + 'DataSourceName' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '测试数据源'], + 'DevSchema' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'HTML正文提取/test423/'], + 'ProdSchema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'HTML正文提取/test423/'], + 'TableName' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 's_crm_all_plt_jala_shop'], + 'TableSchema' => [ + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'id'], + 'Type' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'int8'], + 'ElementType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'INT64'], + 'MaxCapacity' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '250'], + 'Pk' => ['type' => 'boolean', 'title' => '', 'description' => '', 'required' => false, 'example' => 'true'], + 'Comment' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'primary key'], + 'Url' => ['type' => 'boolean', 'title' => '', 'description' => '', 'required' => false, 'example' => 'false'], + 'VectorIndexConfig' => [ + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'MultiModal-Embedding'], + 'Dimension' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'description' => '', 'example' => 'instance:mongodb'."\n"], + 'IndexType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'COSINE'], + 'IndexParams' => ['type' => 'object', 'title' => '', 'description' => '', 'required' => false, 'example' => '{M:30, efConstruction:360}'], + ], + 'title' => '', + 'description' => '', + 'required' => false, + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => '', + 'required' => false, + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RealtimeMetaTableConfig' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'description' => '', 'example' => '7255013756724992'], + 'MetaTableName' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '测试元表'], + 'DatasourceType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'KAFKA'], + 'TableSchema' => [ + 'type' => 'object', + 'properties' => [ + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'happen_time'], + 'Type' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'date'], + 'ElementType' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'INT64'], + 'MaxCapacity' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '10'], + 'Pk' => ['type' => 'boolean', 'title' => '', 'description' => '', 'required' => false, 'example' => 'false'], + 'Comment' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => 'happen time'], + 'Url' => ['type' => 'boolean', 'title' => '', 'description' => '', 'required' => false, 'example' => 'false'], + 'VectorIndexConfig' => [ + 'type' => 'object', + 'properties' => [ + 'EmbeddingModel' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'multimodal-embedding-v1'], + 'Dimension' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'description' => '', 'example' => 'instance'], + 'IndexType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'AUTOINDEX'], + 'SimilarityType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'COSINE'], + 'IndexParams' => ['type' => 'object', 'title' => '', 'description' => '', 'required' => false, 'example' => '{M:30, efConstruction:360}'], + ], + 'title' => '', + 'description' => '', + 'required' => false, + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => '', + 'required' => false, + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => '', + 'required' => false, + 'example' => '', + ], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'description' => '', + 'example' => '', ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '项目ID', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140', 'title' => '', 'description' => ''], + 'Success' => ['type' => 'boolean', 'title' => '', 'description' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => '', 'description' => ''], + 'Code' => ['type' => 'string', 'example' => 'OK', 'title' => '', 'description' => ''], + 'Message' => ['type' => 'string', 'example' => 'internal error', 'title' => '', 'description' => ''], + ], + 'title' => '', 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1001121', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + .'- 该 API 用于更新特定项目下已存在的数据集的详细信息。'."\n" + .'- 必须提供 `ProjectId` 和 `UpdateCommand` 参数，其中 `UpdateCommand` 包含了需要更新的数据集的具体字段。'."\n" + .'- `UpdateCommand` 中的 `Id` 字段是必需的，用来标识要更新的数据集。'."\n" + .'- 其他字段如 `Name`, `Type`, `DataCellId` 等为可选项，根据实际需求选择性填写。'."\n" + .'- 版本配置（`VersionConfig`）和实时元表配置（`RealtimeMetaTableConfig`）提供了更详细的设置选项，包括存储路径、表结构等，这些也是可选的。'."\n" + .'- 注意确保所有提供的 ID 值（如 `ProjectId`, `Id`, `DataSourceId` 等）在系统中有效且正确关联。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + ], + 'UpdateFileDirectory' => [ + 'summary' => 'Moves the file position in the menu tree.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], + 'parameters' => [ [ - 'name' => 'UpStreamDepth', + 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '上游节点层级，默认：1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DownStreamDepth', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '下游节点层级，默认：1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323'], ], [ - 'name' => 'Env', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], + 'schema' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111'], + ], + [ + 'name' => 'Directory', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The updated file folder after the move.', 'type' => 'string', 'required' => true, 'example' => '/xx测试/目录new'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 't_1234567', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldInstanceIdList' => [ - 'title' => '字段ID列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1011', - ], - ], - ], - ], - ], - 'UpInstanceList' => [ - 'title' => '上游实例', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '上游实例', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 't_1234567', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_1234567', - ], - 'NodeType' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldInstanceIdList' => [ - 'title' => '字段ID列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1021', - ], - ], - ], - ], - ], - 'DownInstanceList' => [ - 'title' => '下游实例', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '下游实例', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 't_1234567', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_1234567', - ], - 'NodeType' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldInstanceIdList' => [ - 'title' => '字段ID列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1031', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Move menu tree file position', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetInstanceDownStream' => [ - 'summary' => '根据起始的实例查询该实例的下游', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateFileDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateFileName' => [ + 'summary' => 'Updates a file name.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'InstanceGet', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DATA_PROCESS', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'RunStatus', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '实例的运行状态'."\n" - .'INIT、WATING、RUNNING、SUCCESS、FAILED', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12132323'], ], [ - 'name' => 'DownStreamDepth', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'title' => '查询的dag向下展开的层数，允许值1~6', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12121111'], ], [ - 'name' => 'Env', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], + 'schema' => ['title' => '', 'description' => 'The new file name.', 'type' => 'string', 'required' => true, 'example' => 'xxNew'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'InstanceRelationList' => [ - 'title' => '下游及依赖关系'."\n", - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '下游及依赖关系', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceInfo' => [ - 'title' => '实力信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 't_232411', - ], - 'Name' => [ - 'title' => '实例名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - ], - ], - 'SelectStatus' => [ - 'title' => '实例选择状态,主要用于逻辑字段'."\n" - .'OPTIONAL可选'."\n" - .'SELECTED 必选'."\n" - .'DISABLE 不可选'."\n" - .'GROUP_SELECTED 全选或全不选', - 'description' => '', - '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' => '', - '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' => '', - '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"}', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DD06F8-1661-5A6E-B0A6-7E23133BDC60\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'Update a file name', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetSupplementDagrunInstance' => [ - 'summary' => '列出补数据工作流下具体一个业务日期的所有节点的实例。', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateFileName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'UpdatePipeline' => [ + 'summary' => 'Updates an integration pipeline or unstructured workflow node.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'DagrunId', - 'in' => 'query', + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Dagrun ID', - 'description' => 'Dagrun ID', - 'type' => 'string', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline or workflow node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The current operating environment. Valid values:'."\n" + ."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment. For workflow nodes, only PROD is supported.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => 'dr_2242792_14542', + 'example' => '', ], ], [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The configuration for updating the pipeline or workflow node.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 't_239496_20210411_246982077481', - ], - 'Type' => [ - 'title' => '实例类型'."\n" - .'NORMAL：周期实例、'."\n" - .'SUPPLEMENT：补数据实例'."\n" - .'MANUAL：手动实例', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', + 'ScheduleConfig' => ['title' => '', 'description' => 'The scheduling configuration in JSON string format. Refer to the toJsonString method of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig.', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}'], + 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'PipelineConfig' => [ + 'title' => '', + 'description' => 'The integration pipeline component or workflow operator configuration.', + 'type' => 'object', + 'properties' => [ + 'Steps' => [ + 'title' => '', + 'description' => 'The component or operator configurations, including the detailed configurations of all components or operators used.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The specific configuration of a component or operator.', + 'type' => 'object', + 'properties' => [ + 'PluginConfig' => ['title' => '', 'description' => 'The specific component configuration in JSON string format. Refer to the toJsonString method of the relevant subclasses of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig (or com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.unstructured.BaseOAUnstructuredNeuronConfig for workflow operators). Developers should inherit the component or operator configuration class and implement the corresponding component or operator configuration. Each component or operator configuration has the same structure as the node configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => '{}'], + 'StepType' => ['title' => '', 'description' => 'The component type. Valid values:'."\n" + ."\n" + .'- input: an input component.'."\n" + .'- output: an output component.'."\n" + .'- transfrom: a transform component.'."\n" + .'- process: a flow control component.'."\n" + ."\n" + .'For workflow nodes, this parameter specifies the operator type, such as image for images and text for text. Refer to the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepType. Developers should inherit the component or operator configuration class and implement the corresponding component or operator configuration. Each component or operator configuration has the same structure as the configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => 'input'], + 'StepName' => ['title' => '', 'description' => 'The step name. Step names must be unique within the same pipeline node.', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + 'IsDistribute' => ['title' => '', 'description' => 'Specifies the data distribution method when the current component has multiple downstream components. Valid values:'."\n" + ."\n" + .'- true (default): The data from the current component is distributed to all downstream components in a round-robin manner. For example, if the current component has 100 records and two downstream components, each downstream component receives 50 records.'."\n" + .'- false: The full data from the current component is sent to all downstream components. For example, if the current component has 100 records and two downstream components, each downstream component receives 100 records.'."\n" + ."\n" + .'This parameter is not applicable to workflow nodes.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Key' => ['title' => '', 'description' => 'The plugin ID. Each plugin or operator has a unique identifier. Refer to the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig#stepKey. Developers should inherit the component or operator configuration class and implement the corresponding component or operator configuration. Each component or operator configuration has the same structure as the configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput'], ], + 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'example' => '{"a":"b"}', - ], - 'NodeInfo' => [ - 'title' => '实例对应节点详情', - 'description' => '', + 'required' => true, + 'example' => '', + ], + 'Hops' => [ + 'title' => '', + 'description' => 'The DAG (directed acyclic graph) link configuration that describes the connection relationships among all components or operators.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The dependency configuration between integration pipeline input/output components or workflow operators.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'From' => [ - 'title' => '来源业务系统'."\n" - .'DATA_PROCESS：代码研发'."\n" - .'BLACK_BOX：黑盒'."\n" - .'ONE_ID：萃取'."\n" - .'PIPELINE：PIPELINE', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '优先级', - 'description' => '', - 'type' => 'string', - 'example' => 'MIDDLE', - ], - ], - 'SchedulePeriodList' => [ - 'title' => '调度周期'."\n" - .'MINUTELY'."\n" - .'HOURLY'."\n" - .'DAILY'."\n" - .'WEEKLY'."\n" - .'MONTHLY'."\n" - .'QUARTERLY', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1001012', - ], - 'Name' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'xx测试', - ], - ], - ], - 'Modifier' => [ - 'title' => '修改者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户ID', - 'description' => '', - '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' => '', - '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', - ], + 'Target' => ['title' => '', 'description' => 'The name of the output step, which corresponds to Steps[*].StepName.', 'type' => 'string', 'required' => true, 'example' => 'odps_writer'], + 'SendTo' => ['title' => '', 'description' => 'Specifies whether the downstream condition is true for a conditional distribution component. Set this parameter to true if the downstream condition is true, or false otherwise. This parameter is not applicable to workflow nodes.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Source' => ['title' => '', 'description' => 'The name of the input step, which corresponds to Steps[*].StepName.', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], ], + 'required' => false, + 'example' => '', ], + 'required' => true, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'The basic information about the integration pipeline or workflow node.', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '', 'description' => 'The name of the integration pipeline or workflow node.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline or workflow node. Leave this parameter empty for initial creation. When updating a pipeline or workflow node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The ID of the pipeline or workflow node. Leave this parameter empty for initial creation. When updating a pipeline or workflow node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'The file ID of the pipeline or workflow. Leave this parameter empty for initial creation. When updating a pipeline or workflow node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'Directory' => ['title' => '', 'description' => 'The folder of the integration pipeline or workflow node (defaults to the root folder). The folder must exist. If it does not exist, call the relevant API operation to create a folder of type offlinePipeline (or unstructuredPipeline for workflows).', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + 'required' => true, + 'example' => '', + ], + 'PipelineType' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'- 0 (default): batch integration.'."\n" + .'- 1: real-time integration.'."\n" + .'- 14: workflow node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Mode' => ['title' => '', 'description' => 'The integration pipeline configuration mode. Valid values:'."\n" + ."\n" + .'- PIPELINE (default): pipeline mode.'."\n" + .'- JSON: script mode.'."\n" + ."\n" + .'This parameter is not applicable to workflow nodes.', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE'], + 'Submit' => ['title' => '', 'description' => 'Specifies whether to submit the node. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'PipelineJson' => ['title' => '', 'description' => 'The integration pipeline configuration in JSON string format for script mode. Workflow nodes do not support script mode.', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Settings' => ['title' => '', 'description' => 'The channel configuration in JSON string format. Refer to the toJsonString method of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting.', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The update result of the pipeline or workflow node.', + 'type' => 'object', + 'properties' => [ + 'SubmitId' => ['title' => '', 'description' => 'The submit ID generated upon successful submission of the pipeline or workflow, which is added to the pending publish list and can be published through the publish domain. This value is not returned for workflow nodes because they only support PROD.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'HostMachine' => ['title' => '', 'description' => 'The name and IP address of the server that executed the request.', 'type' => 'string', 'example' => 'hostName:hostIp'], + 'Version' => ['title' => '', 'description' => 'The version number pending publish. This value is not returned for workflow nodes because they only support PROD.', 'type' => 'string', 'example' => '1'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline or workflow node.', 'type' => 'string', 'example' => '123'], + 'PipelineId' => ['title' => '', 'description' => 'The pipeline or workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Update a pipeline or unstructured workflow node', + 'extraInfo' => 'For usage details, refer to the demo in the supporting tool package: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetPhysicalInstance' => [ - 'summary' => '查询脚本的实例信息, 包括实例状态、运行时间等信息.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdatePipelineByAsync' => [ + 'summary' => 'Asynchronously updates a pipeline or unstructured workflow node.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't_23231', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'Context', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request context information.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the integration pipeline node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'Env' => ['title' => '', 'description' => 'The current operating environment. Valid values:'."\n" + ."\n" + .'- DEV: the development environment.'."\n" + .'- PROD: the production environment.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + ], 'required' => true, - 'example' => '2323131', + 'example' => '', ], ], [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '● 环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The pipeline node update configuration.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Instance' => [ - 'title' => '实例详情', - 'description' => '', + 'ScheduleConfig' => ['title' => '', 'description' => 'The scheduling configuration in JSON string format. Refer to the toJsonString method of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAScheduleConfig.', 'type' => 'string', 'required' => true, 'example' => '{"cronExpression":"0 0 0 * * ?"}'], + 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'], + 'PipelineConfig' => [ + 'title' => '', + 'description' => 'The integration pipeline component configuration.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - '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' => '', + 'Steps' => [ + 'title' => '', + 'description' => 'The component configurations, including detailed configurations of all components used.', 'type' => 'array', 'items' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', + 'title' => '', + 'description' => 'The specific component configuration.', + 'type' => 'object', + 'properties' => [ + 'PluginConfig' => ['title' => '', 'description' => 'The specific component configuration in JSON string format. Refer to the toJsonString method of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig (or com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.unstructured.BaseOAUnstructuredNeuronConfig for workflow operators) and its subclasses. Developers should inherit the component or operator configuration class and implement the corresponding configuration. Each component or operator configuration has the same structure as the node configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => '{}'], + 'StepType' => ['title' => '', 'description' => 'The component type. Valid values:'."\n" + ."\n" + .'- input: an input component.'."\n" + .'- output: an output component.'."\n" + .'- transfrom: a transform component.'."\n" + .'- process: a flow control component.'."\n" + ."\n" + .'For workflow nodes, this parameter specifies the operator type, such as image for images and text for text. Refer to the stepType field of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig. Developers should inherit the component or operator configuration class and implement the corresponding configuration. Each component or operator configuration has the same structure as the configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => 'input'], + 'StepName' => ['title' => '', 'description' => 'The step name. Step names must be unique within the same pipeline node.', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], + 'IsDistribute' => ['title' => '', 'description' => 'Specifies the data distribution method when the current component has multiple downstream components. Valid values:'."\n" + ."\n" + .'- true: the data of the current component is distributed to all downstream components in a round-robin manner. For example, if the current component has 100 records and two downstream components, each downstream component receives 50 records. Default value: true.'."\n" + .'- false: the full data of the current component is sent to all downstream components. For example, if the current component has 100 records and two downstream components, both downstream components receive 100 records.'."\n" + ."\n" + .'This parameter is not applicable to workflow nodes.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Key' => ['title' => '', 'description' => 'The plugin ID. Each plugin or operator has a unique identifier. Refer to the stepKey field of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig. Developers should inherit the component or operator configuration class and implement the corresponding configuration. Each component or operator configuration has the same structure as the configuration created on the Dataphin console.', 'type' => 'string', 'required' => true, 'example' => 'mysqlinput'], + ], + 'required' => false, + 'example' => '', ], + 'required' => true, + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'example' => 'n_3232312', - ], - 'From' => [ - 'title' => '节点来源系统', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'Type' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SubDetailType' => [ - 'title' => '子业务类型', - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '2323111', - ], - 'Name' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'zhangsan', - ], - ], - ], - 'Modifier' => [ - 'title' => '编辑者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户ID', - 'description' => '', - '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' => '', - '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', + 'Hops' => [ + 'title' => '', + 'description' => 'The DAG (directed acyclic graph) link configurations that describe the connections between all components.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The input-output component relationship configuration for the integration pipeline.', + 'type' => 'object', + 'properties' => [ + 'Target' => ['title' => '', 'description' => 'The output step name, which corresponds to Steps[*].StepName.', 'type' => 'string', 'required' => true, 'example' => 'odps_writer'], + 'SendTo' => ['title' => '', 'description' => 'For conditional distribution components, set this parameter to true when the downstream condition is true, and to false otherwise. This parameter is not applicable to workflow nodes.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Source' => ['title' => '', 'description' => 'The input step name, which corresponds to Steps[*].StepName.', 'type' => 'string', 'required' => true, 'example' => 'mysql_reader'], ], + 'required' => false, + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'ExtendInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], ], + 'required' => true, + 'example' => '', + ], + 'NodeInfo' => [ + 'title' => '', + 'description' => 'The basic information of the integration pipeline node.', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '', 'description' => 'The name of the integration pipeline node.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'NodeId' => ['title' => '', 'description' => 'The scheduling node ID of the pipeline node. Leave this parameter empty for initial creation. When updating a pipeline node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'string', 'required' => false, 'example' => 'n_123'], + 'PipelineId' => ['title' => '', 'description' => 'The pipeline node ID. Leave this parameter empty for initial creation. When updating a pipeline node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'FileId' => ['title' => '', 'description' => 'The pipeline file ID. Leave this parameter empty for initial creation. When updating a pipeline node, specify at least one of pipelineId, fileId, or nodeId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'Directory' => ['title' => '', 'description' => 'The folder of the integration pipeline node. Default value: root folder. The folder must exist. If it does not exist, call the relevant API operation to create a folder of the offlinePipeline type.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + 'required' => true, + 'example' => '', ], + 'PipelineType' => ['title' => '', 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'- 0: batch integration (default).'."\n" + .'- 1: real-time integration.'."\n" + .'- 14: workflow node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Mode' => ['title' => '', 'description' => 'The integration pipeline configuration mode. Valid values:'."\n" + ."\n" + .'- PIPELINE: pipeline mode (default).'."\n" + .'- JSON: script mode.'."\n" + ."\n" + .'This parameter is not applicable to workflow nodes.', 'type' => 'string', 'required' => false, 'example' => 'PIPELINE'], + 'Submit' => ['title' => '', 'description' => 'Specifies whether to submit the node. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'PipelineJson' => ['title' => '', 'description' => 'The integration pipeline configuration in JSON string format for script mode. Workflow nodes do not support script mode.', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Settings' => ['title' => '', 'description' => 'The channel configuration in JSON string format. Refer to the toJsonString method of the utility class com.alibaba.dataphin.pipeline.common.facade.openapi.model.OAPipelineSetting.', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Message' => ['title' => '', 'description' => 'The error details returned by the backend.', 'type' => 'string', 'example' => 'internal error'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The query ID for the asynchronous execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": false\\n}","type":"json"}]', + 'title' => 'Asynchronously update a pipeline or unstructured workflow node', + 'extraInfo' => 'For usage details, refer to the demo in the supporting tool package: com.alibaba.dataphin.pipeline.common.facade.openapi.demoPipelineOpenApiDemo.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListInstances' => [ - 'summary' => '分页查询实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateProjectMember' => [ + 'summary' => 'Edits project members.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + ], + [ + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询请求', - 'description' => '', + 'title' => '', + 'description' => 'The update command.', 'type' => 'object', 'properties' => [ - 'NodeId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_23131', - ], - 'RunStatusList' => [ - 'title' => 'INIT(初始化)、WAIT_SUBMISSION(等待提交)、WAIT_SCHEDULE(等待调度时间)、DISPATCH_BLOCKED(限流中)、WAIT_RESOURCE(等待调度资源)、RUNNING(运行中)、SUCCESS(成功)、FAILED(失败) ', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-05-31', - ], - 'BizType' => [ - 'title' => '业务类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SCRIPT', - ], - 'SubBizTypeList' => [ - 'title' => '子业务类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], - 'required' => false, - ], - 'SchedulePeriodList' => [ - 'title' => '调度周期', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], - 'required' => false, - ], - 'OwnerList' => [ - 'title' => '节点负责人', - 'description' => '', + 'Env' => ['title' => '', 'description' => 'The environment identifier.', 'type' => 'string', 'required' => true, 'example' => 'DEV'], + 'UserList' => [ + 'title' => '', + 'description' => 'The list of user members.', 'type' => 'array', 'items' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '30012011'], + 'RoleList' => [ + 'title' => '', + 'description' => 'The member role. Valid values: 1: project administrator. 2: developer. 3: visitor. 4: analyst. 5: O&M engineer.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The member role. Valid values: 1: project administrator. 2: developer. 3: visitor. 4: analyst. 5: O&M engineer.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'required' => true, + 'example' => '', + ], + ], 'required' => false, - 'example' => '123131', - ], - 'required' => false, - ], - 'PriorityList' => [ - 'title' => '优先级', - 'description' => '', - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MIDDLE', + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NORMAL', - ], - 'SearchText' => [ - 'title' => '节点名称模糊匹配或节点ID精确匹配', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '131311111321', + 'example' => '', ], - 'Page' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Edit project members', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateQualityRuleSwitch' => [ + 'summary' => 'Enables or disables quality rules in batches.'."\n" + .'Release version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The update instruction.', + 'type' => 'object', + 'properties' => [ + 'Open' => ['title' => '', 'description' => 'Specifies whether to enable the quality rules.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'RuleIdList' => [ + 'title' => '', + 'description' => 'The list of rule IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of rule IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], 'required' => true, - 'example' => '1', + 'example' => '', ], - 'PageSize' => [ - 'title' => '分页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of records that took effect.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Enable or disable quality rules in batches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateQualityWatchSwitch' => [ + 'summary' => 'Starts or stops quality monitored objects in batches.'."\n" + .'Release version: 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' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The update instruction.', + 'type' => 'object', + 'properties' => [ + 'Open' => ['title' => '', 'description' => 'Specifies whether to enable the monitored object.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'WatchIdList' => [ + 'title' => '', + 'description' => 'The list of monitoring IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of monitoring IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], 'required' => true, - 'example' => '20', - ], - 'BizUnitId' => [ - 'title' => '业务板块id，查询汇总逻辑表时需要传入', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - 'FlowId' => [ - 'title' => '任务流Id', - 'type' => 'string', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The number of records that took effect.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Start or stop quality monitored objects in batches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateResource' => [ + 'summary' => 'Edits a resource file.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'Env', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'title' => '', + 'description' => 'The edit command.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10112101'], + 'Name' => ['title' => '', 'description' => 'The resource name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'StorageAddress' => ['title' => '', 'description' => 'The storage address of the resource.', 'type' => 'string', 'required' => true, 'example' => '300011448/711833/cdcd1c44-f1ee-46bb-b318-1d123dbabf6c'], + 'Description' => ['title' => '', 'description' => 'The resource description.', 'type' => 'string', 'required' => true, 'example' => 'xx 测试'], + 'Comment' => ['title' => '', 'description' => 'The commit remarks.', 'type' => 'string', 'required' => true, 'example' => 'xx 测试'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + 'ComputeEngineType' => ['title' => '', 'description' => 'The compute engine type. Valid values:'."\n" + .'- MAX_COMPUTE'."\n" + .'- HADOOP.', 'type' => 'string', 'required' => true, 'example' => 'MAX_COMPUTE'], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'n_132331', - ], - 'From' => [ - 'title' => '节点来源', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCES', - ], - 'Type' => [ - 'title' => '节点业务类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCES', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SubDetailType' => [ - 'title' => '子业务类型', - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'Description' => [ - 'title' => '节点描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - ], - 'BizUnitName' => [ - 'title' => '业务板块', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Creator' => [ - 'title' => '节点创建人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21313112', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Modifier' => [ - 'title' => '编辑人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21313112', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'OwnerList' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21313112', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Edit a resource file', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'OperateInstance' => [ - 'summary' => '运维实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateRowPermission' => [ + 'summary' => 'Updates a row-level permission.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -56372,222 +38760,253 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'OperateCommand', + 'name' => 'UpdateRowPermissionCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '操作请求', - 'description' => '', + 'title' => '', + 'description' => 'The request command.', 'type' => 'object', 'properties' => [ - 'InstanceIdList' => [ - 'title' => '运维实例列表', - 'description' => '', + 'RowPermissionId' => ['title' => '', 'description' => 'The row-level permission ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30009999'], + 'RowPermissionName' => ['title' => '', 'description' => 'The row-level permission name.', 'type' => 'string', 'required' => true, 'example' => '业务管控'], + 'RowPermissionDesc' => ['title' => '', 'description' => 'The row-level permission description.', 'type' => 'string', 'required' => false, 'example' => '管控业务数据'], + 'MappingColumns' => [ + 'title' => '', + 'description' => 'The mapping fields.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', + 'ColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + 'ColumnType' => [ + 'title' => '', + 'description' => 'The type of the mapping field.', 'type' => 'string', 'required' => true, - 'example' => 't_32111312', - ], - 'FieldInstanceIdList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 't_2311', - ], - 'required' => false, + 'enum' => ['STRING', 'NUMBER'], + 'example' => 'STRING', ], + 'ColumnDesc' => ['title' => '', 'description' => 'The description of the mapping field.', 'type' => 'string', 'required' => false, 'example' => '业务ID'], ], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '', ], - 'Operation' => [ - 'title' => '操作 '."\n" - .'RERUN:重跑/PAUSE:暂停/RESUME:恢复/TERMINATE:终止/SET_SUCCESS:置为成功', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RERUN', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '132324', - 'example' => '132311', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'InstanceStatusList' => [ - 'title' => '实例运维结果', - 'description' => '', + 'Rules' => [ + 'title' => '', + 'description' => 'The rules.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 't_132435', - ], - 'Name' => [ - 'title' => '实例名', - 'description' => '', + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => true, 'example' => '管控业务ID大于100'], + 'ScopeType' => [ + 'title' => '', + 'description' => 'The scope type of the rule.', 'type' => 'string', - 'example' => '', + 'required' => true, + 'enum' => ['ALL_COLUMN', 'SELECT_COLUMN'], + 'example' => 'SELECT_COLUMN', ], - 'DisplayName' => [ - 'title' => '实例显示名', - 'description' => '', - 'type' => 'string', - 'example' => '', + 'IsDelete' => [ + 'title' => '', + 'description' => 'Specifies whether to delete the rule.', + 'type' => 'boolean', + 'enum' => ['0', '1'], + 'required' => false, + 'example' => '0', ], 'Status' => [ - 'title' => '操作的结果，成功或者失败', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', + 'title' => '', + 'description' => 'The rule status.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enum' => ['0', '1'], + 'example' => '1', ], - 'ErrorMessage' => [ - 'title' => '操作失败时的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - 'OwnerId' => [ - 'title' => '实例负责人', - 'description' => '', - 'type' => 'string', - 'example' => '121311', + 'Expressions' => [ + 'title' => '', + 'description' => 'The rule expressions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + 'Values' => [ + 'title' => '', + 'description' => 'The operation values of the expression.', + 'type' => 'array', + 'items' => ['description' => 'The operation values of the expression.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'required' => true, + 'example' => '', + ], + 'Type' => [ + 'title' => '', + 'description' => 'The expression type.', + 'type' => 'string', + 'required' => true, + 'enum' => ['EXPRESSION', 'RELATION'], + 'example' => 'EXPRESSION', + ], + 'SubConditions' => [ + 'title' => '', + 'description' => 'The sub-expressions.', + 'type' => 'array', + 'items' => ['description' => 'The sub-expression. The structure is the same as Expressions.', 'type' => 'any', 'required' => true, 'example' => '同Expressions', 'title' => ''], + 'required' => true, + 'example' => '', + ], + 'Operator' => [ + 'title' => '', + 'description' => 'The expression operator.', + 'type' => 'string', + 'required' => true, + 'enum' => ['EQUAL', 'NOT_EQUAL', 'IN', 'NOT_IN', 'LIKE', 'NOT_LIKE', 'GT', 'LT', 'GE', 'LE', 'OR', 'AND'], + 'example' => 'OR', + ], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], - 'OwnerName' => [ - 'title' => '实例负责人', - 'description' => '', - 'type' => 'string', + 'UserMappingList' => [ + 'title' => '', + 'description' => 'The accounts associated with the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountType' => [ + 'title' => '', + 'description' => 'The type of the account associated with the rule.', + 'enumValueTitles' => ['PERSONAL' => 'PERSONAL', 'USER_GROUP' => 'USER_GROUP', 'PRODUCE' => 'PRODUCE'], + 'type' => 'string', + 'required' => true, + 'example' => 'PERSONAL', + ], + 'Accounts' => [ + 'title' => '', + 'description' => 'The accounts associated with the rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '', 'description' => 'The ID of the account associated with the rule.', 'type' => 'string', 'required' => true, 'example' => '30001011'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, 'example' => '', ], ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'The related tables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappingColumnName' => ['title' => '', 'description' => 'The name of the mapping field.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + 'ResourceId' => ['title' => '', 'description' => 'The GUID of the table.', 'type' => 'string', 'required' => true, 'example' => 'odps.300199897.project_name.table_name'."\n"], + 'ColumnName' => ['title' => '', 'description' => 'The table field.', 'type' => 'string', 'required' => true, 'example' => 'business_id'], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'The update result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - '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"}]', - ], - 'FixData' => [ - 'summary' => '重跑下游(修复链路数据), 支持强制重跑下游。影响范围: 1. 会产生计算成本；2. 会影响数据产出', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => 'Update row-level permission', + 'extraInfo' => 'API version: v5.1.0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateSecurityClassify' => [ + 'summary' => 'Updates a data classification.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -56595,215 +39014,150 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'FixDataCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '重跑下游(修复链路数据),可以选择强制重跑', - 'description' => '', + 'title' => '', + 'description' => 'The update command.', 'type' => 'object', 'properties' => [ - 'RootInstanceId' => [ - 'title' => '根实例', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't_2323111', - ], - 'FieldInstanceIdList' => [ - 'title' => '当节点时逻辑表实例id时可以传，不传默认是全表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '121', - ], - 'required' => false, - ], - ], - 'required' => true, + 'Id' => ['title' => '', 'description' => 'The classification ID. If this parameter is not specified, the classification is matched and updated based on the classification name and parent path.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'ParentPath' => ['title' => '', 'description' => 'The parent path of the classification.', 'type' => 'string', 'required' => false, 'example' => '/a/b/'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the classification.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description of the classification.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'LevelName' => ['title' => '', 'description' => 'The data level name.', 'type' => 'string', 'required' => true, 'example' => 'L2'], + 'FeatureNameList' => [ + 'title' => '', + 'description' => 'The feature names.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The feature names.', 'type' => 'string', 'required' => false, 'example' => '行业'], + 'required' => false, + 'example' => '', ], - 'DownStreamInstanceIdList' => [ - 'title' => '下游实例(如果选择了下游范围，则此处可不传，否则需要传入下游实例列表) ', - 'description' => '', + 'Priority' => ['title' => '', 'description' => 'The priority. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + 'AdvancedConditionList' => [ + 'title' => '', + 'description' => 'The advanced configurations.', 'type' => 'array', 'items' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', + 'ParentId' => ['title' => '', 'description' => 'The parent node of the feature condition.', 'type' => 'string', 'required' => false, 'example' => '123'], + 'Id' => ['title' => '', 'description' => 'The ID of the feature condition node. The ID is randomly generated by the application and must be unique.', 'type' => 'string', 'required' => true, 'example' => '234'], + 'Relation' => ['title' => '', 'description' => 'The condition relation. Valid values:'."\n" + .'- EXPRESSION: expression.'."\n" + .'- RELATION: relation.', 'type' => 'string', 'required' => true, 'example' => 'EXPRESSION'], + 'Property' => ['title' => '', 'description' => 'The feature property. Valid values:'."\n" + .'- TABLE_NAME: table name.'."\n" + .'- TABLE_DESC: table description.'."\n" + .'- FIELD_CONTENT: field content.'."\n" + .'- FIELD_NAME: field name.'."\n" + .'- FIELD_DESC: field description.'."\n" + .'- FIELD_TYPE: field type.', 'type' => 'string', 'required' => false, 'example' => 'TABLE_NAME'], + 'Operate' => ['title' => '', 'description' => 'The condition operator. Valid values:'."\n" + .'- AND'."\n" + .'- OR'."\n" + .'- BUILT_IN_EXPRESSION: built-in expression.'."\n" + .'- IGNORE_CASE_EXPRESSION: regular expression with case-insensitive matching.'."\n" + .'- EXPRESSION: regular expression.'."\n" + .'- NOT_BELONG: does not belong to.'."\n" + .'- CONTAINS: contains.'."\n" + .'- NOT_CONTAINS: does not contain.'."\n" + .'- EQUAL'."\n" + .'- NOT_EQUAL.', 'type' => 'string', 'required' => true, 'example' => 'AND'], + 'ValueList' => [ + 'title' => '', + 'description' => 'The condition values.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The condition values.', 'type' => 'string', 'required' => false, 'example' => 'abc'], 'required' => false, - 'example' => 't_2323421', + 'example' => '', ], - 'FieldInstanceIdList' => [ - 'description' => '', + 'OptionList' => [ + 'title' => '', + 'description' => 'The additional properties, such as field content.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], 'required' => false, - 'example' => 't_2311', + 'description' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], 'required' => false, + 'description' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'ContainRootInstance' => [ - 'title' => '根实例是否重跑，不选默认为是', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'DownstreamRange' => [ - 'title' => '下游范围(快捷选项：ALL_FAILED_INSTANCE:所有失败实例; ALL_INSTANCE: 所有实例; ALL_FINAL_INSTANCE: 所有终态实例;) 不传默认需要根据传入的下游进行重跑', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_INSTANCE', - ], - 'ForceRerun' => [ - 'title' => '释放强制重跑', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '132344', - ], + 'Status' => ['title' => '', 'description' => 'The classification status. Valid values:'."\n" + .'- ENABLE: enabled.'."\n" + .'- DISABLE: disabled.', 'type' => 'string', 'required' => false, 'example' => 'ENABLE'], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'SubmitId' => [ - 'title' => '本次提交的提交id，如果选择downstreamRange为快捷模式，则此处会返回提交id，需要通过提交状态查询接口([QueryOperationSubmitJobStatus])，查询本次提交的状态。人为选择下游实例可忽略该返回', - 'description' => '', - 'type' => 'string', - 'example' => '12324234', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The data classification ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Update data classification', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ExecuteTriggerNode' => [ - 'summary' => '运行触发式节点。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSecurityClassifyCatalog' => [ + 'summary' => 'Updates a data classification folder. Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], 'tags' => [], 'security' => [ [ @@ -56812,150 +39166,84 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'NodeId', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '节点id', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The update instruction.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['title' => '', 'description' => 'The original full path of the folder.', 'type' => 'string', 'required' => true, 'example' => '/d1/d2/'], + 'Name' => ['title' => '', 'description' => 'The name of the classification folder.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'ParentPath' => ['title' => '', 'description' => 'The full path of the parent classification folder. Default value: /.', 'type' => 'string', 'required' => false, 'example' => '/d1/'], + 'OwnerList' => [ + 'title' => '', + 'description' => 'The list of administrator IDs. This parameter takes effect only when the parent folder is the root folder.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of administrator IDs. This parameter takes effect only when the parent folder is the root folder.', 'type' => 'string', 'required' => false, 'example' => '30001011'], + 'required' => false, + 'example' => '', + ], + 'VisibleType' => ['title' => '', 'description' => 'The visibility scope of the classification folder. This parameter takes effect only when the parent folder is the root folder. Valid values:'."\n" + .'- PUBLIC: visible to all users.'."\n" + .'- PRIVATE: visible only to administrators.'."\n" + .'Default value: PUBLIC.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + ], '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10110201', - ], - ], - [ - 'name' => 'Index', - 'in' => 'query', - 'schema' => [ - 'title' => '如果节点ID为小时或分钟节点，一天会有多个实例，index代表实例的序号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '开发或生产环境：DEV 开发、PROD 生产，默认PROD', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The full path of the folder after the update.', 'type' => 'string', 'example' => '/d1/d3/'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": \\"/d1/d3/\\"\\n}","type":"json"}]', + 'title' => 'Update a data classification folder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'CreateNodeSupplement' => [ - 'summary' => '通用补数据接口 1.会生成补数据实例运行：影响相关产产出表数据 2.会进行任务运行：造成计算的费用以及存储的费用', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSecurityIdentifyResultStatus' => [ + 'summary' => 'Updates the effective status of security identification results.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -56963,286 +39251,78 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'CreateCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '新建补数据请求', + 'title' => '', + 'description' => 'The update instruction.', 'type' => 'object', 'properties' => [ - 'NodeIdList' => [ - 'title' => '补数据的根节点，支持多个根节点', + 'Enable' => ['title' => '', 'description' => 'Specifies whether the result is effective.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'IdentifyResultIdList' => [ + 'title' => '', + 'description' => 'The list of identification result IDs.', 'type' => 'array', - 'items' => [ - 'title' => '根节点', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'type' => 'string', - 'required' => true, - ], - 'FieldIdList' => [ - 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'StartBizDate' => [ - 'title' => '起始业务日期 ', - 'type' => 'string', - 'required' => true, - 'example' => '2021-06-01', - ], - 'EndBizDate' => [ - 'title' => '截止业务日期 ', - 'type' => 'string', + 'items' => ['title' => '', 'description' => 'The list of identification result IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'required' => true, - 'example' => '2021-06-01', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101121', - ], - 'Name' => [ - 'title' => '补数据名称，不传时系统生成', - 'type' => 'string', - 'example' => 'xx测试', - ], - 'DownStreamNodeIdList' => [ - 'title' => '下游节点ID，指定下游节点运行；'."\n" - .'ContainAllDownStream = false 时生效', - 'type' => 'array', - 'items' => [ - 'title' => '根节点', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'type' => 'string', - 'required' => false, - ], - 'FieldIdList' => [ - 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ContainAllDownStream' => [ - 'title' => '海量模式：包含所有下游，默认为false ', - 'type' => 'boolean', - ], - 'FilterList' => [ - 'title' => '过滤器，和ContainAllDownStream搭配使用，可以根据项目，节点等进行正选和反选，默认为空', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'ValueList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'Exclude' => [ - 'type' => 'boolean', - ], - ], - ], - ], - 'Parallelism' => [ - 'title' => '并发数，默认为1', - 'type' => 'integer', - 'format' => 'int32', - ], - 'MinDueTime' => [ - 'title' => '最早调起时间(HH:MM)，小时任务专用', - 'type' => 'string', - ], - 'MaxDueTime' => [ - 'title' => '最晚调起时间(HH:MM)，小时任务专用', - 'type' => 'string', - ], - 'GlobalParamList' => [ - 'title' => '运行时全局参数', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'NodeParamsList' => [ - 'title' => '运行时自定义参数, 按照节点进行配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NodeId' => [ - 'type' => 'string', - ], - 'ParamList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'example' => '', ], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PROD' => 'PROD', - 'DEV' => 'DEV', - ], - 'example' => 'DEV/PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true/false', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'SubmitId' => [ - 'title' => '如果是普通模式，返回的是flowId; 如果是海量模式，返回提交的jobId，可以根据GetOperationSubmitStatus 查询提交的状态，提交成功后会返回flowId', - 'description' => '', - 'type' => 'string', - 'example' => 'f_2264518792396800000_20210223_2329354897145659392', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The update result.', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": false\\n}","type":"json"}]', + 'title' => 'Update the effective status of security identification results', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'PausePhysicalNode' => [ - 'summary' => '暂停物理节点调度。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSecurityLevel' => [ + 'summary' => 'Updates data classification.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -57250,3018 +39330,1745 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'PauseCommand', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '暂停调度请求', - 'description' => '', + 'title' => '', + 'description' => 'The update instruction.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '13222210', - ], - 'NodeIdList' => [ - 'title' => '节点ID列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'n_2311121', - ], - 'required' => true, - ], + 'Name' => ['title' => '', 'description' => 'The classification name.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Index' => ['title' => '', 'description' => 'The classification order. If this parameter is not specified, the classification name is used for matching.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Description' => ['title' => '', 'description' => 'The classification description.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'n_123456', - ], - 'Status' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'ErrorMessage' => [ - 'title' => '操作失败时，异常信息提示', - 'description' => '', - 'type' => 'string', - 'example' => 'xx ', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Update data classification', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetOperationSubmitStatus' => [ - 'summary' => '查询补数据提交的状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandard' => [ + 'summary' => 'Updates a standard.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => '海量模式下提交后返回的jobId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1324444131', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The update command.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'StandardId' => ['title' => '', 'description' => 'The lookup table.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'StandardStatus' => ['title' => '', 'description' => 'The status of the standard.', 'type' => 'string', 'required' => true, 'example' => 'draft'], + 'StandardTemplateReference' => [ + 'title' => '', + 'description' => 'The standard template to which the standard belongs.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'Version' => ['title' => '', 'description' => 'The version number of the standard template. The latest version is used by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'AttributeValueList' => [ + 'title' => '', + 'description' => 'The attribute values corresponding to the attributes in the referenced template. If left empty, default values are used.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1011'], + 'Value' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', + 'StandardSetReference' => [ + 'title' => '', + 'description' => 'The reference to the standard set that the current standard belongs to.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + ], + 'required' => true, + 'example' => '', ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'EffectiveTimeConfig' => [ + 'title' => '', + 'description' => 'The effective period configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The effective period type. Valid values:'."\n" + .'- FOREVER: permanent.'."\n" + .'- TIME_PERIOD: time period.', 'type' => 'string', 'required' => true, 'example' => 'TIME_PERIOD'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the effective period.', 'type' => 'string', 'required' => false, 'example' => '2025-06-30 00:00:00'], + 'EndTime' => ['title' => '', 'description' => 'The end time of the effective period.', 'type' => 'string', 'required' => false, 'example' => '2025-12-30 00:00:00'], + ], + 'required' => false, + 'example' => '', ], - 'OperationSubmitJob' => [ - 'title' => '操作提交的状态', - 'description' => '', + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The owner. If not specified, the current user is used.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'StandardGeneralMonitorConfig' => [ + 'title' => '', + 'description' => 'The standard monitoring configuration.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'title' => '补数据的提交id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SUPPLY_DATA', - ], - 'OperationStatus' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'ExternalBizId' => [ - 'title' => '业务id，如果是补数据操作则为补数据工作流', - 'description' => '', - 'type' => 'string', - 'example' => 'f_122_232342', - ], - 'Operator' => [ - 'title' => '提交人用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '132344', + 'StandardMonitorConfigList' => [ + 'title' => '', + 'description' => 'The list of standard monitoring configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The monitoring configuration ID. If left empty, a new monitoring configuration is created. If an existing monitoring configuration ID is specified, the corresponding monitoring configuration is updated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'RuleName' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The rule description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The monitoring type. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'required' => true, 'example' => 'METADATA'], + 'MonitorFrom' => ['title' => '', 'description' => 'The method used to add the monitoring configuration. Valid values:'."\n" + .'- BY_USER: manually added.'."\n" + .'- BY_SYSTEM_ATTRIBUTE: preset by system attribute.', 'type' => 'string', 'required' => true, 'example' => 'BY_SYSTEM_ATTRIBUTE'], + 'AttributeId' => ['title' => '', 'description' => 'The associated attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '112'], + 'AttributeName' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'required' => false, 'example' => 'teset'], + 'AttributeMonitorConfig' => [ + 'title' => '', + 'description' => 'The monitoring configuration for the associated attribute.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The monitoring method. Valid values:'."\n" + .'- METADATA: metadata monitoring.'."\n" + .'- QUALITY: data quality monitoring.', 'type' => 'string', 'required' => true, 'example' => 'METADATA'], + 'ColumnName' => ['title' => '', 'description' => 'The field to check.', 'type' => 'string', 'required' => false, 'example' => 'column1'], + 'IsCaseSensitive' => ['title' => '', 'description' => 'Specifies whether the check is case-sensitive.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'RuleSubType' => ['title' => '', 'description' => 'The rule subtype. This parameter is required when the monitoring type is QUALITY. Valid values:'."\n" + .'- BY_ATTRIBUTE: configured based on attributes.'."\n" + .'- CUSTOMIZED: custom configuration.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED'], + 'QualityRuleTemplate' => [ + 'title' => '', + 'description' => 'The rule template. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Type' => ['title' => '', 'description' => 'The template source. Valid values:'."\n" + .'- FROM_SYSTEM: system template.'."\n" + .'- CUSTOMIZED: custom template.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + ], + 'required' => false, + 'example' => '', + ], + 'RuleConfigList' => [ + 'title' => '', + 'description' => 'The rule configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The configuration item.', 'type' => 'string', 'required' => true, 'example' => 'k1'], + 'Value' => ['title' => '', 'description' => 'The configuration item value.', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'RuleValidateConfigList' => [ + 'title' => '', + 'description' => 'The rule validation configurations. This parameter is required when the monitoring type is QUALITY.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The validation configuration ID. This ID is randomly generated by the business and must be unique.', 'type' => 'string', 'required' => true, 'example' => 'abc'], + 'ParentId' => ['title' => '', 'description' => 'The parent validation configuration ID. The parent rule validation type can only be RELATION.', 'type' => 'string', 'required' => false, 'example' => 'a'], + 'Type' => ['title' => '', 'description' => 'The rule validation type. Valid values:'."\n" + .'- RELATION: relation.'."\n" + .'- EXPRESSION: expression.', 'type' => 'string', 'required' => true, 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'The operator. If the validation type is EXPRESSION, valid values:'."\n" + .'- EQUAL: equal to.'."\n" + .'- NOT_EQUAL: not equal to.'."\n" + .'- LARGER: greater than.'."\n" + .'- LARGE_OR_EQUAL: greater than or equal to.'."\n" + .'- SMALLER: less than.'."\n" + .'- SMALLER_OR_EQUAL: less than or equal to.'."\n" + ."\n" + .'If the validation type is RELATION, valid values:'."\n" + .'- AND: and.'."\n" + .'- OR: or.', 'type' => 'string', 'required' => true, 'example' => 'AND'], + 'Metric' => ['title' => '', 'description' => 'The metric. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'required' => false, 'example' => 'a'], + 'MetricName' => ['title' => '', 'description' => 'The metric name. This parameter is required when the validation type is EXPRESSION.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The value to compare against.', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], + 'NeedGenerateStandardCode' => ['title' => '', 'description' => 'Specifies whether to generate a standard code based on rules. If set to true, the standard code specified in the attribute values is ignored and regenerated.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Update a standard', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetPhysicalInstanceLog' => [ - 'summary' => '获取实例执行的日志，如果实例重跑了多次，则会有多条日志', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandardLookupTable' => [ + 'summary' => 'Updates a data standard lookup table.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't_5929472_20210411_9577721', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123131', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Env', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The update command.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'TaskrunLogList' => [ - 'title' => '实例所有的执行日志. 包含实例多次重跑的日志', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The lookup table ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The lookup table name.', 'type' => 'string', 'required' => true, 'example' => '城市码表'], + 'Code' => ['title' => '', 'description' => 'The lookup table code.', 'type' => 'string', 'required' => true, 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'The lookup table description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'The ID of the lookup table owner. Default value: the user ID of the caller.', 'type' => 'string', 'required' => false, 'example' => '30012021'], + 'LookupTableValueList' => [ + 'title' => '', + 'description' => 'The list of lookup table values.', 'type' => 'array', 'items' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'TaskrunId' => [ - 'title' => '每一次运行的任务ID', - 'description' => '', - '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', - ], + 'Value' => ['title' => '', 'description' => 'The code value.', 'type' => 'string', 'required' => true, 'example' => '杭州'], + 'Name' => ['title' => '', 'description' => 'The code name.', 'type' => 'string', 'required' => true, 'example' => 'Hangzhou'], + 'EnglishName' => ['title' => '', 'description' => 'The English name of the code.', 'type' => 'string', 'required' => false, 'example' => 'HZ'], + 'Description' => ['title' => '', 'description' => 'The code description.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'The directory to which the lookup table belongs.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'The directory to which the lookup table belongs.', 'type' => 'string', 'required' => true, 'example' => '/dir1/dir2'], ], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Update a data standard lookup table', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetSupplementDagrun' => [ - 'summary' => '获取补数据工作流所有业务日期的Dagrun信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandardMappingToInvalid' => [ + 'summary' => 'Sets the standard mapping relationship to invalid mapping.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'SupplementId', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '补数据工作流ID', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Update Command', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'Standard ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'GuidList' => [ + 'title' => '', + 'description' => 'GUID list, with an upper limit of 1000', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'GUID list, with an upper limit of 1000', 'type' => 'string', 'required' => false, 'example' => '1022'], + 'required' => false, + 'example' => '', + ], + 'BelongGuidList' => [ + 'title' => '', + 'description' => 'Belonging GUID list, with an upper limit of 1000', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Belonging GUID list, with an upper limit of 1000', 'type' => 'string', 'required' => false, 'example' => '1023'], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'f_8241792_20201202_2099680', - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'DagrunList' => [ - 'title' => 'Dagrun列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'Dagrun详情', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'f_8241792_20201202_2099680', - ], - 'Duration' => [ - 'title' => '部署工作流运行时长', - 'description' => '', - 'type' => 'string', - 'example' => '60s', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend response exception details', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Set Standard Mapping Relationship to Invalid Mapping', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetPhysicalNode' => [ - 'summary' => '查询物理调度节点。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandardSet' => [ + 'summary' => 'Update standard set.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'query', - 'schema' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'n_232132', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Update command.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'StandardSetId' => ['title' => '', 'description' => 'Standard set ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'Standard set name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Code' => ['title' => '', 'description' => 'Standard set code.', 'type' => 'string', 'required' => true, 'example' => 'CITY'], + 'Description' => ['title' => '', 'description' => 'Standard set description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'DirectoryReference' => [ + 'title' => '', + 'description' => 'Parent directory.', + 'type' => 'object', + 'properties' => [ + 'Directory' => ['title' => '', 'description' => 'Directory.', 'type' => 'string', 'required' => true, 'example' => '/dir1'], + ], + 'required' => false, + 'example' => '', ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'MaintainerList' => [ + 'title' => '', + 'description' => 'Maintainers.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Maintainer.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'required' => false, + 'example' => '', ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', + 'MemberList' => [ + 'title' => '', + 'description' => 'Member list.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Member.', 'type' => 'string', 'required' => false, 'example' => '300000913'], + 'required' => false, + 'example' => '', ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'MemberGroupList' => [ + 'title' => '', + 'description' => 'Member group list.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Member group.', 'type' => 'string', 'required' => false, 'example' => '1121'], + 'required' => false, + 'example' => '', ], - 'NodeInfo' => [ - 'title' => '节点详情', - 'description' => '', + 'VisibilityConfig' => [ + 'title' => '', + 'description' => 'Visibility configuration.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_232132', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '节点描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OperatorType' => [ - 'title' => '节点子类型', - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'ScheduleType' => [ - 'title' => '调度周期类型'."\n" - .'MINUTELY'."\n" - .'HOURLY'."\n" - .'DAILY'."\n" - .'WEEKLY'."\n" - .'MONTHLY'."\n" - .'QUARTERLY', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'Priority' => [ - 'title' => '调度优先级'."\n" - .'HIGHEST'."\n" - .'HIGH'."\n" - .'MIDDLE'."\n" - .'LOW'."\n" - .'LOWEST', - 'description' => '', - 'type' => 'string', - 'example' => 'MIDDLE', - ], - 'ProjectInfo' => [ - 'title' => '节点归属项目', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => '102132', - ], - 'Name' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Creator' => [ - 'title' => '节点创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '101312', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Owner' => [ - 'title' => '节点负责人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '101312', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Modifier' => [ - 'title' => '更新人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '101312', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717343597000', - ], - 'LastModifiedTime' => [ - 'title' => '最新1次更新时间', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'CronExpression' => [ - 'title' => 'cron表达式，用于计算调起时间', - 'description' => '', - 'type' => 'string', - 'example' => '0 0 10 * * *', - ], - 'OutputNameList' => [ - 'title' => '输出名列表', - 'description' => '', + 'Type' => ['title' => '', 'description' => 'Visibility type. Valid values: PUBLIC (public access), PRIVATE (private access, visible only to standard set members and administrators), and SPECIFIED (visible to specified users).', 'type' => 'string', 'required' => true, 'example' => 'PUBLIC'], + 'SpecifiedUserList' => [ + 'title' => '', + 'description' => 'List of specified visible users. This parameter takes effect only when the visibility type is set to SPECIFIED.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxtest', - ], - ], - 'DataSourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789', - ], - 'DataSourceSchema' => [ - 'title' => '数据源SCHEMA', - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'items' => ['title' => '', 'description' => 'Specified visible user. This parameter takes effect only when the visibility type is set to SPECIFIED.', 'type' => 'string', 'required' => false, 'example' => '1121'], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'example' => '', + ], + 'ApprovalConfig' => [ + 'title' => '', + 'description' => 'Publishing approval configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Specifies whether to enable approval.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Specifies whether to submit approvals in batch.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'Approval process type. Valid values: BY_DEFAULT (default approval type) and BY_TEMPLATE (template-based approval).', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'Approval template ID. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + ], + 'required' => false, + 'example' => '', + ], + 'OfflineApprovalConfig' => [ + 'title' => '', + 'description' => 'Unpublishing approval configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableApproval' => ['title' => '', 'description' => 'Specifies whether to enable approval.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'IsSubmitInBatch' => ['title' => '', 'description' => 'Specifies whether to submit approvals in batch.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'ApprovalType' => ['title' => '', 'description' => 'Approval process type. Valid values: BY_DEFAULT (default approval type) and BY_TEMPLATE (template-based approval).', 'type' => 'string', 'required' => true, 'example' => 'BY_DEFAULT'], + 'TemplateId' => ['title' => '', 'description' => 'Approval template ID. This parameter takes effect only when the approval process type is set to BY_TEMPLATE.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + ], + 'required' => false, + 'example' => '', ], + 'DefaultStandardTemplateId' => ['title' => '', 'description' => 'Default standard template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, '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.', - ], - ], - 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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'query', - 'schema' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', 'required' => true, - 'example' => 'n_232411', - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'title' => '节点信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_232411', - ], - 'NodeName' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CodeContent' => [ - 'title' => '节点代码内容', - 'description' => '', - 'type' => 'string', - 'example' => 'select 1;', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Whether the request is successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Backend exception details.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'UpdateStandardSet', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetNodeUpDownStream' => [ - 'summary' => '通用查询节点上下游接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandardTemplate' => [ + 'summary' => 'Updates a data standard template.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'NodeId', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '节点id', - 'description' => '', + 'title' => '', + 'description' => 'The update command.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '节点id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11313', - ], - 'FieldIdList' => [ - 'title' => '当节点时逻辑表节点id时可以传，不传默认是全表', - 'description' => '', - 'type' => 'string', + 'Id' => ['title' => '', 'description' => 'The ID of the standard template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'The version number. If this parameter is left empty or set to -1, the latest version is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The name of the standard template.', 'type' => 'string', 'required' => true, 'example' => '测试模板'], + 'Code' => ['title' => '', 'description' => 'The code of the standard template. The code must be globally unique. The code cannot be modified if the template is referenced.', 'type' => 'string', 'required' => true, 'example' => 'test01'], + 'Description' => ['title' => '', 'description' => 'The description of the standard template.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'MaintainerList' => [ + 'title' => '', + 'description' => 'The list of maintainers.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of maintainers.', 'type' => 'string', 'required' => false, 'example' => '300000913'], 'required' => false, - 'example' => '12', + 'example' => '', ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '113123', - ], - ], - [ - 'name' => 'UpStreamDepth', - 'in' => 'query', - 'schema' => [ - 'title' => '上游层级，默认：1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'DownStreamDepth', - 'in' => 'query', - 'schema' => [ - 'title' => '下游层级，默认：1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEV', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'NodeDagInfo' => [ - 'title' => '节点上下游数据', - 'description' => '', + 'AttributesConfig' => [ + 'title' => '', + 'description' => 'The attribute configuration.', 'type' => 'object', 'properties' => [ - 'StartNodeList' => [ - 'title' => '中心节点 ', - 'description' => '', + 'AttributeList' => [ + 'title' => '', + 'description' => 'The list of attributes.', 'type' => 'array', 'items' => [ - 'title' => '节点', - 'description' => '', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldIdList' => [ - 'title' => '字段id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '字段ID', - 'description' => '', - 'type' => 'string', - 'example' => '123', + 'Name' => ['title' => '', 'description' => 'The attribute name. This parameter is optional when a common attribute is referenced.', 'type' => 'string', 'required' => false, 'example' => 'attr1'], + 'Code' => ['title' => '', 'description' => 'The attribute code. This parameter is optional when a common attribute is referenced.', 'type' => 'string', 'required' => false, 'example' => 'test_attr'], + 'Type' => ['title' => '', 'description' => 'The attribute type. This parameter is optional when a common attribute is referenced. Valid values:'."\n" + .'- BIZ_ATTRIBUTE: business attribute.'."\n" + .'- TECH_ATTRIBUTE: technical attribute.'."\n" + .'- MANAGEMENT_ATTRIBUTE: management attribute.'."\n" + .'- QUALITY_ATTRIBUTE: quality attribute.'."\n" + .'- MASTER_DATA_ATTRIBUTE: master data attribute.'."\n" + .'- LIFECYCLE_ATTRIBUTE: lifecycle attribute.'."\n" + .'- SECURITY_ATTRIBUTE: security attribute.', 'type' => 'string', 'required' => false, 'example' => 'BIZ_ATTRIBUTE'], + 'Required' => ['title' => '', 'description' => 'Specifies whether the attribute is required. This parameter is optional when a common attribute is referenced.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The value configuration. This parameter is optional when a common attribute is referenced.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value type. Valid values:'."\n" + .'- CUSTOMIZED: custom input.'."\n" + .'- SINGLE_ENUM: single enumeration value.'."\n" + .'- MULTIPLE_ENUMS: multiple enumeration values.'."\n" + .'- RANGE: range value.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The data type of the attribute value. Valid values:'."\n" + .'- STRING: string.'."\n" + .'- BIGINT: numeric.'."\n" + .'- DOUBLE: floating-point.'."\n" + .'- DATE: date, accurate to the day.'."\n" + .'- DATETIME: date, accurate to milliseconds.'."\n" + .'- BOOLEAN: Boolean.', 'type' => 'string', 'required' => true, 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The length of the attribute value. If this parameter is left empty or set to -1, the length is not limited. Typically, only string types have a length limit for attribute values.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'ValueRange' => [ + 'title' => '', + 'description' => 'The value range.', + 'type' => 'object', + 'properties' => [ + 'ValueConstraint' => ['title' => '', 'description' => 'The value source. Valid values:'."\n" + .'- NONE: no constraint.'."\n" + .'- LIST: obtained from a list.'."\n" + .'- LOOKUP_TABLE: lookup table.'."\n" + .'- MIN_MAX: value between the minimum and maximum.'."\n" + .'- DATAPHIN_ATTRIBUTE: Dataphin system property.'."\n" + .'- BUILT_IN_DATA_TYPES: built-in data types.'."\n" + .'- BUILT_IN_DATA_CLASSIFICATION: built-in data categorization.'."\n" + .'- BUILT_IN_DATA_LEVEL: built-in data security classification.', 'type' => 'string', 'required' => true, 'example' => 'NONE'], + 'ValueList' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to LIST.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'required' => false, + 'example' => '', + ], + 'MinMaxValueConfig' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to MIN_MAX.', + 'type' => 'object', + 'properties' => [ + 'MinValue' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'string', 'required' => true, 'example' => '0'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Specifies whether the minimum value is included.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'string', 'required' => true, 'example' => '100'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Specifies whether the maximum value is included.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'LookupTableReference' => [ + 'title' => '', + 'description' => 'The value range. This parameter takes effect when the value source is set to LOOKUP_TABLE.', + 'type' => 'object', + 'properties' => [ + 'LookupTableId' => ['title' => '', 'description' => 'The ID of the lookup table.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'Column' => ['title' => '', 'description' => 'The referenced lookup table field.', 'type' => 'string', 'required' => false, 'example' => 'col1'], + ], + 'required' => false, + 'example' => '', + ], + 'DataphinAttributeType' => ['title' => '', 'description' => 'The value range. This parameter takes effect when the value source is set to DATAPHIN_ATTRIBUTE. Valid values:'."\n" + .'- BIZ_UNIT: data board.'."\n" + .'- PROJECT: project.'."\n" + .'- USER: user.'."\n" + .'- USER_GROUP: user group.', 'type' => 'string', 'required' => false, 'example' => 'DATAPHIN_ATTRIBUTE'], + ], + 'required' => true, + 'example' => '', + ], + 'DefaultValue' => ['title' => '', 'description' => 'The default value.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], + 'required' => false, + 'example' => '', ], - ], - ], - ], - 'UpStreamNodeList' => [ - 'title' => '上游节点', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldIdList' => [ - 'title' => '字段id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '字段ID', - 'description' => '', - 'type' => 'string', - 'example' => '123', + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'RefAttribute' => [ + 'title' => '', + 'description' => 'The referenced attribute information.', + 'type' => 'object', + 'properties' => [ + 'AttributeId' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + 'AttributeFromInfo' => [ + 'title' => '', + 'description' => 'The attribute source.', + 'type' => 'object', + 'properties' => [ + 'AttributeFrom' => ['title' => '', 'description' => 'The attribute source. Valid values:'."\n" + .'- SYSTEM: system attribute.'."\n" + .'- CUSTOM: custom attribute.'."\n" + .'- STANDARD: standard.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOM'], + 'StandardReference' => [ + 'title' => '', + 'description' => 'The corresponding standard. This parameter takes effect when the attribute source is set to STANDARD.', + 'type' => 'object', + 'properties' => [ + 'StandardId' => ['title' => '', 'description' => 'The standard ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'description' => '', + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'DownStreamNodeList' => [ - 'title' => '下游节点', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '节点', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldIdList' => [ - 'title' => '字段id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '字段ID', - 'description' => '', - 'type' => 'string', - 'example' => '123', + ], + 'required' => true, + 'example' => '', + ], + 'PublishInfo' => [ + 'title' => '', + 'description' => 'The publish information of the standard template.', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['title' => '', 'description' => 'The publish comment.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'example' => '', + ], + 'CodeRuleConfig' => [ + 'title' => '', + 'description' => 'The configuration for automatic generation of standard codes.', + 'type' => 'object', + 'properties' => [ + 'GenerateType' => ['title' => '', 'description' => 'The standard code generation method. Valid values:'."\n" + .'- CUSTOMIZED: custom.'."\n" + .'- AUTO_GENERATE: automatically generated based on standard code rules.', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMIZED'], + 'AutoConfig' => [ + 'title' => '', + 'description' => 'The automatic generation configuration for standard code rules. This parameter takes effect when the generation method is set to AUTO_GENERATE.', + 'type' => 'object', + 'properties' => [ + 'NeedStrongValidate' => ['title' => '', 'description' => 'Specifies whether strict validation is required.', 'type' => 'boolean', 'required' => true, 'example' => ''], + 'CodeRuleList' => [ + 'title' => '', + 'description' => 'The standard code rules.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'The position index of the code rule.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The type of the code rule. Valid values:'."\n" + .'- FIXED_STRING: fixed string.'."\n" + .'- AUTO_INCREMENT: auto-increment sequence.'."\n" + .'- STANDARD_SET_CODE: standard set code.', 'type' => 'string', 'required' => true, 'example' => 'FIXED_STRING'], + 'Value' => ['title' => '', 'description' => 'The format or value of the code rule.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AutoIncrementSequenceConfig' => [ + 'title' => '', + 'description' => 'The auto-increment sequence configuration.', + 'type' => 'object', + 'properties' => [ + 'Digit' => ['title' => '', 'description' => 'The number of digits.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], + 'StartValue' => ['title' => '', 'description' => 'The start value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'Step' => ['title' => '', 'description' => 'The step size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'NeedPaddingZero' => ['title' => '', 'description' => 'Specifies whether to pad with zeros.', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'description' => '', + 'example' => '', ], + 'required' => true, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error details from the backend response.', 'type' => 'string', 'example' => 'internal error'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Update a data standard template', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListNodes' => [ - 'summary' => '查询调度节点列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateStandardWordRoot' => [ + 'summary' => 'Updates a data standard root word.'."\n" + .'Online version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The update instruction.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12111', - ], - 'NodeBizType' => [ - 'title' => '节点业务类型（脚本、逻辑表、萃取）：SCRIPT/LOGICAL_TABLE/ONE_ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SCRIPT', - ], - 'NodeSubBizTypeList' => [ - 'title' => '子业务类型(HIVE_SQL/HADOOP_MR/SHELL/DATAX/PYTHON等)'."\n", - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], - 'required' => true, - ], - 'SchedulePeriodList' => [ - 'title' => '调度周期（年、月、周、日、时、分）：YEARLY/MONTHLY/WEEKLY/DAILY/HOURLY/MINUTELY', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], - 'required' => false, - ], - 'OwnerList' => [ - 'title' => '负责人用户ID', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '121112', - ], - 'required' => false, - ], - 'PriorityList' => [ - 'title' => '节点优先级（最高，高，中，低，最低）：HIGHEST/HIGH/MIDDLE/LOW/LOWEST', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], - 'SearchText' => [ - 'title' => '关键词搜索：支持节点名称模糊搜索，节点id精确搜索', - 'description' => '', - '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', - ], + 'OldName' => ['title' => '', 'description' => 'The name of the root word before the update.', 'type' => 'string', 'required' => true, 'example' => '平均值'], + 'Name' => ['title' => '', 'description' => 'The name of the root word.', 'type' => 'string', 'required' => true, 'example' => '平均值'], + 'FullName' => ['title' => '', 'description' => 'The full name of the root word.', 'type' => 'string', 'required' => true, 'example' => 'average'], + 'Abbreviation' => ['title' => '', 'description' => 'The abbreviation of the root word.', 'type' => 'string', 'required' => true, 'example' => 'avg'], + 'Description' => ['title' => '', 'description' => 'The description of the root word.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '23222', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'From' => [ - 'title' => '来源', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'Creator' => [ - 'title' => '创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23222', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '1121321', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'LastModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-30 16:47:13', - ], - 'BizUnitName' => [ - 'title' => '所属业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_31111', - ], - 'Modifier' => [ - 'title' => '节点更新者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '311131', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'ExtendInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'example' => '{"xx":"zz"}', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend response exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Update a data standard root word', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'GetPhysicalNodeOperationLog' => [ - 'summary' => '查询节点的操作日志。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateTenantComputeEngine' => [ + 'summary' => 'Modifies the compute settings of a tenant.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'NodeId', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The update command.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The compute source type.', 'type' => 'string', 'required' => true, 'example' => 'MacCompute'], + 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'required' => false, 'example' => '1.0'], + 'ClusterUrlList' => [ + 'title' => '', + 'description' => 'The list of cluster node endpoints.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of cluster node endpoints.', 'type' => 'string', 'required' => true, 'example' => '10.1.11.2'], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'n_231131', + 'example' => '', ], ], - [ - 'name' => 'Env', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'PAUSE_TASK', - ], - 'Operator' => [ - 'title' => '操作人ID', - 'description' => '', - 'type' => 'string', - 'example' => '132222', - ], - 'OperationTime' => [ - 'title' => '操作时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-30 16:47:13', - ], - 'OperatorName' => [ - 'title' => '操作者名字', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Modify tenant compute settings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListNodeDownStream' => [ - 'summary' => '查询节点下游，创建补数据工作流时可以作为数据参考', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateTenantMember' => [ + 'summary' => 'Edits tenant members.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'UpdateCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询节点下游请求', - 'description' => '', + 'title' => '', + 'description' => 'The request object.', 'type' => 'object', 'properties' => [ - 'NodeIdList' => [ - 'title' => '节点列表', - 'description' => '', + 'MemberList' => [ + 'title' => '', + 'description' => 'The list of members.', 'type' => 'array', 'items' => [ - 'title' => '节点', - 'description' => '', + 'title' => '', + 'description' => 'The member object.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'n_23431', - ], - 'FieldIdList' => [ - 'title' => '字段ID列表：当节点是逻辑表节点ID时可以传，不传默认是全表', - 'description' => '', + 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '2331'], + 'MobilePhone' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13888888888'], + 'Mail' => ['title' => '', 'description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '123@xx.com'], + 'DingNumber' => ['title' => '', 'description' => 'The DingTalk number.', 'type' => 'string', 'required' => false, 'example' => '123@dingding'], + 'RoleList' => [ + 'title' => '', + 'description' => 'The list of roles.', 'type' => 'array', - 'items' => [ - 'title' => '字段ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'items' => ['title' => '', 'description' => 'The role.', 'type' => 'string', 'required' => false, 'example' => 'SECURITY_ADMIN'], 'required' => false, - 'example' => '112', + 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => true, - ], - 'DownStreamDepth' => [ - 'title' => '深度, 默认3', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'FilterList' => [ - 'title' => '过滤器', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT', - ], - 'ValueList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '102113', - ], - 'required' => false, - ], - 'Exclude' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123011', + 'example' => '', ], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'n_2423351', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'FieldIdList' => [ - 'title' => '字段id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - ], - 'Depth' => [ - 'title' => '层级', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', - ], + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Edit tenant members', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], ], - '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"}]', - ], - 'GetPhysicalNodeByOutputName' => [ - 'summary' => '根据输出名查询对应的物理节点。', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateTenantMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateUdf' => [ + 'summary' => 'Edits a user-defined function.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'OutputName', - 'in' => 'query', + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '节点输出名', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The update command.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the user-defined function.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1123'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '711833'], + 'RefResourceIdList' => [ + 'title' => '', + 'description' => 'The IDs of the referenced resources.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The IDs of the referenced resources.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10200121011'], + 'required' => true, + 'example' => '', + ], + 'ClassName' => ['title' => '', 'description' => 'The class name that implements the function in the resource.', 'type' => 'string', 'required' => true, 'example' => 'com.lydaas.SleepTest'], + 'Category' => ['title' => '', 'description' => 'The category. Valid values:'."\n" + ."\n" + .'- 1: window function'."\n" + .'- 2: aggregate function'."\n" + .'- 3: numerical function'."\n" + .'- 4: string function'."\n" + .'- 5: time function'."\n" + .'- 6: IP address utility function'."\n" + .'- 7: URL-related function'."\n" + .'- 8: encoding and decoding function'."\n" + .'- 9: business-related function'."\n" + .'- 10: other.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => true, 'example' => '测试'], + 'CommandHelp' => ['title' => '', 'description' => 'The command format for function calling to invoke.', 'type' => 'string', 'required' => true, 'example' => 'udf_sleep(100)'], + 'Comment' => ['title' => '', 'description' => 'The commit remarks.', 'type' => 'string', 'required' => true, 'example' => '测试'], + ], 'required' => true, - 'example' => 't_test', - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'NodeInfo' => [ - 'title' => '节点详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => 'n_2321', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OperatorType' => [ - 'title' => '节点子类型', - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'ScheduleType' => [ - 'title' => '调度周期类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'Priority' => [ - 'title' => '调度优先级', - 'description' => '', - 'type' => 'string', - 'example' => 'MIDDLE', - ], - 'ProjectInfo' => [ - 'title' => '节点归属项目', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1324211', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Creator' => [ - 'title' => '节点创建者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1311131', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Owner' => [ - 'title' => '节点负责人', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1311131', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Modifier' => [ - 'title' => '节点修改者', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1311131', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\"\\n}","type":"json"}]', + 'title' => 'Edit a user-defined function', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateUserGroup' => [ + 'summary' => 'Edits a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpdateCommand', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The command to edit the user group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the user group.', 'type' => 'string', 'required' => true, 'example' => '13423'], + 'Name' => ['title' => '', 'description' => 'The name of the user group.', 'type' => 'string', 'required' => false, 'example' => 'xx测试'], + 'Description' => ['title' => '', 'description' => 'The description of the user group.', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'AdminUserIdList' => [ + 'title' => '', + 'description' => 'The list of administrator user IDs for the user group.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of administrator user IDs for the user group.', 'type' => 'string', 'required' => false, 'example' => '2323131'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The result of the edit operation.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], ], - '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"}]', - ], - 'GetDevObjectDependency' => [ - 'summary' => '查询开发态对象上游依赖。', - 'methods' => [ - 'post', + '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' => 'Update a user group', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateUserGroupSwitch' => [ + 'summary' => 'Modifies the enabled status of a user group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ObjectId', + 'name' => 'UserGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '开发对象id, 对于逻辑表需要传入模型id，对于其他任务需要传入FileId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7026498387616064', - ], + 'schema' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => '31323'], ], [ - 'name' => 'ObjectType', + 'name' => 'Active', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the user group.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '开发对象类型. 任务FileId:FILE_ID, 逻辑表：MODEL_ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '7026498387616064', + 'title' => '', + 'description' => 'The response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned by the backend.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The error code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['title' => '', 'description' => 'The edit result.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ], + 403 => [ + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + 406 => [ + ['errorCode' => 'DataphinOpenApiNotAcceptable', 'errorMessage' => 'Request not acceptable, may exceed quota limit.', 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ], + ], + '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' => 'Modify the enabled status of a user group', + 'changeSet' => [ + ['createdAt' => '2025-02-17T08:18:49.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ObjectFrom', - 'in' => 'query', - 'schema' => [ - 'title' => '开发对象来源. BLACK_BOX: 逻辑表；DATA_PROCESS：计算任务；PIPELINE：集成任务', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DATA_PROCESS', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateUserGroupSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpsertQualityRule' => [ + 'summary' => 'Create or modify a quality rule.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7021037162911616L', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OpTenantId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], + ], + [ + 'name' => 'UpsertCommand', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'The upsert command.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', + 'Id' => ['title' => '', 'description' => 'Rule ID. A non-empty value indicates a modification, and an empty value indicates a creation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11'], + 'Name' => ['title' => '', 'description' => 'The name of the quality rule.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Description' => ['title' => '', 'description' => 'The description of the quality rule.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Strength' => ['title' => '', 'description' => 'The rule strength. Valid values: STRONG, WEAK.', 'type' => 'string', 'required' => true, 'example' => 'STRONG'], + 'CatalogList' => [ + 'title' => '', + 'description' => 'The rule category. Valid values: CONSISTENT (Consistency), EFFECTIVE (Effectiveness), TIMELINESE (Timeliness), ACCURATE (Accuracy), UNIQUENESS (Uniqueness), COMPLETENESS (Completeness), STABILITY (Stability), CUSTOM (Custom).', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The rule category. Valid values: CONSISTENT (Consistency), EFFECTIVE (Effectiveness), TIMELINESE (Timeliness), ACCURATE (Accuracy), UNIQUENESS (Uniqueness), COMPLETENESS (Completeness), STABILITY (Stability), CUSTOM (Custom).', 'type' => 'string', 'required' => true, 'example' => 'CONSISTENT'], + 'required' => true, + 'example' => '', ], - 'DevObjectDependencyList' => [ - 'title' => '依赖列表', - 'description' => '', + 'TemplateType' => ['title' => '', 'description' => 'The template type. Valid values:'."\n" + .' - FIELD_NULL_VALUE_VALIDATE: Field null value validation'."\n" + .' - FIELD_EMPTY_STRING_VALIDATE: Field empty string validation'."\n" + .' - FIELD_UNIQUE_VALIDATE: Field uniqueness validation'."\n" + .' - FIELD_GROUP_COUNT_VALIDATE: Field unique value count validation'."\n" + .' - FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: Field duplicate value count validation'."\n" + .' - FUNCTION_TIME_COMPARE: Time function comparison'."\n" + .' - SINGLE_TABLE_TIME_COMPARE: Single-table time field comparison'."\n" + .' - DOUBLE_TABLE_TIME_COMPARE: Cross-table time field comparison'."\n" + .' - FIELD_FORMAT_VALIDATE: Field format validation'."\n" + .' - FIELD_LENGTH_VALIDATE: Field length validation'."\n" + .' - FIELD_VALUE_RANGE_VALIDATE: Field value range validation'."\n" + .' - CODE_TABLE_COMPARE: Code table reference comparison'."\n" + .' - STANDARD_CODE_TABLE_COMPARE: Data standard code table reference comparison'."\n" + .' - SINGLE_TABLE_FIELD_VALUE_COMPARE: Single-table field value consistency comparison'."\n" + .' - SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: Single-table field statistical value consistency comparison'."\n" + .' - SINGLE_TABLE_FIELD_EXP_COMPARE: Single-table field business logic consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_VALUE_COMPARE: Cross-table field value consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: Cross-table field statistical value consistency comparison'."\n" + .' - CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: Cross-source cross-table field statistical value consistency comparison'."\n" + .' - DOUBLE_TABLE_FIELD_EXP_COMPARE: Cross-table field business logic consistency comparison'."\n" + .' - TABLE_STABILITY_VALIDATE: Table stability validation'."\n" + .' - TABLE_FLUCTUATION_VALIDATE: Table fluctuation validation'."\n" + .' - FIELD_STABILITY_VALIDATE: Field stability validation'."\n" + .' - FIELD_FLUCTUATION_VALIDATE: Field fluctuation validation'."\n" + .' - CUSTOM_STATISTICAL_VALIDATE: Custom statistical metric validation'."\n" + .' - CUSTOM_DATA_DETAILS_VALIDATE: Custom data details validation'."\n" + .' - DATASOURCE_AVAILABLE_CHECK: Data source connectivity check'."\n" + .' - TABLE_SCHEMA_CHECK: Table schema change monitoring'."\n" + .' - REAL_TIME_OFFLINE_COMPARE: Real-time offline comparison'."\n" + .' - REAL_TIME_STATISTICAL_VALIDATE: Real-time statistical value monitoring'."\n" + .' - REAL_TIME_MULTI_CHAIN_COMPARE: Real-time multi-chain comparison, etc.', 'type' => 'string', 'required' => true, 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'WatchId' => ['title' => '', 'description' => 'The ID of the associated monitor.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'EnableErrorArchive' => ['title' => '', 'description' => 'Specifies whether to enable error archiving.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'ValidateConditionList' => [ + 'title' => '', + 'description' => 'The validation conditions.', 'type' => 'array', 'items' => [ - 'title' => '依赖', - 'description' => '', + 'title' => '', 'type' => 'object', 'properties' => [ - 'ScheduleType' => [ - 'title' => '调度类型'."\n" - .'MINUTELY: 分钟,HOURLY: 小时,DAILY: 天,WEEKLY: 周,MONTHLY: 月,YEARLY: 年', - 'description' => '', - 'type' => 'string', - 'example' => 'DAILY', - ], - 'NodeName' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'NodeOutputTableName' => [ - 'title' => '输出表信息 ', - 'description' => '', - 'type' => 'string', - 'example' => 't_xx', - ], - 'DependencyPeriod' => [ - 'title' => '依赖周期配置', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'The ID of the condition node.', 'type' => 'string', 'required' => false, 'example' => '268'], + 'Type' => ['title' => '', 'description' => 'The condition type. Valid values: RELATION, EXPRESSION.', 'type' => 'string', 'required' => false, 'example' => 'RELATION'], + 'Operator' => ['title' => '', 'description' => 'The operator. Valid values: EQUAL, NOT_EQUAL, LARGER, SMALLER, LARGE_OR_EQUAL, SMALLER_OR_EQUAL, AND, OR.', 'type' => 'string', 'required' => false, 'example' => 'AND'], + 'Metric' => ['title' => '', 'description' => 'The metric.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Value' => ['title' => '', 'description' => 'The value.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ParentId' => ['title' => '', 'description' => 'The ID of the parent condition node.', 'type' => 'string', 'required' => false, 'example' => '123'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'The rule configuration key-value pairs. The configuration varies based on the template type. Different template types return different form key-value pair configurations.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['title' => '', 'description' => 'The component type.', 'type' => 'string', 'required' => false, 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'The property name.', 'type' => 'string', 'required' => false, 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'The property value.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'AttributeWithValueList' => [ + 'title' => '', + 'description' => 'The rule business attribute configuration.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'AttributeInfo' => [ + 'title' => '', + 'description' => 'The attribute details.', 'type' => 'object', 'properties' => [ - 'PeriodType' => [ - 'title' => '依赖周期类型：CURRENT_PERIOD,LAST_PERIOD,LAST_N_PERIOD,LAST_24_HOUR', - 'description' => '', - 'type' => 'string', - 'example' => 'CURRENT_PERIOD', - ], - 'PeriodOffset' => [ - 'title' => '周期偏移量，dependencyPeriodType=LAST_N_PERIOD时须传值'."\n", - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '13111', - ], - 'CustomCronExpression' => [ - 'title' => '是否自定义调度节点表达式', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DependencyStrategy' => [ - 'title' => '依赖策略：ALL,FIRST,LAST,NEAR'."\n", - 'description' => '', - 'type' => 'string', - 'example' => 'ALL', - ], - 'BizUnitName' => [ - 'title' => '业务板块名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'DimMidNode' => [ - 'title' => '是否是维度表中间节点', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123131', - ], - 'BizType' => [ - 'title' => '业务类型：'."\n" - .'SCRIPT: 脚本，LOGICAL_TABLE：逻辑表', - 'description' => '', - 'type' => 'string', - 'example' => 'SCRIPT', - ], - 'OwnerList' => [ - 'title' => '节点负责人', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'example' => '11123', - ], - 'Name' => [ - 'title' => '节点名称', - 'description' => '', - 'type' => 'string', - 'example' => '', + 'Id' => ['title' => '', 'description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '711484689131'], + 'Name' => ['title' => '', 'description' => 'The attribute name.', 'type' => 'string', 'required' => false, 'example' => 'attr01'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Enabled' => ['title' => '', 'description' => 'Specifies whether to enable the attribute.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Required' => ['title' => '', 'description' => 'Specifies whether the attribute is required.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'Searchable' => ['title' => '', 'description' => 'Specifies whether the attribute is searchable.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'ValueConfig' => [ + 'title' => '', + 'description' => 'The attribute value configuration details.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The attribute value input method. Valid values: CUSTOMIZED (Custom input), SINGLE_ENUM (Single-select dropdown), MULTIPLE_ENUMS (Multi-select dropdown), RANGE (Range interval).', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMIZED'], + 'DataType' => ['title' => '', 'description' => 'The attribute field type. Valid values: STRING (Text), BIGINT (Integer), DOUBLE (Floating-point), BOOLEAN (Boolean), DATE (Date), DATETIME (Datetime).', 'type' => 'string', 'required' => false, 'example' => 'STRING'], + 'Length' => ['title' => '', 'description' => 'The attribute field length. Used to constrain the maximum length of text-type attribute values.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '986992'], + 'ValueEnumList' => [ + 'title' => '', + 'description' => 'The attribute option values. Only applicable to attributes with the single-select dropdown or multi-select dropdown input method.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute option values. Only applicable to attributes with the single-select dropdown or multi-select dropdown input method.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', + ], + 'DefaultValue' => [ + 'title' => '', + 'description' => 'The attribute default value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The attribute value list. Applicable to attributes with the custom input, single-select dropdown, or multi-select dropdown input method.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute value list. Applicable to attributes with the custom input, single-select dropdown, or multi-select dropdown input method.', 'type' => 'string', 'required' => false, 'example' => '123'], + 'required' => false, + 'example' => '', + ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. Applicable to range interval attributes.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Specifies whether to include the minimum value.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. Applicable to range interval attributes.', 'type' => 'string', 'required' => false, 'example' => '11'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Specifies whether to include the maximum value.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'example' => '', ], ], - ], - 'SelfDepend' => [ - 'title' => '是否自依赖', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DependFieldList' => [ - 'title' => '依赖字段', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '121', - ], - ], - 'ExternalBizInfo' => [ - 'title' => '额外业务信息', - 'description' => '', - 'type' => 'string', + 'required' => false, 'example' => '', ], - 'PeriodDiff' => [ - 'title' => '依赖周期差', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'title' => '配置是否生效', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeType' => [ - 'title' => '节点类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_PROCESS', - ], - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - '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', - ], + 'AttributeValue' => [ + 'title' => '', + 'description' => 'The attribute value.', + 'type' => 'object', + 'properties' => [ + 'ValueList' => [ + 'title' => '', + 'description' => 'The attribute value list. Applicable to attributes with the custom input, single-select dropdown, or multi-select dropdown input method.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute value list. Applicable to attributes with the custom input, single-select dropdown, or multi-select dropdown input method.', 'type' => 'string', 'required' => false, 'example' => '123'], + 'required' => false, + 'example' => '', ], + 'MinValue' => ['title' => '', 'description' => 'The minimum value. Applicable to range interval attributes.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'IncludeMinValue' => ['title' => '', 'description' => 'Specifies whether to include the minimum value.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value. Applicable to range interval attributes.', 'type' => 'string', 'required' => false, 'example' => '11'], + 'IncludeMaxValue' => ['title' => '', 'description' => 'Specifies whether to include the maximum value.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], - ], - 'AutoParse' => [ - 'title' => '任务是否自动解析 ', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'description' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create or modify a quality rule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ResumePhysicalNode' => [ - 'summary' => '恢复物理节点调度。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpsertQualitySchedule' => [ + 'summary' => 'Creates or updates scheduling settings.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -60269,175 +41076,118 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ResumeCommand', + 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '恢复调度请求', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '102011', + 'title' => '', + 'description' => 'The update instruction.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the schedule resource. If specified, the operation updates the existing resource. If not specified, the operation creates a new resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'], + 'Name' => ['title' => '', 'description' => 'The name of the schedule resource.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'The scheduling type. Valid values:'."\n" + .'- PERIOD_SCHEDULE: timed scheduling.'."\n" + .'- MANUAL_SCHEDULE: manual trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- DEPENDENCY_SCHEDULE: dependency scheduling.', 'type' => 'string', 'required' => true, 'example' => 'PERIOD_SCHEDULE'], + 'PartitionType' => ['title' => '', 'description' => 'The partition type. Valid values:'."\n" + .'- EVERY_DAY: every day.'."\n" + .'- PRE_DAY: previous day.'."\n" + .'- TODAY: current day.'."\n" + .'- FIRST_DAY_OF_WEEK: first day of the week (Sunday).'."\n" + .'- CUSTOM: custom.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOM'], + 'PartitionExpression' => ['title' => '', 'description' => 'The partition expression for custom expressions.', 'type' => 'string', 'required' => false, 'example' => 'ds=${yyyyMMdd}'], + 'TriggerNodeList' => [ + 'title' => '', + 'description' => 'The checklist of trigger nodes for trigger scheduling.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The checklist of trigger nodes for trigger scheduling.', 'type' => 'string', 'required' => false, 'example' => 'n_1121'], + 'required' => false, + 'example' => '', ], - 'NodeIdList' => [ - 'title' => '节点ID列表', - 'description' => '', + 'StaticTaskTriggerType' => ['title' => '', 'description' => 'The trigger method for fixed task triggers. Valid values:'."\n" + .'- ALL_TASKS_FINISHED'."\n" + .'- ONE_TASKS_FINISHED'."\n" + .'- PRE_ONE_TASKS_START.', 'type' => 'string', 'required' => false, 'example' => 'ONE_TASKS_FINISHED'], + 'TriggerType' => ['title' => '', 'description' => 'The trigger method for trigger scheduling. Valid values:'."\n" + .'- STATIC_TASK_TRIGGER: fixed task trigger.'."\n" + .'- CODE_CHECK_TRIGGER: code check trigger.', 'type' => 'string', 'required' => false, 'example' => 'STATIC_TASK_TRIGGER'], + 'PeriodScheduleIntervalType' => ['title' => '', 'description' => 'The scheduling interval type for timed scheduling. Valid values:'."\n" + .'- DAILY: day.'."\n" + .'- WEEKLY: week.'."\n" + .'- MONTHLY: month.'."\n" + .'- HOURLY: hour.'."\n" + .'- MINUTELY: minute.', 'type' => 'string', 'required' => false, 'example' => 'DAILY'], + 'PeriodScheduleParamList' => [ + 'title' => '', + 'description' => 'The scheduling interval values for timed scheduling.', 'type' => 'array', - 'items' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30132', - ], - 'required' => true, + 'items' => ['title' => '', 'description' => 'The scheduling interval values for timed scheduling.', 'type' => 'string', 'required' => false, 'example' => 'DAILY'], + 'required' => false, + 'example' => '', ], + 'CronExpression' => ['title' => '', 'description' => 'The cron expression for timed scheduling.', 'type' => 'string', 'required' => false, 'example' => '* * 1/* * * *'], + 'ValidatePartitionType' => ['title' => '', 'description' => 'The validation scope. Valid values:'."\n" + .'- TASK_REFERRED_PARTITION: task update partition.'."\n" + .'- USER_DEFINED_PARTITION: custom partition.', 'type' => 'string', 'required' => false, 'example' => 'TASK_REFERRED_PARTITION'], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'n_123456', - ], - 'Status' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'ErrorMessage' => [ - 'title' => '操作失败时，异常信息提示', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The ID of the schedule resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create or update scheduling settings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ExecuteManualNode' => [ - 'summary' => '运行手动调度节点。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpsertQualityTemplate' => [ + 'summary' => 'Creates or updates a quality template.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -60445,8888 +41195,2085 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ExecuteCommand', + 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '运行手动任务请求', - 'description' => '', + 'title' => '', + 'description' => 'Upsert command.', 'type' => 'object', 'properties' => [ - 'NodeId' => [ - 'title' => '节点ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'n_12132', - ], - 'FlowName' => [ - 'title' => '工作流名字', - 'description' => '', - 'type' => 'string', + 'Id' => ['title' => '', 'description' => 'Template ID. If specified, it indicates an update operation. If not specified, it indicates a creation operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'Template name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'Type' => ['title' => '', 'description' => 'Template type. Valid values: FIELD_NULL_VALUE_VALIDATE: field null value validation. FIELD_EMPTY_STRING_VALIDATE: field empty string validation. FIELD_UNIQUE_VALIDATE: field uniqueness validation. FIELD_GROUP_COUNT_VALIDATE: field unique value count validation. FIELD_DUPLICATE_VALUE_COUNT_VALIDATE: field duplicate value count validation. FUNCTION_TIME_COMPARE: time function comparison. SINGLE_TABLE_TIME_COMPARE: single-table time field comparison. DOUBLE_TABLE_TIME_COMPARE: cross-table time field comparison. FIELD_FORMAT_VALIDATE: field format validation. FIELD_LENGTH_VALIDATE: field length validation. FIELD_VALUE_RANGE_VALIDATE: field value range validation. CODE_TABLE_COMPARE: code table reference comparison. STANDARD_CODE_TABLE_COMPARE: data standard code table reference comparison. SINGLE_TABLE_FIELD_VALUE_COMPARE: single-table field value consistency comparison. SINGLE_TABLE_FIELD_STATISTICAL_COMPARE: single-table field statistical value consistency comparison. SINGLE_TABLE_FIELD_EXP_COMPARE: single-table field business logic consistency comparison. DOUBLE_TABLE_FIELD_VALUE_COMPARE: cross-table field value consistency comparison. DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-table field statistical value consistency comparison. CROSS_DOUBLE_TABLE_FIELD_STATISTICAL_COMPARE: cross-source cross-table field statistical value consistency comparison. DOUBLE_TABLE_FIELD_EXP_COMPARE: cross-table field business logic consistency comparison. TABLE_STABILITY_VALIDATE: table stability validation. TABLE_FLUCTUATION_VALIDATE: table fluctuation validation. FIELD_STABILITY_VALIDATE: field stability validation. FIELD_FLUCTUATION_VALIDATE: field fluctuation validation. CUSTOM_STATISTICAL_VALIDATE: custom statistical metric validation. CUSTOM_DATA_DETAILS_VALIDATE: custom data details validation. DATASOURCE_AVAILABLE_CHECK: data source connectivity check. TABLE_SCHEMA_CHECK: table schema change detection. REAL_TIME_OFFLINE_COMPARE: real-time and offline comparison. REAL_TIME_STATISTICAL_VALIDATE: real-time statistical value monitoring. REAL_TIME_MULTI_CHAIN_COMPARE: real-time multi-chain comparison.', 'type' => 'string', 'required' => true, 'example' => 'FIELD_NULL_VALUE_VALIDATE'], + 'Description' => ['title' => '', 'description' => 'Template description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Owner' => ['title' => '', 'description' => 'Template owner ID.', 'type' => 'string', 'required' => true, 'example' => '30012011'], + 'Catalog' => ['title' => '', 'description' => 'Template category. Valid values: CONSISTENT: consistency. EFFECTIVE: validity. TIMELINESE: timeliness. ACCURATE: accuracy. UNIQUENESS: uniqueness. COMPLETENESS: completeness. STABILITY: stability. CUSTOM: custom.', 'type' => 'string', 'required' => true, 'example' => 'CONSISTENT'], + 'SupportDataSourceTypeList' => [ + 'title' => '', + 'description' => 'Supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Supported data source types, such as MySQL, Oracle, Microsoft SQL Server, MaxCompute, and Hive.', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], 'required' => false, - 'example' => 'xx测试', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - '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', + 'example' => '', ], - 'ParamList' => [ - 'title' => '运行参数', - 'description' => '', + 'FormPropertyList' => [ + 'title' => '', + 'description' => 'Rule configuration key-value pairs.', 'type' => 'array', 'items' => [ - 'title' => '运行参数', - 'description' => '', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '参数', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'param1', - ], - 'Value' => [ - 'title' => '参数值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'ComponentType' => ['title' => '', 'description' => 'Component type.', 'type' => 'string', 'required' => false, 'example' => 'expression'], + 'Name' => ['title' => '', 'description' => 'Property name.', 'type' => 'string', 'required' => false, 'example' => 'col'], + 'Value' => ['title' => '', 'description' => 'Property value.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], 'required' => false, + 'description' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], 'required' => true, - ], - ], - [ - 'name' => 'Env', - 'in' => 'query', - 'schema' => [ - 'title' => '环境标识'."\n" - .'DEV：开发环境 '."\n" - .'PROD（默认）：生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'FlowId' => [ - 'title' => '工作流ID', - 'description' => '', - 'type' => 'string', - 'example' => 'f_1231_121324', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'Template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create or Update a Quality Template', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListAlertNotifications' => [ - 'summary' => '根据条件查询多个推送记录', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpsertQualityWatch' => [ + 'summary' => 'Creates or updates a quality monitored object. You can add multiple types of quality monitored objects, including Dataphin tables, global tables, data sources, metrics, and real-time meta tables.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询条件', - 'description' => '', + 'title' => '', + 'description' => 'The update instruction.', 'type' => 'object', 'properties' => [ - 'UserIdList' => [ - 'title' => '推送接收人id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '推送接收人id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SMS', - ], - 'required' => false, - ], - 'CustomChannelIdList' => [ - 'title' => '自定义消息渠道id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '自定义消息渠道id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'required' => false, - ], - 'StatusList' => [ - 'title' => '推送状态列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '推送状态：'."\n" - .'- SUCCESS：发送成功'."\n" - .'- FAILED：发送失败'."\n" - .'- SENDING：发送中', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', + 'Id' => ['title' => '', 'description' => 'The monitored object ID. If this parameter is specified, the object is updated. If this parameter is not specified, a new object is created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The monitored object type. Valid values:'."\n" + .'- TABLE: Dataphin table.'."\n" + .'- DATASOURCE_TABLE: global table.'."\n" + .'- DATASOURCE: data source.'."\n" + .'- INDEX: metric.'."\n" + .'- REALTIME_LOGICAL_TABLE: real-time meta table.', 'type' => 'string', 'required' => true, 'example' => 'TABLE'], + 'DataSourceInfo' => [ + 'title' => '', + 'description' => 'The data source details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The data source ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VDM_BATCH_FINISH', + 'TableInfo' => [ + 'title' => '', + 'description' => 'The monitored table object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => false, + 'example' => '', ], - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ALL', - ], - 'MonitoredItemIdList' => [ - 'title' => '监控项id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '监控项id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', + 'IndexInfo' => [ + 'title' => '', + 'description' => 'The monitoring metrics object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The metric ID.', 'type' => 'string', 'required' => false, 'example' => '11'], + 'Name' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'test_idx_'], + 'DisplayName' => ['title' => '', 'description' => 'The metric display name.', 'type' => 'string', 'required' => false, 'example' => 'logic'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'GranularityId' => ['title' => '', 'description' => 'The statistical granularity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '18755764'], + 'GranularityDisplayName' => ['title' => '', 'description' => 'The statistical granularity name.', 'type' => 'string', 'required' => false, 'example' => '全站汇总表'], + 'ComputeType' => ['title' => '', 'description' => 'The metric computation type. Valid values:'."\n" + .'- AUTO'."\n" + .'- CUSTOM'."\n" + .'- MOUNT'."\n" + .'- COMBINE.', 'type' => 'string', 'required' => false, 'example' => 'AUTO'], + 'CellSumLogicTableName' => ['title' => '', 'description' => 'The cell aggregate table name.', 'type' => 'string', 'required' => false, 'example' => 'dws_all'], + 'Type' => ['title' => '', 'description' => 'The metric type. Valid values:'."\n" + .'- INDEX.', 'type' => 'string', 'required' => false, 'example' => 'INDEX'], + 'BizUnitId' => ['title' => '', 'description' => 'The business unit ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1121'], + 'DateType' => ['title' => '', 'description' => 'The metric data type.', 'type' => 'string', 'required' => false, 'example' => 'bigint'], ], 'required' => false, + 'example' => '', ], - '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', - ], + 'QualityOwner' => ['title' => '', 'description' => 'The quality owner.', 'type' => 'string', 'required' => true, 'example' => '30001011'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SMS', - ], - 'CustomAlertChannelId' => [ - 'title' => '自定义消息消息渠道id', - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'Type' => [ - 'title' => '告警接收人类型：'."\n" - .'- ON_CALL_TABLE：值班表'."\n" - .'- USER_DEFINED：自定义用户'."\n" - .'- OWNER：负责人', - 'description' => '', - 'type' => 'string', - 'example' => 'OWNER', - ], - 'User' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '告警接收人姓名', - 'description' => '', - 'type' => 'string', - 'example' => 'ADMIN', - ], - ], - ], - 'OnCallTableId' => [ - 'title' => '值班表id', - 'description' => '', - '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' => '', - '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', - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The backend exception details.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The monitored object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You 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.', - ], + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Create or update a quality monitoring object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], ], - 'ListAlertEvents' => [ - 'summary' => '根据条件查询多个告警事件', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpsertQualityWatchAlert' => [ + 'summary' => 'Creates or updates alert settings for a monitored object.'."\n" + .'Release version: v5.4.2.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'OpTenantId', 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30001011'], ], [ - 'name' => 'ListQuery', + 'name' => 'UpsertCommand', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '查询请求', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserIdList' => [ - 'title' => '告警接口人id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '告警接口人id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ALL', - ], - 'MonitoredItemIdList' => [ - 'title' => '监控项id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '监控项id', - 'description' => '', - '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' => '', + 'title' => '', + 'description' => 'The update instruction.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'ListResult' => [ - 'title' => '查询结果', - 'description' => '', + 'WatchId' => ['title' => '', 'description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'], + 'QualityAlertInfo' => [ + 'title' => '', + 'description' => 'The alert configuration details.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'AlertUserChannelList' => [ + 'title' => '', + 'description' => 'The alert channels for users.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert channels for users.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', ], - 'Data' => [ - 'title' => '告警事件查询结果', - 'description' => '', + 'AlertUserList' => [ + 'title' => '', + 'description' => 'The list of users to receive alerts.', 'type' => 'array', 'items' => [ - 'title' => '告警事件信息', - 'description' => '', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '告警事件id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SMS', - ], - ], - 'CustomAlertChannelIdList' => [ - 'title' => '自定义告警渠道id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '自定义告警渠道id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'AlertFrequency' => [ - 'title' => '告警频率', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'ObjectUrl' => [ - 'title' => '告警对象页面url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test1', - ], - 'LogUrl' => [ - 'title' => '日志页面url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test2', - ], - 'AlertConfigUrl' => [ - 'title' => '告警配置页面url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test3', - ], - ], - ], + 'Id' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '30012011'], + 'Name' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'description' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'AlertDutyList' => [ + 'title' => '', + 'description' => 'The list of on-duty schedules for alerts.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the on-duty alert schedule.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The name of the on-duty alert schedule.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], + 'required' => false, + 'description' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', + ], + 'AlertDutyChannelList' => [ + 'title' => '', + 'description' => 'The alert channels for on-duty schedules.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert channels for on-duty schedules.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', + ], + 'EnableAlertQualityOwner' => ['title' => '', 'description' => 'Specifies whether to enable alerts for the quality owner.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'AlertQualityOwnerChannelList' => [ + 'title' => '', + 'description' => 'The alert channels for the quality owner.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The alert channels for the quality owner.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', ], ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The backend response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The details of the backend exception.', 'type' => 'string', 'example' => 'internal error'], + 'Data' => ['title' => '', 'description' => 'The request result.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', - ], + ['errorCode' => 'DataphinOpenAPIRamUnAuthorized', 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], ], 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ['errorCode' => 'DataphinOpenApiForbidden', 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82E78D6B-AA8F-1FEF-8AA3-5C9DA2A79140\\",\\n \\"Success\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"internal error\\",\\n \\"Data\\": false\\n}","type":"json"}]', + 'title' => 'Create or update alert settings for a monitored object', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataphin-public.cn-beijing.aliyuncs.com', 'endpoint' => 'dataphin-public.cn-beijing.aliyuncs.com', 'vpc' => 'dataphin-public-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataphin-public.cn-chengdu.aliyuncs.com', 'endpoint' => 'dataphin-public.cn-chengdu.aliyuncs.com', 'vpc' => 'dataphin-public-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataphin-public.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dataphin-public.cn-hangzhou.aliyuncs.com', 'vpc' => 'dataphin-public-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataphin-public.cn-shanghai.aliyuncs.com', 'endpoint' => 'dataphin-public.cn-shanghai.aliyuncs.com', 'vpc' => 'dataphin-public-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataphin-public.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dataphin-public.cn-shenzhen.aliyuncs.com', 'vpc' => 'dataphin-public-vpc.cn-shenzhen.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'DataphinOpenApiForbidden', 'message' => 'Openapi request is forbidden, may tenantId invalid.', 'http_code' => 403, 'description' => 'The interface request is rejected. Check whether the tenant ID is valid.'], + ['code' => 'DataphinOpenApiNotAcceptable', 'message' => 'Request not acceptable, may exceed quota limit.', 'http_code' => 406, 'description' => 'The request has been rejected. Please confirm whether the throttling is triggered.'], + ['code' => 'DataphinOpenAPIRamUnAuthorized', 'message' => 'You are not authorized to do this action, you should be authorized by RAM.', 'http_code' => 401, 'description' => 'You are not authorized to do this action, you should be authorized by RAM.'], + ['code' => 'DPNDataSourceConnectivityError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Data source connection verification failed.'], + ['code' => 'DPNDataSourceConnectivityError', 'message' => 'Error Message: %ErrorMessage.', 'http_code' => 400, 'description' => 'DataSource connection verification failed'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApplyDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceApi'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetDataServiceAppGroups'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetDataServiceAuthorizedAppsByGroupId'], + ['description' => 'Request parameters changed', 'api' => 'GrantDataServiceApi'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListApiByApp'], + ['description' => 'Request parameters changed', 'api' => 'ListAuthorizedDataServiceApiDetails'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDataServiceApiCalls'], + ['description' => 'Response parameters changed', 'api' => 'ListDataServicePublishedApis'], + ['description' => 'Response parameters changed', 'api' => 'ListRowPermission'], + ], + 'createdAt' => '2026-02-27T08:12:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'GrantDataServiceApi'], + ], + 'createdAt' => '2025-10-30T01:50:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'OperateInstance'], + ], + 'createdAt' => '2025-02-20T10:46:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateBizUnit'], + ['description' => 'Error codes changed', 'api' => 'CreateDataDomain'], + ['description' => 'Error codes changed', 'api' => 'CreateDataSource'], + ['description' => 'Error codes changed', 'api' => 'CreateDirectory'], + ['description' => 'Error codes changed', 'api' => 'CreateNodeSupplement'], + ['description' => 'Error codes changed', 'api' => 'CreatePipelineNode'], + ['description' => 'Error codes changed', 'api' => 'CreateStreamBatchJobMapping'], + ['description' => 'Error codes changed', 'api' => 'CreateUserGroup'], + ['description' => 'Error codes changed', 'api' => 'DeleteAdHocFile'], + ], + 'createdAt' => '2025-02-17T08:41:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteBatchTask'], + ['description' => 'Error codes changed', 'api' => 'DeleteBizEntity'], + ['description' => 'Error codes changed', 'api' => 'DeleteBizUnit'], + ['description' => 'Error codes changed', 'api' => 'DeleteDataDomain'], + ['description' => 'Error codes changed', 'api' => 'DeleteDataSource'], + ['description' => 'Error codes changed', 'api' => 'DeleteDirectory'], + ['description' => 'Error codes changed', 'api' => 'DeleteUserGroup'], + ['description' => 'Error codes changed', 'api' => 'ExecuteAdHocTask'], + ['description' => 'Error codes changed', 'api' => 'ExecuteManualNode'], + ], + 'createdAt' => '2025-02-17T08:40:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'FixData'], + ['description' => 'Error codes changed', 'api' => 'GetAdHocFile'], + ['description' => 'Error codes changed', 'api' => 'GetAdHocTaskLog'], + ['description' => 'Error codes changed', 'api' => 'GetAdHocTaskResult'], + ['description' => 'Error codes changed', 'api' => 'GetAlertEvent'], + ['description' => 'Error codes changed', 'api' => 'GetBatchTaskInfo'], + ['description' => 'Error codes changed', 'api' => 'GetBatchTaskInfoByVersion'], + ['description' => 'Error codes changed', 'api' => 'GetBatchTaskUdfLineages'], + ['description' => 'Error codes changed', 'api' => 'GetBatchTaskVersions'], + ['description' => 'Error codes changed', 'api' => 'GetBizEntityInfo'], + ], + 'createdAt' => '2025-02-17T08:38:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetBizUnitInfo'], + ['description' => 'Error codes changed', 'api' => 'GetClusterQueueInfoByEnv'], + ['description' => 'Error codes changed', 'api' => 'GetDataDomainInfo'], + ['description' => 'Error codes changed', 'api' => 'GetDevObjectDependency'], + ['description' => 'Error codes changed', 'api' => 'GetDirectoryTree'], + ['description' => 'Error codes changed', 'api' => 'GetInstanceDownStream'], + ['description' => 'Error codes changed', 'api' => 'GetInstanceUpDownStream'], + ['description' => 'Error codes changed', 'api' => 'GetLatestSubmitDetail'], + ['description' => 'Error codes changed', 'api' => 'GetMyRoles'], + ['description' => 'Error codes changed', 'api' => 'GetMyTenants'], + ], + 'createdAt' => '2025-02-17T08:36:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetNodeUpDownStream'], + ['description' => 'Error codes changed', 'api' => 'GetOperationSubmitStatus'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalInstance'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalInstanceLog'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalNode'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalNodeByOutputName'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalNodeContent'], + ['description' => 'Error codes changed', 'api' => 'GetPhysicalNodeOperationLog'], + ['description' => 'Error codes changed', 'api' => 'GetProjectProduceUser'], + ['description' => 'Error codes changed', 'api' => 'GetQueueEngineVersionByEnv'], + ], + 'createdAt' => '2025-02-17T08:34:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetSupplementDagrun'], + ['description' => 'Error codes changed', 'api' => 'GetSupplementDagrunInstance'], + ['description' => 'Error codes changed', 'api' => 'GetUserBySourceId'], + ['description' => 'Error codes changed', 'api' => 'GetUserGroup'], + ['description' => 'Error codes changed', 'api' => 'GetUsers'], + ['description' => 'Error codes changed', 'api' => 'GrantResourcePermission'], + ['description' => 'Error codes changed', 'api' => 'ListAddableRoles'], + ['description' => 'Error codes changed', 'api' => 'ListAddableUsers'], + ['description' => 'Error codes changed', 'api' => 'ListAlertEvents'], + ], + 'createdAt' => '2025-02-17T08:32:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListAlertNotifications'], + ['description' => 'Error codes changed', 'api' => 'ListBizEntities'], + ['description' => 'Error codes changed', 'api' => 'ListBizUnits'], + ['description' => 'Error codes changed', 'api' => 'ListDataDomains'], + ['description' => 'Error codes changed', 'api' => 'ListDataSourceWithConfig'], + ['description' => 'Error codes changed', 'api' => 'ListFiles'], + ['description' => 'Error codes changed', 'api' => 'ListInstances'], + ['description' => 'Error codes changed', 'api' => 'ListNodeDownStream'], + ['description' => 'Error codes changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-02-17T08:30:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListPublishRecords'], + ['description' => 'Error codes changed', 'api' => 'ListResourcePermissionOperationLog'], + ['description' => 'Error codes changed', 'api' => 'ListResourcePermissions'], + ['description' => 'Error codes changed', 'api' => 'ListSubmitRecords'], + ['description' => 'Error codes changed', 'api' => 'ListTenantMembers'], + ['description' => 'Error codes changed', 'api' => 'ListUserGroupMembers'], + ['description' => 'Error codes changed', 'api' => 'ListUserGroups'], + ['description' => 'Error codes changed', 'api' => 'OfflineBatchTask'], + ['description' => 'Error codes changed', 'api' => 'OfflineBizEntity'], + ], + 'createdAt' => '2025-02-17T08:26:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'OnlineBizEntity'], + ['description' => 'Error codes changed', 'api' => 'OperateInstance'], + ['description' => 'Error codes changed', 'api' => 'ParseBatchTaskDependency'], + ['description' => 'Error codes changed', 'api' => 'PausePhysicalNode'], + ['description' => 'Error codes changed', 'api' => 'PublishObjectList'], + ['description' => 'Error codes changed', 'api' => 'RemoveTenantMember'], + ['description' => 'Error codes changed', 'api' => 'RemoveUserGroupMember'], + ['description' => 'Error codes changed', 'api' => 'ResumePhysicalNode'], + ['description' => 'Error codes changed', 'api' => 'RevokeResourcePermission'], + ['description' => 'Error codes changed', 'api' => 'StopAdHocTask'], + ], + 'createdAt' => '2025-02-17T08:23:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateBizEntity'], + ['description' => 'Error codes changed', 'api' => 'UpdateBizUnit'], + ['description' => 'Error codes changed', 'api' => 'UpdateDataDomain'], + ['description' => 'Error codes changed', 'api' => 'UpdateDataSourceBasicInfo'], + ['description' => 'Error codes changed', 'api' => 'UpdateDataSourceConfig'], + ['description' => 'Error codes changed', 'api' => 'UpdateFileDirectory'], + ['description' => 'Error codes changed', 'api' => 'UpdateFileName'], + ['description' => 'Error codes changed', 'api' => 'UpdateTenantMember'], + ['description' => 'Error codes changed', 'api' => 'UpdateUserGroup'], + ['description' => 'Error codes changed', 'api' => 'UpdateUserGroupSwitch'], + ], + 'createdAt' => '2025-02-17T08:18:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddTenantMembers'], + ['description' => 'Error codes changed', 'api' => 'AddTenantMembersBySourceUser'], + ['description' => 'Error codes changed', 'api' => 'AddUserGroupMember'], + ['description' => 'Error codes changed', 'api' => 'CheckDataSourceConnectivity'], + ['description' => 'Error codes changed', 'api' => 'CheckDataSourceConnectivityById'], + ['description' => 'Error codes changed', 'api' => 'CheckResourcePermission'], + ['description' => 'Error codes changed', 'api' => 'CreateAdHocFile'], + ['description' => 'Error codes changed', 'api' => 'CreateBatchTask'], + ['description' => 'Error codes changed', 'api' => 'CreateBizEntity'], + ], + 'createdAt' => '2025-02-17T08:15:23.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'Dataphin', + 'productName' => 'Dataphin', + 'ramCodes' => ['dataphin'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetUserGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + [ + 'apiName' => 'CheckDataSourceConnectivityById', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckDataSourceConnectivityById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetSupplementDagrun', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetSupplementDagrun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'GetAlertEvent' => [ - 'summary' => '获取告警事件详情', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetSparkLocalClientInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:GetSparkLocalClientInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateFileName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateFileName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListNodes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetPhysicalInstanceLog', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'ListBizEntities', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListBizEntities', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '告警事件Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', + ], + [ + 'apiName' => 'DeleteAdHocFile', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求成功与否', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'HttpStatusCode' => [ - 'title' => '后端响应HttpCode', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码, OK表示请求正常', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '请求错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'AlertEventInfo' => [ - 'title' => '请求结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '告警事件id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SMS', - ], - ], - 'CustomAlertChannelIdList' => [ - 'title' => '自定义告警渠道id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '自定义告警渠道id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'AlertFrequency' => [ - 'title' => '告警频率：'."\n" - .'- ONCE：即时告警'."\n" - .'- PERIOD：周期告警，格式：1HOUR,1MINUTE,1SECOND', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'ObjectUrl' => [ - 'title' => '告警对象页面Url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test1', - ], - 'LogUrl' => [ - 'title' => '日志页面Url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test2', - ], - 'AlertConfigUrl' => [ - 'title' => '告警配置页面url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://dataphin.com/ops/test3', - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'UpdateDataSourceConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataSourceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'GetPhysicalNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'GetMyTenants', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetMyTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + [ + 'apiName' => 'ListResourcePermissionOperationLog', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListResourcePermissionOperationLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetDataDomainInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDataDomainInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'RevokeDataServiceApi' => [ - 'summary' => '回收API授权。', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetLatestSubmitDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetLatestSubmitDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetProjectProduceUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetProjectProduceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetClusterQueueInfoByEnv', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetClusterQueueInfoByEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateBatchTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDomains', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListDataDomains', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFiles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlertEvents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAlertEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PublishObjectList', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dataphin:PublishObjectList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'GetBatchTaskInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'OperateInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OperateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RevokeCommand', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '授权指令', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'title' => 'App的ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1203', - ], - 'ApiId' => [ - 'title' => 'Api编号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1021', - ], - 'Reason' => [ - 'title' => '申请原因', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - 'required' => true, + ], + [ + 'apiName' => 'UpdateDataDomain', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - ], + [ + 'apiName' => 'ListAlertNotifications', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAlertNotifications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'StopAdHocTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:StopAdHocTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'ListResourcePermissions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListResourcePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'OfflineBizEntity', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OfflineBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'PublishDataServiceApi' => [ - 'summary' => '发布数据服务API到生产环境。', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetBatchTaskInfoByVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskInfoByVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListDataSourceWithConfig', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListDataSourceWithConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteBatchTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteDirectory', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCatalogAssets', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:ListCatalogAssets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateBatchTaskUdfLineages', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBatchTaskUdfLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'CheckDataSourceConnectivity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckDataSourceConnectivity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'GetDirectoryTree', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDirectoryTree', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Api编码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'GetInstanceDownStream', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetInstanceDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Api 版本号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'FixData', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:FixData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '后端响应码', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '后端相应异常详情', - 'description' => '', - 'type' => 'string', - 'example' => 'internal error', - ], - ], + [ + 'apiName' => 'CreateDataDomain', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'CreateNodeSupplement', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateNodeSupplement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'GetUserBySourceId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUserBySourceId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceUpDownStream', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetInstanceUpDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListAddableUsers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAddableUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'ListDataServicePublishedApis' => [ - 'summary' => '分页查询已发布的API列表。', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateAdHocFile', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateFileDirectory', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateFileDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDataDomain', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDataDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetSupplementDagrunInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetSupplementDagrunInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNodeUpDownStream', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetNodeUpDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAdHocFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddTenantMembers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddTenantMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateUserGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNodeDownStream', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dataphin:ListNodeDownStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'UpdateTenantMember', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateTenantMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'UpdateUserGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ListQuery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '检索条件', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'title' => '分组Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '102113', - ], - 'ApiName' => [ - 'title' => 'Api名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'RemoveTenantMember', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:RemoveTenantMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => 'api分组名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Owner' => [ - 'title' => '负责人ID', - 'description' => '', - 'type' => 'string', - 'example' => '30012011', - ], - 'Description' => [ - 'title' => 'api描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test xx', - ], - 'UpdateRate' => [ - 'title' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiName' => [ - 'title' => 'api名称', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApplyStatus' => [ - 'title' => '申请状态：0 未全部申请：1 已申请、2 无app、需要先申请app', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'title' => '数据服务项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '102101', - ], - 'GroupId' => [ - 'title' => '分组id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00:00', - ], - 'Version' => [ - 'title' => 'api版本', - 'description' => '', - 'type' => 'string', - 'example' => '1.0', - ], - 'LogicUnitNo' => [ - 'title' => '服务单元编号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1022', - ], - 'AppInfoList' => [ - 'title' => '所引用的app信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'title' => '应用ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00:00', - ], - 'CreateType' => [ - 'title' => '创建类型:0自定义模式，1.向导模式，2-直连API', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiId' => [ - 'title' => 'api编码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1022', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ParseBatchTaskDependency', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:ParseBatchTaskDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'ListAuthorizedDataServiceApiDetails', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListAuthorizedDataServiceApiDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'GetQualityWatch', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQualityWatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetBatchTaskUdfLineages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskUdfLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'ListDataServiceMyAppPermissions' => [ - 'summary' => '查询当前用户有权限的应用。', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateBizEntity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CreateBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetBizEntityInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizEntityInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RevokeResourcePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:RevokeResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'GetAdHocTaskLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocTaskLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'UpdateBizEntity', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'AddTenantMembersBySourceUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddTenantMembersBySourceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => true, + ], + [ + 'apiName' => 'AddUserGroupMember', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:AddUserGroupMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'ProjectName' => [ - 'title' => '项目名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '112101', - ], - 'Creator' => [ - 'title' => '创建人ID', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'CreateUserName' => [ - 'title' => '创建人', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'AppName' => [ - 'title' => 'App名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Role' => [ - 'title' => '角色: 0 负责人', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'OwnerUserName' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CurrentUserRole' => [ - 'title' => '当前登录用户相对于这条记录的角色: SuperAdmin 当前用户是超管，ProjMan 当前用户对于这条数据是项管，NormalUser 当前用户对于这条数据是普通用户(即非超管且非项管)', - 'description' => '', - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetBizUnitInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizUnitInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'GetBizEntityInfoByVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBizEntityInfoByVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'GetPhysicalNodeByOutputName', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeByOutputName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListSubmitRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListSubmitRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'ListDataServiceMyApiPermissions' => [ - 'summary' => '获取我管理的API权限列表。', - 'methods' => [ - 'post', + [ + 'apiName' => 'ExecuteAdHocTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:ExecuteAdHocTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetPhysicalInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetPhysicalNodeOperationLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeOperationLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'OfflineBatchTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OfflineBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'SubmitBatchTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:SubmitBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Owner' => [ - 'title' => '负责人ID', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'PrivilegeBelongTo' => [ - 'title' => '权限归属人', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'ApiName' => [ - 'title' => 'API名称', - 'description' => '', - 'type' => 'string', - 'example' => 'teset', - ], - 'PrivilegeFrom' => [ - 'title' => '授权来源：0 负责人', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectName' => [ - 'title' => '项目名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '102122', - ], - 'OwnerUserName' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Creator' => [ - 'title' => '创建人ID', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'ApiId' => [ - 'title' => 'Api编号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1322', - ], - 'CreateUserName' => [ - 'title' => '创建人', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetQueueEngineVersionByEnv', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQueueEngineVersionByEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'ListBizUnits', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListBizUnits', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'DeleteDataSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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"}]', - ], - 'ListDataServiceAuthorizedApps' => [ - 'summary' => '查询当前用户有权限的应用列表。', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateBizUnit', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateUserGroupSwitch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateUserGroupSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GrantResourcePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:GrantResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListAddableRoles', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dataphin:ListAddableRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'PausePhysicalNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:PausePhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', + ], + [ + 'apiName' => 'GetAlertEvent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAlertEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'CheckResourcePermission', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckResourcePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'title' => '负责人ID', - 'description' => '', - 'type' => 'string', - 'example' => '1121', - ], - 'RealHasOwnerPrivilege' => [ - 'title' => '是否真的有这个app负责人权限（可能因为过期了或者其他情况而无权限）', - 'description' => '', - 'type' => 'boolean', - ], - 'ExpireDate' => [ - 'title' => '有效期，日期格式：yyyy-MM-dd', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30', - ], - 'ProjectName' => [ - 'title' => '项目名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '102122', - ], - 'RevocableDetail' => [ - 'title' => '这个按钮详细的状态：-1 超管不可交还，-2 负责人无法交还，-3 项管且无实际权限置灰，-4 普通用户没权限不可交还，1 项管且有实际权限可以交还，2 普通用户有权限可以交还', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'AppName' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ApplyUserId' => [ - 'title' => '权限账号ID（即申请人ID）', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => '30012101', - ], - 'ApplyUserName' => [ - 'title' => '权限账号（即申请人）', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AppId' => [ - 'title' => '应用主键id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1022', - ], - 'RealHasPrivilege' => [ - 'title' => '是否实际有权限', - 'description' => '', - 'type' => 'boolean', - ], - 'PrivilegeAccount' => [ - 'title' => '权限账号：0 个人账号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'OwnerUserName' => [ - 'title' => '负责人', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'IsProjectManager' => [ - 'title' => '当前用户是否项管', - 'description' => '', - 'type' => 'boolean', - ], - 'Id' => [ - 'title' => '申请ID', - 'description' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'ListQuery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '检索条件', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'StartTime' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - 'EndTime' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 20:00:00', - ], - 'ApiId' => [ - 'title' => '调用的apiId', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1021', - ], - 'OrderColumn' => [ - 'title' => '排序列：CALL_COUNT 调用次数、ERROR_COUNT 异常次数、ERROR_RATE 错误率; 默认：CALL_COUNT', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CALL_COUNT', - ], - 'OrderType' => [ - 'title' => '排序方式：1 顺序、2 倒序；默认：1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'AppName' => [ - 'title' => 'app名称', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'AppName' => [ - 'title' => 'app名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ErrorApiCount' => [ - 'title' => 'api调用异常数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'title' => '调用总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '88', - ], - 'LastCallTime' => [ - 'title' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00:00', - ], - 'Minute' => [ - 'title' => '网关统计时间: yyyy_MMdd_HHmm', - 'description' => '', - '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.', + [ + 'apiName' => 'GetQualityWatchTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetQualityWatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'ListQuery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '检索条件', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'ApiId' => [ - 'title' => 'api编码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20122', - ], - 'StartTime' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - 'EndTime' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 20:00:00', - ], - 'ClientIp' => [ - 'title' => 'IP地址', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'title' => '请求结束时间, 格式：yyyy-MM-dd HH:mm:ss.SSS', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ClientIp' => [ - 'title' => '请求IP', - 'description' => '', - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'AppName' => [ - 'title' => '应用名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CostTime' => [ - 'title' => '请求耗时(ms)', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201211', - ], - 'HttpStatusCode' => [ - 'title' => 'http 状态码', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'BizCodeDescription' => [ - 'title' => '业务状态码描述', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ExecuteMode' => [ - 'title' => '执行模式 1-同步 2-异步', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'JobId' => [ - 'title' => '任务ID', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1234567890-232sds-3e232-ae2e232', - ], - 'ApiName' => [ - 'title' => 'api名称', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2024-11-01 01:01:01.000', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '102356', - ], - 'Successful' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'Sql' => [ - 'title' => 'sql语句', - 'description' => '', - 'type' => 'string', - 'example' => 'select col1 from t_test1 limit 100;', - ], - 'ExecuteCostTime' => [ - 'title' => '执行耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'ApiId' => [ - 'title' => 'Api编号', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CALL_COUNT', - ], - 'OrderType' => [ - 'title' => '排序方式：1 顺序、2 倒序；默认：1', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - 'EndTime' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 20:00:00', - ], - 'PageNo' => [ - 'title' => '页码, 默认1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数, 默认20', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ApiName' => [ - 'title' => 'API名称', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1121', - ], - 'OfflineRate' => [ - 'title' => 'offline百分比', - 'description' => '', - 'type' => 'string', - 'example' => '23.2%', - ], - 'LastCallTime' => [ - 'title' => '最近调用时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30', - ], - 'Reason' => [ - 'title' => '申请原因', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'ApiId' => [ - 'title' => 'API编号', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'Api权限字段id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'DevFieldList' => [ - 'title' => 'DEV权限字段列表，dev-prod模式下才需要填，查询类API devFieldList、prodFieldList至少填写1个，操作类API无需填写', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'Api权限字段id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ApplyDev' => [ - 'title' => '是否申请操作类API的开发环境权限', - 'type' => 'boolean', - ], - 'ApplyProd' => [ - 'title' => '是否申请操作类API的生产环境权限', - 'type' => 'boolean', - ], - ], - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - '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' => '', - '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"}]', - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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"}]', - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'title' => 'App分组Id', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'title' => 'App分组Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'AppId', - 'description' => 'AppId', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1021', - ], - 'Name' => [ - 'title' => 'App名称', - '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 \\"AppInfoList\\": [\\n {\\n \\"Id\\": 1021,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '分组ID', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '分组ID', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'AppName' => [ - 'title' => 'app名称', - 'description' => '', - 'type' => 'string', - 'example' => 'app1', - ], - ], - ], - ], - 'ErrorApiList' => [ - 'title' => '异常影响API', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'title' => 'api编码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2012', - ], - 'ApiName' => [ - 'title' => 'api名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ErrorCount' => [ - 'title' => 'api异常数', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => 'Api编号', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'api名称', - 'description' => '', - 'type' => 'string', - 'example' => '测试', - ], - 'GroupId' => [ - 'title' => 'api分组Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1011', - ], - 'GroupName' => [ - 'title' => 'api分组名称', - 'description' => '', - 'type' => 'string', - 'example' => '1011', - ], - 'RequestMethod' => [ - 'title' => '请求方法: 1 get、2 list', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UpdateRate' => [ - 'title' => '更新频率: 0 自定义、1 每天、2 每小时、3 每分钟', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ReturnType' => [ - 'title' => '返回数据类型: 1 JSON', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Protocol' => [ - 'title' => '协议: 1 https、2 http、3 http和https两者', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Sql' => [ - 'title' => 'sql语句', - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'boolean', - ], - 'Sample' => [ - 'title' => '参数示例', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'title' => '前端参数名称', - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - ], - ], - 'IsSpecialSql' => [ - 'title' => '特殊sql: 0 不是、1 是', - 'description' => '', - 'type' => 'boolean', - ], - 'CreateType' => [ - 'title' => '创建类型: 0 自定义模式、1 向导模式、2-直连API', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiId' => [ - 'title' => 'Api编号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102101', - ], - 'Mode' => [ - 'title' => '模式：0 basic、1 dev_prod', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Env' => [ - 'title' => '环境：0 dev，1 prod', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DirectDatasourceName' => [ - 'title' => '直连API的数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ApiTimeout' => [ - 'title' => '直连Api超时时长(s)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'ReturnLimit' => [ - 'title' => '直连Api最大返回记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ProjectId' => [ - 'title' => '数据服务项目id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10201', - ], - 'ProjectName' => [ - 'title' => '数据服务项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceGroupId' => [ - 'title' => '资源组Id', - 'description' => '', - 'type' => 'string', - 'example' => '10021', - ], - 'ResourceGroupName' => [ - 'title' => '资源组名', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'OpenCache' => [ - 'title' => '缓存开关：0 关，1 开', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'NORMAL_SQL', - ], - 'ApiRegisterInfo' => [ - 'title' => 'Api注册信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '模式：0 basic、1 dev_prod', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HttpMethod' => [ - 'title' => '注册API请求方式：1 get、2 post', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DatasourceId' => [ - 'title' => 'API数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => '102311', - ], - 'DatasourceName' => [ - 'title' => 'API数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Url' => [ - 'title' => 'API数据源URL地址', - 'description' => '', - 'type' => 'string', - 'example' => 'http://192.168.1.1:8080', - ], - 'AuthType' => [ - 'title' => 'API数据源认证方式: 1 BearToken、2 ApiKey、3 None、4 AppKeyAuth、5 BasicAuth', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Protocol' => [ - 'title' => 'API数据源请求协议', - 'description' => '', - 'type' => 'string', - 'example' => 'https', - ], - 'Path' => [ - 'title' => '服务path', - 'description' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Minute' => [ - 'title' => '时间刻度，分钟：yyyy-MM-dd HH:mm', - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-30 08:00', - ], - 'ErrorAppCount' => [ - 'title' => '影响APP数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiIdList' => [ - 'title' => 'Api编号', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'Api编号', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '102102', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30 08:00:00', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '截止时间, 时间格式：yyyy-MM-dd HH:mm:ss', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.03', - ], - 'ErrorApiCount' => [ - 'title' => '调用异常API数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'ErrorAppCount' => [ - 'title' => '异常影响APP数', - 'description' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-30', - ], - 'Reason' => [ - 'title' => '申请原因', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'ApiId' => [ - 'title' => 'API编号', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'Api权限字段id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '22', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'DevFieldList' => [ - 'title' => 'DEV权限字段列表，dev-prod模式下才需要填且devFieldList、prodFieldList至少填写1个', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'Api权限字段id', - 'description' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '数据服务项目Id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - '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' => '', - '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"}]', - ], - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', - ], - ], - [ - 'name' => 'CreateCommand', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => 'API信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ApiName' => [ - 'title' => 'Api的名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'API_01', - ], - 'Version' => [ - 'title' => 'api初始版本名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'V1', - ], - 'ApiType' => [ - 'title' => 'Api的类型：'."\n" - .'- 3：数据源SQL模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [], - 'example' => '3', - ], - 'Mode' => [ - 'title' => 'Api的开发模式：'."\n" - .'- 0：Basic模式 '."\n" - .'- 1：Dev-Prod模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'ProjectId' => [ - 'title' => '数据服务项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - 'ApiGroupId' => [ - 'title' => 'Api分组ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '101', - ], - 'ApiGroupName' => [ - 'title' => 'Api分组名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Description' => [ - 'title' => 'Api的描述信息', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'BizProtocol' => [ - 'title' => '协议，不同的网关类型可支持的协议不同，请查看帮助文档，枚举值：0：HTTP 1：HTTPS', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'CustomUpdateRate' => [ - 'title' => '自定义更新频率，当更新频率（update_rate）为自定义时为必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'CallMode' => [ - 'title' => 'API的调用模式，可枚举值包括（默认值为1）：'."\n" - .'1：同步调用'."\n" - .'2：异步调用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'ExecutionTimeout' => [ - 'title' => 'API执行超时时间，仅对API异步调用API生效，异步调用时必填', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'ScriptDetails' => [ - 'title' => '脚本API的详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Script' => [ - 'title' => 'sql脚本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'select a,b,c from table1 where d = ${d}', - ], - 'IsPaginated' => [ - 'title' => '结果是否分页，仅当RequestType模式为List时才需要（默认为false）', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'SqlMode' => [ - 'title' => 'SQL模式，枚举值：'."\n" - .'1：基础模式'."\n" - .'2：高级模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'SortPriority' => [ - 'title' => '排序的优先级，仅SQL模式为基础模式时生效（默认值2），枚举值：'."\n" - .'1：SQL脚本 '."\n" - .'2：OrderByList请求参数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'DatasourceType' => [ - 'title' => '基于的数据源或数据服务单元的类型，枚举值：'."\n" - .'0：数据服务单元 '."\n" - .'1：数据源', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'DatasourceID' => [ - 'title' => '数据源的ID，API模式为直连数据源时必填', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '6668888888888812345L', - ], - 'ScriptRequestParameters' => [ - 'title' => '脚本 API 的请求参数列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'title' => '参数名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd', - ], - 'ParameterDescription' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'ParameterValueType' => [ - 'title' => '参数值的类型：'."\n" - .'1-单值：固定值，用于=、>=、<=、>、<、!=、between等操作符 '."\n" - .'2-多值：输入参数为多值，用逗号“,”分隔。用于In、Not In操作符', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '=', - ], - 'ParameterDataType' => [ - 'title' => '数据类型 "STRING", "DOUBLE", "INT", "DATE", "LONG", "FLOAT", "BOOLEAN", "SHORT", "BYTE", "BIGDECIMAL", "BINARY", "ARRAY", "Array(int)", "Array(string)"', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'title' => '参数名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a', - ], - 'ParameterDescription' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'ParameterDataType' => [ - 'title' => '数据类型 "STRING", "DOUBLE", "INT", "DATE", "LONG", "FLOAT", "BOOLEAN", "SHORT", "BYTE", "BIGDECIMAL", "BINARY", "ARRAY", "Array(int)", "Array(string)"', - 'description' => '', - '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' => '', - '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' => '', - '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"}]', - ], - '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' => '', - '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' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'API详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'API的id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Name' => [ - 'title' => 'API名称', - 'description' => '', - 'type' => 'string', - 'example' => 'exampleApi', - ], - 'GroupId' => [ - 'title' => 'API分组id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '67890', - ], - 'GroupName' => [ - 'title' => 'API分组名', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'SELECT * FROM example_table', - ], - 'RequestParamList' => [ - 'title' => '-', - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'title' => '请求参数响应DTO', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '主键ID', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'DatasourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ds12345', - ], - 'DatasourceName' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'exampleDatasource', - ], - 'DatasourceType' => [ - 'title' => '数据源类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DatasourceUrl' => [ - 'title' => '数据源URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/datasource', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'example_table', - ], - ], - ], - ], - 'ParameterLocation' => [ - 'title' => '注册API-请求参数位置｜返回参数取值路径', - 'description' => '', - 'type' => 'string', - 'example' => '/path/to/param', - ], - 'DefaultValue' => [ - 'title' => '注册API-默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'default_value', - ], - ], - ], - ], - 'ResponseParamList' => [ - 'title' => '-', - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'title' => '响应参数响应DTO', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '主键ID', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'DatasourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ds67890', - ], - 'DatasourceName' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'responseDatasource', - ], - 'DatasourceType' => [ - 'title' => '数据源类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'DatasourceUrl' => [ - 'title' => '数据源URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/response_datasource', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'response_table', - ], - ], - ], - ], - 'ParameterLocation' => [ - 'title' => '注册API-请求参数位置｜返回参数取值路径', - 'description' => '', - 'type' => 'string', - 'example' => '/path/to/response_param', - ], - 'DefaultValue' => [ - 'title' => '注册API-默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'default_response_value', - ], - ], - ], - ], - 'PublicParamList' => [ - 'title' => '-', - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'title' => '公共参数响应DTO', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '主键ID', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'DatasourceId' => [ - 'title' => '数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ds54321', - ], - 'DatasourceName' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'publicDatasource', - ], - 'DatasourceType' => [ - 'title' => '数据源类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'DatasourceUrl' => [ - 'title' => '数据源URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/public_datasource', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'public_table', - ], - ], - ], - ], - 'ParameterLocation' => [ - 'title' => '注册API-请求参数位置｜返回参数取值路径', - 'description' => '', - 'type' => 'string', - 'example' => '/path/to/public_param', - ], - 'DefaultValue' => [ - 'title' => '注册API-默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'default_public_value', - ], - ], - ], - ], - 'SpecialSql' => [ - 'title' => '特殊SQL标志', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CreateType' => [ - 'title' => '创建类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ApiNo' => [ - 'title' => 'API编号', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '54321', - ], - 'DirectDatasourceName' => [ - 'title' => '直连API的数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'directDatasource', - ], - 'ApiTimeout' => [ - 'title' => 'API超时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'MaxReturnNum' => [ - 'title' => '最大返回条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjId' => [ - 'title' => '服务项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '112233', - ], - 'ProjName' => [ - 'title' => '服务项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'exampleProject', - ], - 'AppName' => [ - 'title' => '我的应用', - 'description' => '', - 'type' => 'string', - 'example' => 'exampleApp', - ], - 'RsGrpId' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'example' => 'grp12345', - ], - 'ResourceGroupName' => [ - 'title' => '资源组名称', - 'description' => '', - 'type' => 'string', - 'example' => 'exampleResourceGroup', - ], - 'CacheSwitch' => [ - 'title' => 'API缓存开关', - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'title' => 'data_api主键', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '67890', - ], - 'ModelType' => [ - 'title' => '模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HttpMethod' => [ - 'title' => '注册API请求方式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DatasourceId' => [ - 'title' => 'API数据源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'ds67890', - ], - 'DatasourceName' => [ - 'title' => 'API数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'registerDatasource', - ], - 'Url' => [ - 'title' => 'API数据源URL地址', - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.com/register_api', - ], - 'AuthenticationMode' => [ - 'title' => 'API数据源认证方式', - 'description' => '', - 'type' => 'string', - 'example' => 'OAuth2', - ], - 'Protocol' => [ - 'title' => 'API数据源请求协议', - 'description' => '', - 'type' => 'string', - 'example' => 'HTTPS', - ], - 'Path' => [ - 'title' => '服务path', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'v1.0', - ], - 'IsPagedQuery' => [ - 'title' => '是否是分页查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetDevObjectDependency', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetDevObjectDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'ResumePhysicalNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:ResumePhysicalNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'ListUserGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListUserGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListUserGroupMembers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListUserGroupMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - 'ListAuthorizedDataServiceApiDetails' => [ - 'summary' => '查询应用已申请的API的具体的字段列表', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateStreamBatchJobMapping', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateStreamBatchJobMapping', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteBizEntity', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteBizUnit', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateBatchTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineBizEntity', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:OnlineBizEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckProjectHasDependency', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:CheckProjectHasDependency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteManualNode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:ExecuteManualNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataSourceBasicInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateDataSourceBasicInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteUserGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataphin:DeleteUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetBatchTaskVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetBatchTaskVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetPhysicalNodeContent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetPhysicalNodeContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDirectory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreateDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListPublishRecords', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', + 'ramAction' => [ + 'action' => 'dataphin:ListPublishRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OpTenantId', - 'in' => 'query', - 'schema' => [ - 'title' => '租户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30001011', + [ + 'apiName' => 'GetOperationSubmitStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetOperationSubmitStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页显示的条数，最大100条', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - ], - ], - 'required' => true, + ], + [ + 'apiName' => 'GetMyRoles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetMyRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求标识ID，一次请求的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '75DD06F8-1661-5A6E-B0A6-7E23133BDC60', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP 状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '请求错误码，OK表示请求正常', - 'description' => '', - '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' => '', - 'type' => 'array', - 'items' => [ - 'title' => '授权的API详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'title' => 'API_ID', - 'description' => 'API_ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'ApiName' => [ - 'title' => 'API名称', - 'description' => '', - 'type' => 'string', - 'example' => 'GetData', - ], - 'AppId' => [ - 'title' => '应用 ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'ProjectId' => [ - 'title' => '数据服务项目ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Description' => [ - 'title' => 'API描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'Description1', - ], - 'DevAuthPeriod' => [ - 'title' => '开发环境API权限有效期', - 'description' => '', - 'type' => 'string', - 'example' => '2035-12-31', - ], - 'ProdAuthPeriod' => [ - 'title' => '生产环境API权限有效期', - 'description' => '', - 'type' => 'string', - 'example' => '2035-12-31', - ], - 'AuthType' => [ - 'title' => '权限类型', - 'description' => '', - 'type' => 'string', - 'example' => '使用权限', - ], - 'AuthorizedDevReturnParameters' => [ - 'title' => 'API开发环境授权的字段列表', - 'description' => '', - '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' => [ - '', - '', - ], - ], - ], - ], - ], - 'AuthorizedProdReturnParameters' => [ - 'title' => 'API生产环境授权的字段列表', - 'description' => '', - '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' => [ - '', - '', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetAdHocFile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'DataphinOpenAPIRamUnAuthorized', - 'errorMessage' => 'You are not authorized to do this action, you should be authorized by RAM.', + [ + 'apiName' => 'GetAdHocTaskResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataphin:GetAdHocTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'DataphinOpenApiForbidden', - 'errorMessage' => 'Openapi request is forbidden, may tenantId invalid.', + ], + [ + 'apiName' => 'CreatePipelineNode', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataphin:CreatePipelineNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 406 => [ - [ - 'errorCode' => 'DataphinOpenApiNotAcceptable', - 'errorMessage' => 'Request not acceptable, may exceed quota limit.', + ], + [ + 'apiName' => 'UpdateBizUnit', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataphin:UpdateBizUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveUserGroupMember', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:RemoveUserGroupMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListTenantMembers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataphin:ListTenantMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dataphin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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"}]', - ], - ], - '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', ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3